Save This Page
Home » apache-tomcat-6.0.16-src » org.apache » catalina » [javadoc | source]
org.apache.catalina
public interface: Cluster [javadoc | source]

All Known Implementing Classes:
    SimpleTcpCluster, CatalinaCluster, CatalinaCluster, SimpleTcpCluster, MockCluster

A Cluster works as a Cluster client/server for the local host Different Cluster implementations can be used to support different ways to communicate within the Cluster. A Cluster implementation is responsible for setting up a way to communicate within the Cluster and also supply "ClientApplications" with ClusterSender used when sending information in the Cluster and ClusterInfo used for receiving information in the Cluster.
Method from org.apache.catalina.Cluster Summary:
backgroundProcess,   createManager,   getClusterName,   getContainer,   getInfo,   getProtocol,   registerManager,   removeManager,   setClusterName,   setContainer,   setProtocol
Method from org.apache.catalina.Cluster Detail:
 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.
 public Manager createManager(String name)
    Create a new manager which will use this cluster to replicate its sessions.
 public String getClusterName()
    Return the name of the cluster that this Server is currently configured to operate within.
 public Container getContainer()
    Get the Container associated with our Cluster
 public String getInfo()
    Return descriptive information about this Cluster implementation and the corresponding version number, in the format <description>/<version>.
 public String getProtocol()Deprecated! 
    Get the protocol used by the cluster.
 public  void registerManager(Manager manager)
    Register 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 mananger is participating in the cluster.
 public  void removeManager(Manager manager)
    Removes a manager from the cluster
 public  void setClusterName(String clusterName)
    Set the name of the cluster to join, if no cluster with this name is present create one.
 public  void setContainer(Container container)
    Set the Container associated with our Cluster
 public  void setProtocol(String protocol)Deprecated! 
    Set the protocol parameters.