org.apache.catalina

Interface Cluster

public interface Cluster

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.

Version: $Revision: 500684 $, $Date: 2007-01-28 00:27:18 +0100 (Sun, 28 Jan 2007) $

Author: Bip Thelin Remy Maucherat Filip Hanik

Method Summary
voidbackgroundProcess()
Execute a periodic task, such as reloading, etc.
ManagercreateManager(String name)
Create a new manager which will use this cluster to replicate its sessions.
StringgetClusterName()
Return the name of the cluster that this Server is currently configured to operate within.
ContainergetContainer()
Get the Container associated with our Cluster
StringgetInfo()
Return descriptive information about this Cluster implementation and the corresponding version number, in the format <description>/<version>.
StringgetProtocol()
Get the protocol used by the cluster.
voidregisterManager(Manager manager)
Register a manager with the cluster.
voidremoveManager(Manager manager)
Removes a manager from the cluster
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 Cluster
voidsetProtocol(String protocol)
Set the protocol parameters.

Method Detail

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.

createManager

public Manager createManager(String name)
Create a new manager which will use this cluster to replicate its sessions.

Parameters: name Name (key) of the application with which the manager is associated

getClusterName

public String getClusterName()
Return the name of the cluster that this Server is currently configured to operate within.

Returns: The name of the cluster associated with this server

getContainer

public Container getContainer()
Get the Container associated with our Cluster

Returns: The Container associated with our Cluster

getInfo

public String getInfo()
Return descriptive information about this Cluster implementation and the corresponding version number, in the format <description>/<version>.

getProtocol

public String getProtocol()

Deprecated:

Get the protocol used by the cluster.

Returns: The protocol

registerManager

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.

Parameters: manager Manager

removeManager

public void removeManager(Manager manager)
Removes a manager from the cluster

Parameters: manager Manager

setClusterName

public void setClusterName(String clusterName)
Set the name of the cluster to join, if no cluster with this name is present create one.

Parameters: clusterName The clustername to join

setContainer

public void setContainer(Container container)
Set the Container associated with our Cluster

Parameters: container The Container to use

setProtocol

public void setProtocol(String protocol)

Deprecated:

Set the protocol parameters.

Parameters: protocol The protocol used by the cluster

Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.