Top Description Methods
org.apache.catalina

public Interface Cluster

extends Contained
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.
Authors
Bip Thelin, Remy Maucherat

Method Summary

Modifier and TypeMethod and Description
public void
backgroundProcess()

Execute a periodic task, such as reloading, etc. This method will be invoked inside the classloading context of this container.

public Manager

Returns:

The newly created Manager instance
createManager(String
Name (key) of the application with which the manager is associated
name)

Create a new manager which will use this cluster to replicate its sessions.

public String

Returns:

The name of the cluster associated with this server
getClusterName()

Return the name of the cluster that this Server is currently configured to operate within.

public void
registerManager(Manager
Manager
manager)

Register a manager with the cluster.

public void
removeManager(Manager
Manager
manager)

Removes a manager from the cluster

public void
setClusterName(String
The clustername to join
clusterName)

Set the name of the cluster to join, if no cluster with this name is present create one.

Inherited from org.apache.catalina.Contained:
getContainersetContainer

Method Detail

backgroundProcessback to summary
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.

createManagerback to summary
public Manager createManager(String name)

Create a new manager which will use this cluster to replicate its sessions.

Parameters
name:String

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

Returns:Manager

The newly created Manager instance

getClusterNameback to summary
public String getClusterName()

Return the name of the cluster that this Server is currently configured to operate within.

Returns:String

The name of the cluster associated with this server

registerManagerback to summary
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 manager is participating in the cluster.

Parameters
manager:Manager

Manager

removeManagerback to summary
public void removeManager(Manager manager)

Removes a manager from the cluster

Parameters
manager:Manager

Manager

setClusterNameback to summary
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:String

The clustername to join