Package org.apache.catalina.ha
Interface CatalinaCluster
- All Known Implementing Classes:
SimpleTcpCluster
A CatalinaCluster interface allows to plug in and out the different cluster implementations
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddClusterListener(ClusterListener listener) Add cluster message listener and register cluster to this listener.voidAdd cluster valve.getManager(String name) Get ManagergetManagerName(String name, Manager manager) Get a new cluster name for a manager.Member[]Valve[]booleanvoidremoveClusterListener(ClusterListener listener) Remove message listener and deregister Cluster from listener.voidsend(ClusterMessage msg) Sends a message to all the members in the clustervoidsend(ClusterMessage msg, Member dest) Sends a message to a specific member in the cluster.voidsend(ClusterMessage msg, Member dest, int sendOptions) Sends a message with the specified sendOptions to a specific member in the cluster.voidsetChannel(Channel channel) Set the channel associated with the cluster.voidsetClusterDeployer(ClusterDeployer deployer) Set a new Deployer, must be set before the cluster started.Methods inherited from interface org.apache.catalina.Cluster
backgroundProcess, createManager, getClusterName, registerManager, removeManager, setClusterNameMethods inherited from interface org.apache.catalina.Contained
getContainer, setContainer
-
Method Details
-
send
Sends a message to all the members in the cluster- Parameters:
msg- ClusterMessage
-
send
Sends a message to a specific member in the cluster.- Parameters:
msg- ClusterMessagedest- Member
-
send
Sends a message with the specified sendOptions to a specific member in the cluster.- Parameters:
msg- ClusterMessagedest- MembersendOptions- sendOptions
-
hasMembers
boolean hasMembers()- Returns:
trueif the cluster has members.
-
getMembers
Member[] getMembers()- Returns:
- an array containing all the members currently participating in the cluster.
-
getLocalMember
Member getLocalMember()- Returns:
- the member that represents this node.
-
addValve
Add cluster valve. Cluster Valves are only add to container when cluster is started.- Parameters:
valve- The new cluster Valve.
-
addClusterListener
Add cluster message listener and register cluster to this listener.- Parameters:
listener- The new listener
-
removeClusterListener
Remove message listener and deregister Cluster from listener.- Parameters:
listener- The listener to remove
-
setClusterDeployer
Set a new Deployer, must be set before the cluster started.- Parameters:
deployer- The associated deployer
-
getClusterDeployer
ClusterDeployer getClusterDeployer()- Returns:
- the current Deployer
-
getManagers
Map<String,ClusterManager> getManagers()- Returns:
- The map of managers
-
getManager
Get Manager- Parameters:
name- The manager name- Returns:
- The manager
-
getManagerName
Get a new cluster name for a manager.- Parameters:
name- Override name (optional)manager- The manager- Returns:
- the manager name in the cluster
-
getValves
Valve[] getValves()- Returns:
- the current cluster valves
-
setChannel
Set the channel associated with the cluster.- Parameters:
channel- the channel
-
getChannel
Channel getChannel()- Returns:
- the channel associated with the cluster
-