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: 1.2 $, $Date: 2002/12/05 12:22:15 $
Author:
Bip Thelin, Remy Maucherat

Method Summary
 Manager createManager(java.lang.String name)
          Create a new manager which will use this cluster to replicate its sessions.
 java.lang.String getClusterName()
          Return the name of the cluster that this Server is currently configured to operate within.
 Container getContainer()
          Get the Container associated with our Cluster
 int getDebug()
          Returns the debug level for this Cluster
 java.lang.String getInfo()
          Return descriptive information about this Cluster implementation and the corresponding version number, in the format <description>/<version>.
 java.lang.String getProtocol()
          Get the protocol used by the cluster.
 void setClusterName(java.lang.String clusterName)
          Set the name of the cluster to join, if no cluster with this name is present create one.
 void setContainer(Container container)
          Set the Container associated with our Cluster
 void setDebug(int debug)
          The debug detail level for this Cluster
 void setProtocol(java.lang.String protocol)
          Set the protocol parameters.
 

Method Detail

getInfo

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


getClusterName

public java.lang.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

setClusterName

public void setClusterName(java.lang.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

getContainer

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

Returns:
The Container associated with our Cluster

setDebug

public void setDebug(int debug)
The debug detail level for this Cluster

Parameters:
debug - The debug level

getDebug

public int getDebug()
Returns the debug level for this Cluster

Returns:
The debug level

setProtocol

public void setProtocol(java.lang.String protocol)
Set the protocol parameters.

Parameters:
protocol - The protocol used by the cluster

getProtocol

public java.lang.String getProtocol()
Get the protocol used by the cluster.

Returns:
The protocol

createManager

public Manager createManager(java.lang.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


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