/* * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright ownership. * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License.
*/ package org.apache.catalina.ha.tcp;
/** * A <b>Cluster </b> implementation using simple multicast. Responsible for setting up a cluster and provides callers * with a valid multicast receiver/sender. FIXME wrote testcases * * @author Remy Maucherat * @author Peter Rossbach
*/ publicclass SimpleTcpCluster extends LifecycleMBeanBase implements CatalinaCluster, MembershipListener, ChannelListener {
/** * Return heartbeat enable flag (default false) * * @return the heartbeatBackgroundEnabled
*/ publicboolean isHeartbeatBackgroundEnabled() { return heartbeatBackgroundEnabled;
}
/** * enabled that container backgroundThread call heartbeat at channel * * @param heartbeatBackgroundEnabled the heartbeatBackgroundEnabled to set
*/ publicvoid setHeartbeatBackgroundEnabled(boolean heartbeatBackgroundEnabled) { this.heartbeatBackgroundEnabled = heartbeatBackgroundEnabled;
}
/** * Set the name of the cluster to join, if no cluster with this name is present create one. * * @param clusterName The clustername to join
*/
@Override publicvoid setClusterName(String clusterName) { this.clusterName = clusterName;
}
/** * Return the name of the cluster that this Server is currently configured to operate within. * * @return The name of the cluster associated with this server
*/
@Override public String getClusterName() { if (clusterName == null && container != null) { return container.getName();
} return clusterName;
}
/** * Set the Container associated with our Cluster * * @param container The Container to use
*/
@Override publicvoid setContainer(Container container) {
Container oldContainer = this.container; this.container = container;
support.firePropertyChange("container", oldContainer, this.container);
}
/** * Get the Container associated with our Cluster * * @return The Container associated with our Cluster
*/
@Override public Container getContainer() { returnthis.container;
}
/** * Add cluster valve Cluster Valves are only add to container when cluster is started! * * @param valve The new cluster Valve.
*/
@Override publicvoid addValve(Valve valve) { if (valve instanceof ClusterValve && (!valves.contains(valve))) {
valves.add(valve);
}
}
/** * get all cluster valves * * @return current cluster valves
*/
@Override public Valve[] getValves() { return valves.toArray(new Valve[0]);
}
/** * Get the cluster listeners associated with this cluster. If this Array has no listeners registered, a zero-length * array is returned. * * @return the listener array
*/ public ClusterListener[] findClusterListeners() { return clusterListeners.toArray(new ClusterListener[0]);
}
/** * Add cluster message listener and register cluster to this listener. * * @param listener The new listener * * @see org.apache.catalina.ha.CatalinaCluster#addClusterListener(org.apache.catalina.ha.ClusterListener)
*/
@Override publicvoid addClusterListener(ClusterListener listener) { if (listener != null && !clusterListeners.contains(listener)) {
clusterListeners.add(listener);
listener.setCluster(this);
}
}
/** * Remove message listener and deregister Cluster from listener. * * @param listener The listener to remove * * @see org.apache.catalina.ha.CatalinaCluster#removeClusterListener(org.apache.catalina.ha.ClusterListener)
*/
@Override publicvoid removeClusterListener(ClusterListener listener) { if (listener != null) {
clusterListeners.remove(listener);
listener.setCluster(null);
}
}
/** * @return the current Deployer
*/
@Override public ClusterDeployer getClusterDeployer() { return clusterDeployer;
}
/** * set a new Deployer, must be set before cluster started! * * @param clusterDeployer The associated deployer
*/
@Override publicvoid setClusterDeployer(ClusterDeployer clusterDeployer) { this.clusterDeployer = clusterDeployer;
}
/** * Get all current cluster members * * @return all members or empty array
*/
@Override public Member[] getMembers() { return channel.getMembers();
}
/** * Return the member that represents this node. * * @return Member
*/
@Override public Member getLocalMember() { return channel.getLocalMember(true);
}
// --------------------------------------------------------- Public Methods
/** * @return Returns the managers.
*/
@Override public Map<String,ClusterManager> getManagers() { return managers;
}
@Override public Channel getChannel() { return channel;
}
public ClusterManager getManagerTemplate() { return managerTemplate;
}
/** * returns the SendOptions as a comma separated list of names for use by JMX * * @return a comma separated list of the option names
*/ public String getChannelSendOptionsName() { return Channel.getSendOptionsAsString(channelSendOptions);
}
/** * Create new Manager without add to cluster (comes with start the manager) * * @param name Context Name of this manager * * @see org.apache.catalina.Cluster#createManager(String) * @see DeltaManager#start()
*/
@Override publicsynchronized Manager createManager(String name) { if (log.isDebugEnabled()) {
log.debug("Creating ClusterManager for context " + name + " using class " +
getManagerTemplate().getClass().getName());
}
ClusterManager manager = null; try {
manager = managerTemplate.cloneFromTemplate();
manager.setName(name);
} catch (Exception x) {
log.error(sm.getString("simpleTcpCluster.clustermanager.cloneFailed"), x);
manager = new DeltaManager();
} finally { if (manager != null) {
manager.setCluster(this);
}
} return manager;
}
/** * Execute a periodic task, such as reloading, etc. This method will be invoked inside the classloading context of * this container. Unexpected throwables will be caught and logged. * * @see org.apache.catalina.ha.deploy.FarmWarDeployer#backgroundProcess() * @see org.apache.catalina.tribes.group.GroupChannel#heartbeat()
*/
@Override publicvoid backgroundProcess() { if (clusterDeployer != null) {
clusterDeployer.backgroundProcess();
}
// send a heartbeat through the channel if (isHeartbeatBackgroundEnabled() && channel != null) {
channel.heartbeat();
}
// ------------------------------------------------------ public
@Override protectedvoid initInternal() throws LifecycleException { super.initInternal(); if (clusterDeployer != null) {
StringBuilder name = new StringBuilder("type=Cluster");
Container container = getContainer(); if (container != null) {
name.append(container.getMBeanKeyProperties());
}
name.append(",component=Deployer");
onameClusterDeployer = register(clusterDeployer, name.toString());
}
}
/** * Start Cluster and implement the requirements of {@link org.apache.catalina.util.LifecycleBase#startInternal()}. * * @exception LifecycleException if this component detects a fatal error that prevents this component from being * used
*/
@Override protectedvoid startInternal() throws LifecycleException {
if (log.isInfoEnabled()) {
log.info(sm.getString("simpleTcpCluster.start"));
}
protectedvoid checkDefaults() { if (clusterListeners.size() == 0 && managerTemplate instanceof DeltaManager) {
addClusterListener(new ClusterSessionListener());
} if (valves.size() == 0) {
addValve(new JvmRouteBinderValve());
addValve(new ReplicationValve());
} if (clusterDeployer != null) {
clusterDeployer.setCluster(this);
} if (channel == null) {
channel = new GroupChannel();
} if (channel instanceof GroupChannel && !((GroupChannel) channel).getInterceptors().hasNext()) {
channel.addInterceptor(new MessageDispatchInterceptor());
channel.addInterceptor(new TcpFailureDetector());
} if (heartbeatBackgroundEnabled) {
channel.setHeartbeat(false);
}
}
/** * register all cluster valve to host or engine
*/ protectedvoid registerClusterValve() { if (container != null) { for (Valve v : valves) {
ClusterValve valve = (ClusterValve) v; if (log.isDebugEnabled()) {
log.debug("Invoking addValve on " + getContainer() + " with class=" + valve.getClass().getName());
} if (valve != null) {
container.getPipeline().addValve(valve);
valve.setCluster(this);
}
}
}
}
/** * unregister all cluster valve to host or engine
*/ protectedvoid unregisterClusterValve() { for (Valve v : valves) {
ClusterValve valve = (ClusterValve) v; if (log.isDebugEnabled()) {
log.debug("Invoking removeValve on " + getContainer() + " with class=" + valve.getClass().getName());
} if (valve != null) {
container.getPipeline().removeValve(valve);
valve.setCluster(null);
}
}
}
/** * Stop Cluster and implement the requirements of {@link org.apache.catalina.util.LifecycleBase#stopInternal()}. * * @exception LifecycleException if this component detects a fatal error that prevents this component from being * used
*/
@Override protectedvoid stopInternal() throws LifecycleException {
/** * Return a String rendering of this object.
*/
@Override public String toString() { return ToStringUtil.toString(this);
}
/** * send message to all cluster members * * @param msg message to transfer * * @see org.apache.catalina.ha.CatalinaCluster#send(org.apache.catalina.ha.ClusterMessage)
*/
@Override publicvoid send(ClusterMessage msg) {
send(msg, null);
}
/** * send a cluster message to one member * * @param msg message to transfer * @param dest Receiver member * * @see org.apache.catalina.ha.CatalinaCluster#send(org.apache.catalina.ha.ClusterMessage, * org.apache.catalina.tribes.Member)
*/
@Override publicvoid send(ClusterMessage msg, Member dest) {
send(msg, dest, this.channelSendOptions);
}
@Override publicvoid send(ClusterMessage msg, Member dest, int sendOptions) { try {
msg.setAddress(getLocalMember()); if (dest != null) { if (!getLocalMember().equals(dest)) {
channel.send(new Member[] { dest }, msg, sendOptions);
} else {
log.error(sm.getString("simpleTcpCluster.unableSend.localMember", msg));
}
} else {
Member[] destmembers = channel.getMembers(); if (destmembers.length > 0) {
channel.send(destmembers, msg, sendOptions);
} elseif (log.isDebugEnabled()) {
log.debug("No members in cluster, ignoring message:" + msg);
}
}
} catch (Exception x) {
log.error(sm.getString("simpleTcpCluster.sendFailed"), x);
}
}
/** * New cluster member is registered * * @see org.apache.catalina.tribes.MembershipListener#memberAdded(org.apache.catalina.tribes.Member)
*/
@Override publicvoid memberAdded(Member member) { try {
hasMembers = channel.hasMembers(); if (log.isInfoEnabled()) {
log.info(sm.getString("simpleTcpCluster.member.added", member));
} // Notify our interested LifecycleListeners
fireLifecycleEvent(BEFORE_MEMBERREGISTER_EVENT, member);
/** * notify all listeners from receiving a new message is not ClusterMessage emit Failure Event to LifecycleListener * * @param msg received Message
*/
@Override publicboolean accept(Serializable msg, Member sender) { return (msg instanceof ClusterMessage);
}
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:
Die farbliche Syntaxdarstellung ist noch experimentell.