Package org.apache.catalina.ha.tcp
Class SimpleTcpCluster
- java.lang.Object
-
- org.apache.catalina.util.LifecycleBase
-
- org.apache.catalina.util.LifecycleMBeanBase
-
- org.apache.catalina.ha.tcp.SimpleTcpCluster
-
- All Implemented Interfaces:
MBeanRegistration,Cluster,Contained,CatalinaCluster,JmxEnabled,Lifecycle,ChannelListener,MembershipListener
public class SimpleTcpCluster extends LifecycleMBeanBase implements CatalinaCluster, MembershipListener, ChannelListener
A Cluster 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, Peter Rossbach
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.catalina.Lifecycle
Lifecycle.SingleUse
-
-
Field Summary
Fields Modifier and Type Field Description static StringAFTER_MANAGERREGISTER_EVENTstatic StringAFTER_MANAGERUNREGISTER_EVENTstatic StringAFTER_MEMBERREGISTER_EVENTstatic StringAFTER_MEMBERUNREGISTER_EVENTstatic StringBEFORE_MANAGERREGISTER_EVENTstatic StringBEFORE_MANAGERUNREGISTER_EVENTstatic StringBEFORE_MEMBERREGISTER_EVENTstatic StringBEFORE_MEMBERUNREGISTER_EVENTprotected ChannelchannelGroup channel.protected List<ClusterListener>clusterListenersListeners of messagesprotected StringclusterNameThe cluster name to joinprotected ContainercontainerThe Container associated with this Cluster.protected booleanhasMembershas membersprotected booleanheartbeatBackgroundEnabledcall Channel.heartbeat() at container background threadstatic Loglogprotected Map<String,ClusterManager>managersThe context name <-> manager association for distributed contexts.protected ClusterManagermanagerTemplatestatic StringRECEIVE_MESSAGE_FAILURE_EVENTstatic StringSEND_MESSAGE_FAILURE_EVENTprotected static StringManagersmThe string manager for this package.protected PropertyChangeSupportsupportThe property change support for this component.-
Fields inherited from interface org.apache.catalina.Lifecycle
AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT
-
-
Constructor Summary
Constructors Constructor Description SimpleTcpCluster()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanaccept(Serializable msg, Member sender)notify all listeners from receiving a new message is not ClusterMessage emit Failure Event to LifecycleListenervoidaddClusterListener(ClusterListener listener)Add cluster message listener and register cluster to this listener.voidaddValve(Valve valve)Add cluster valve Cluster Valves are only add to container when cluster is started!voidbackgroundProcess()Execute a periodic task, such as reloading, etc.protected voidcheckDefaults()ManagercreateManager(String name)Create new Manager without add to cluster (comes with start the manager)protected voiddestroyInternal()Sub-classes wishing to perform additional clean-up should override this method, ensuring that super.destroyInternal() is the last call in the overriding method.ClusterListener[]findClusterListeners()Get the cluster listeners associated with this cluster.ChannelgetChannel()intgetChannelSendOptions()StringgetChannelSendOptionsName()returns the SendOptions as a comma separated list of names for use by JMXintgetChannelStartOptions()ClusterDeployergetClusterDeployer()StringgetClusterName()Return the name of the cluster that this Server is currently configured to operate within.ContainergetContainer()Get the Container associated with our Clusterprotected StringgetDomainInternal()Method implemented by sub-classes to identify the domain in which MBeans should be registered.MembergetLocalMember()Return the member that represents this node.ManagergetManager(String name)Get ManagerStringgetManagerName(String name, Manager manager)Get a new cluster name for a manager.Map<String,ClusterManager>getManagers()ClusterManagergetManagerTemplate()Member[]getMembers()Get all current cluster membersprotected StringgetObjectNameKeyProperties()Allow sub-classes to specify the key properties component of theObjectNamethat will be used to register this component.Valve[]getValves()get all cluster valvesbooleanhasMembers()protected voidinitInternal()Sub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.booleanisHeartbeatBackgroundEnabled()Return heartbeat enable flag (default false)booleanisNotifyLifecycleListenerOnFailure()voidmemberAdded(Member member)New cluster member is registeredvoidmemberDisappeared(Member member)Cluster member is gonevoidmessageReceived(Serializable message, Member sender)Receive a message from the channelvoidmessageReceived(ClusterMessage message)protected voidregisterClusterValve()register all cluster valve to host or enginevoidregisterManager(Manager manager)Register a manager with the cluster.voidremoveClusterListener(ClusterListener listener)Remove message listener and deregister Cluster from listener.voidremoveManager(Manager manager)Remove an application from cluster replication bus.voidsend(ClusterMessage msg)send message to all cluster membersvoidsend(ClusterMessage msg, Member dest)send a cluster message to one membervoidsend(ClusterMessage msg, Member dest, int sendOptions)Sends a message with the specified sendOptions to a specific member in the cluster.voidsetChannel(Channel channel)voidsetChannelSendOptions(int channelSendOptions)voidsetChannelSendOptions(String channelSendOptions)voidsetChannelStartOptions(int channelStartOptions)voidsetClusterDeployer(ClusterDeployer clusterDeployer)set a new Deployer, must be set before cluster started!voidsetClusterName(String clusterName)Set the name of the cluster to join, if no cluster with this name is present create one.voidsetContainer(Container container)Set the Container associated with our ClustervoidsetHeartbeatBackgroundEnabled(boolean heartbeatBackgroundEnabled)enabled that container backgroundThread call heartbeat at channelvoidsetManagerTemplate(ClusterManager managerTemplate)voidsetNotifyLifecycleListenerOnFailure(boolean notifyListenerOnFailure)protected voidstartInternal()Start Cluster and implement the requirements ofLifecycleBase.startInternal().protected voidstopInternal()Stop Cluster and implement the requirements ofLifecycleBase.stopInternal().StringtoString()Return a String rendering of this object.protected voidunregisterClusterValve()unregister all cluster valve to host or engine-
Methods inherited from class org.apache.catalina.util.LifecycleMBeanBase
getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister, unregister
-
Methods inherited from class org.apache.catalina.util.LifecycleBase
addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stop
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.catalina.tribes.ChannelListener
equals, hashCode
-
-
-
-
Field Detail
-
log
public static final Log log
-
BEFORE_MEMBERREGISTER_EVENT
public static final String BEFORE_MEMBERREGISTER_EVENT
- See Also:
- Constant Field Values
-
AFTER_MEMBERREGISTER_EVENT
public static final String AFTER_MEMBERREGISTER_EVENT
- See Also:
- Constant Field Values
-
BEFORE_MANAGERREGISTER_EVENT
public static final String BEFORE_MANAGERREGISTER_EVENT
- See Also:
- Constant Field Values
-
AFTER_MANAGERREGISTER_EVENT
public static final String AFTER_MANAGERREGISTER_EVENT
- See Also:
- Constant Field Values
-
BEFORE_MANAGERUNREGISTER_EVENT
public static final String BEFORE_MANAGERUNREGISTER_EVENT
- See Also:
- Constant Field Values
-
AFTER_MANAGERUNREGISTER_EVENT
public static final String AFTER_MANAGERUNREGISTER_EVENT
- See Also:
- Constant Field Values
-
BEFORE_MEMBERUNREGISTER_EVENT
public static final String BEFORE_MEMBERUNREGISTER_EVENT
- See Also:
- Constant Field Values
-
AFTER_MEMBERUNREGISTER_EVENT
public static final String AFTER_MEMBERUNREGISTER_EVENT
- See Also:
- Constant Field Values
-
SEND_MESSAGE_FAILURE_EVENT
public static final String SEND_MESSAGE_FAILURE_EVENT
- See Also:
- Constant Field Values
-
RECEIVE_MESSAGE_FAILURE_EVENT
public static final String RECEIVE_MESSAGE_FAILURE_EVENT
- See Also:
- Constant Field Values
-
channel
protected Channel channel
Group channel.
-
sm
protected static final StringManager sm
The string manager for this package.
-
clusterName
protected String clusterName
The cluster name to join
-
heartbeatBackgroundEnabled
protected boolean heartbeatBackgroundEnabled
call Channel.heartbeat() at container background thread- See Also:
GroupChannel.heartbeat()
-
container
protected Container container
The Container associated with this Cluster.
-
support
protected final PropertyChangeSupport support
The property change support for this component.
-
managers
protected final Map<String,ClusterManager> managers
The context name <-> manager association for distributed contexts.
-
managerTemplate
protected ClusterManager managerTemplate
-
clusterListeners
protected final List<ClusterListener> clusterListeners
Listeners of messages
-
hasMembers
protected boolean hasMembers
has members
-
-
Method Detail
-
isHeartbeatBackgroundEnabled
public boolean isHeartbeatBackgroundEnabled()
Return heartbeat enable flag (default false)- Returns:
- the heartbeatBackgroundEnabled
-
setHeartbeatBackgroundEnabled
public void setHeartbeatBackgroundEnabled(boolean heartbeatBackgroundEnabled)
enabled that container backgroundThread call heartbeat at channel- Parameters:
heartbeatBackgroundEnabled- the heartbeatBackgroundEnabled to set
-
setClusterName
public void setClusterName(String clusterName)
Set the name of the cluster to join, if no cluster with this name is present create one.- Specified by:
setClusterNamein interfaceCluster- Parameters:
clusterName- The clustername to join
-
getClusterName
public String getClusterName()
Return the name of the cluster that this Server is currently configured to operate within.- Specified by:
getClusterNamein interfaceCluster- Returns:
- The name of the cluster associated with this server
-
setContainer
public void setContainer(Container container)
Set the Container associated with our Cluster- Specified by:
setContainerin interfaceContained- Parameters:
container- The Container to use
-
getContainer
public Container getContainer()
Get the Container associated with our Cluster- Specified by:
getContainerin interfaceContained- Returns:
- The Container associated with our Cluster
-
isNotifyLifecycleListenerOnFailure
public boolean isNotifyLifecycleListenerOnFailure()
- Returns:
- Returns the notifyLifecycleListenerOnFailure.
-
setNotifyLifecycleListenerOnFailure
public void setNotifyLifecycleListenerOnFailure(boolean notifyListenerOnFailure)
- Parameters:
notifyListenerOnFailure- The notifyLifecycleListenerOnFailure to set.
-
addValve
public void addValve(Valve valve)
Add cluster valve Cluster Valves are only add to container when cluster is started!- Specified by:
addValvein interfaceCatalinaCluster- Parameters:
valve- The new cluster Valve.
-
getValves
public Valve[] getValves()
get all cluster valves- Specified by:
getValvesin interfaceCatalinaCluster- Returns:
- current cluster valves
-
findClusterListeners
public ClusterListener[] findClusterListeners()
Get the cluster listeners associated with this cluster. If this Array has no listeners registered, a zero-length array is returned.- Returns:
- the listener array
-
addClusterListener
public void addClusterListener(ClusterListener listener)
Add cluster message listener and register cluster to this listener.- Specified by:
addClusterListenerin interfaceCatalinaCluster- Parameters:
listener- The new listener- See Also:
CatalinaCluster.addClusterListener(org.apache.catalina.ha.ClusterListener)
-
removeClusterListener
public void removeClusterListener(ClusterListener listener)
Remove message listener and deregister Cluster from listener.- Specified by:
removeClusterListenerin interfaceCatalinaCluster- Parameters:
listener- The listener to remove- See Also:
CatalinaCluster.removeClusterListener(org.apache.catalina.ha.ClusterListener)
-
getClusterDeployer
public ClusterDeployer getClusterDeployer()
- Specified by:
getClusterDeployerin interfaceCatalinaCluster- Returns:
- the current Deployer
-
setClusterDeployer
public void setClusterDeployer(ClusterDeployer clusterDeployer)
set a new Deployer, must be set before cluster started!- Specified by:
setClusterDeployerin interfaceCatalinaCluster- Parameters:
clusterDeployer- The associated deployer
-
setChannel
public void setChannel(Channel channel)
- Specified by:
setChannelin interfaceCatalinaCluster
-
setManagerTemplate
public void setManagerTemplate(ClusterManager managerTemplate)
-
setChannelSendOptions
public void setChannelSendOptions(int channelSendOptions)
-
setChannelSendOptions
public void setChannelSendOptions(String channelSendOptions)
-
hasMembers
public boolean hasMembers()
- Specified by:
hasMembersin interfaceCatalinaCluster- Returns:
trueif the cluster has members.
-
getMembers
public Member[] getMembers()
Get all current cluster members- Specified by:
getMembersin interfaceCatalinaCluster- Returns:
- all members or empty array
-
getLocalMember
public Member getLocalMember()
Return the member that represents this node.- Specified by:
getLocalMemberin interfaceCatalinaCluster- Returns:
- Member
-
getManagers
public Map<String,ClusterManager> getManagers()
- Specified by:
getManagersin interfaceCatalinaCluster- Returns:
- Returns the managers.
-
getChannel
public Channel getChannel()
- Specified by:
getChannelin interfaceCatalinaCluster
-
getManagerTemplate
public ClusterManager getManagerTemplate()
-
getChannelSendOptions
public int getChannelSendOptions()
-
getChannelSendOptionsName
public String getChannelSendOptionsName()
returns the SendOptions as a comma separated list of names for use by JMX- Returns:
- a comma separated list of the option names
-
createManager
public Manager createManager(String name)
Create new Manager without add to cluster (comes with start the manager)- Specified by:
createManagerin interfaceCluster- Parameters:
name- Context Name of this manager- Returns:
- The newly created Manager instance
- See Also:
Cluster.createManager(java.lang.String),LifecycleBase.start()
-
registerManager
public void registerManager(Manager manager)
Description copied from interface:ClusterRegister a manager with the cluster. If the cluster is not responsible for creating a manager, then the container will at least notify the cluster that this manager is participating in the cluster.- Specified by:
registerManagerin interfaceCluster- Parameters:
manager- Manager
-
removeManager
public void removeManager(Manager manager)
Remove an application from cluster replication bus.- Specified by:
removeManagerin interfaceCluster- Parameters:
manager- The manager- See Also:
Cluster.removeManager(Manager)
-
getManagerName
public String getManagerName(String name, Manager manager)
Description copied from interface:CatalinaClusterGet a new cluster name for a manager.- Specified by:
getManagerNamein interfaceCatalinaCluster- Parameters:
name- Override name (optional)manager- The manager- Returns:
- the manager name in the cluster
-
getManager
public Manager getManager(String name)
Description copied from interface:CatalinaClusterGet Manager- Specified by:
getManagerin interfaceCatalinaCluster- Parameters:
name- The manager name- Returns:
- The manager
-
backgroundProcess
public void backgroundProcess()
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.- Specified by:
backgroundProcessin interfaceCluster- See Also:
FarmWarDeployer.backgroundProcess(),GroupChannel.heartbeat()
-
initInternal
protected void initInternal() throws LifecycleExceptionDescription copied from class:LifecycleMBeanBaseSub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.- Overrides:
initInternalin classLifecycleMBeanBase- Throws:
LifecycleException- If the initialisation fails
-
startInternal
protected void startInternal() throws LifecycleExceptionStart Cluster and implement the requirements ofLifecycleBase.startInternal().- Specified by:
startInternalin classLifecycleBase- Throws:
LifecycleException- if this component detects a fatal error that prevents this component from being used
-
checkDefaults
protected void checkDefaults()
-
registerClusterValve
protected void registerClusterValve()
register all cluster valve to host or engine
-
unregisterClusterValve
protected void unregisterClusterValve()
unregister all cluster valve to host or engine
-
stopInternal
protected void stopInternal() throws LifecycleExceptionStop Cluster and implement the requirements ofLifecycleBase.stopInternal().- Specified by:
stopInternalin classLifecycleBase- Throws:
LifecycleException- if this component detects a fatal error that prevents this component from being used
-
destroyInternal
protected void destroyInternal() throws LifecycleExceptionDescription copied from class:LifecycleMBeanBaseSub-classes wishing to perform additional clean-up should override this method, ensuring that super.destroyInternal() is the last call in the overriding method.- Overrides:
destroyInternalin classLifecycleMBeanBase- Throws:
LifecycleException- If the destruction fails
-
toString
public String toString()
Return a String rendering of this object.
-
send
public void send(ClusterMessage msg)
send message to all cluster members- Specified by:
sendin interfaceCatalinaCluster- Parameters:
msg- message to transfer- See Also:
CatalinaCluster.send(org.apache.catalina.ha.ClusterMessage)
-
send
public void send(ClusterMessage msg, Member dest)
send a cluster message to one member- Specified by:
sendin interfaceCatalinaCluster- Parameters:
msg- message to transferdest- Receiver member- See Also:
CatalinaCluster.send(org.apache.catalina.ha.ClusterMessage, org.apache.catalina.tribes.Member)
-
send
public void send(ClusterMessage msg, Member dest, int sendOptions)
Description copied from interface:CatalinaClusterSends a message with the specified sendOptions to a specific member in the cluster.- Specified by:
sendin interfaceCatalinaCluster- Parameters:
msg- ClusterMessagedest- MembersendOptions- sendOptions
-
memberAdded
public void memberAdded(Member member)
New cluster member is registered- Specified by:
memberAddedin interfaceMembershipListener- Parameters:
member- Member - the member that was added- See Also:
MembershipListener.memberAdded(org.apache.catalina.tribes.Member)
-
memberDisappeared
public void memberDisappeared(Member member)
Cluster member is gone- Specified by:
memberDisappearedin interfaceMembershipListener- Parameters:
member- Member- See Also:
MembershipListener.memberDisappeared(org.apache.catalina.tribes.Member)
-
accept
public boolean accept(Serializable msg, Member sender)
notify all listeners from receiving a new message is not ClusterMessage emit Failure Event to LifecycleListener- Specified by:
acceptin interfaceChannelListener- Parameters:
msg- received Messagesender- Member- Returns:
- boolean
-
messageReceived
public void messageReceived(Serializable message, Member sender)
Description copied from interface:ChannelListenerReceive a message from the channel- Specified by:
messageReceivedin interfaceChannelListener- Parameters:
message- Serializablesender- - the source of the message
-
messageReceived
public void messageReceived(ClusterMessage message)
-
getChannelStartOptions
public int getChannelStartOptions()
-
setChannelStartOptions
public void setChannelStartOptions(int channelStartOptions)
-
getDomainInternal
protected String getDomainInternal()
Description copied from class:LifecycleMBeanBaseMethod implemented by sub-classes to identify the domain in which MBeans should be registered.- Specified by:
getDomainInternalin classLifecycleMBeanBase- Returns:
- The name of the domain to use to register MBeans.
-
getObjectNameKeyProperties
protected String getObjectNameKeyProperties()
Description copied from class:LifecycleMBeanBaseAllow sub-classes to specify the key properties component of theObjectNamethat will be used to register this component.- Specified by:
getObjectNameKeyPropertiesin classLifecycleMBeanBase- Returns:
- The string representation of the key properties component of the
desired
ObjectName
-
-