org.apache.catalina.ha
Interface CatalinaCluster

All Superinterfaces:

Cluster

All Known Implementing Classes:

SimpleTcpCluster

public interface CatalinaCluster
extends Cluster

A CatalinaCluster interface allows to plug in and out the different cluster implementations

Author:

Filip Hanik

info

static final java.lang.String info

Descriptive information about this component implementation.

See Also:

Constant Field Values

start

void start()
           throws java.lang.Exception

Start the cluster, the owning container will invoke this

Throws:

java.lang.Exception - - if failure to start cluster

stop

void stop()
          throws LifecycleException

Stops the cluster, the owning container will invoke this

Throws:

LifecycleException

getLogger

Log getLogger()

Returns the associates logger with this cluster.

Returns:

Log

send

void send(ClusterMessage msg)

Sends a message to all the members in the cluster

Parameters:

msg - ClusterMessage

send

void send(ClusterMessage msg,
          Member dest)

Sends a message to a specific member in the cluster.

Parameters:

msg - ClusterMessage

dest - Member

sendClusterDomain

void sendClusterDomain(ClusterMessage msg)

Sends a message to a all members at local cluster domain

Parameters:

msg - ClusterMessage

hasMembers

boolean hasMembers()

Returns that cluster has members.

getMembers

Member[] getMembers()

Returns all the members currently participating in the cluster.

Returns:

Member[]

getLocalMember

Member getLocalMember()

Return the member that represents this node.

Returns:

Member

addValve

void addValve(Valve valve)

addClusterListener

void addClusterListener(ClusterListener listener)

removeClusterListener

void removeClusterListener(ClusterListener listener)

setClusterDeployer

void setClusterDeployer(ClusterDeployer deployer)

getClusterDeployer

ClusterDeployer getClusterDeployer()

getManagers

java.util.Map getManagers()

Returns:

The map of managers

getManager

Manager getManager(java.lang.String name)

getManagerName

java.lang.String getManagerName(java.lang.String name,
                                Manager manager)

getValves

Valve[] getValves()

setChannel

void setChannel(Channel channel)

getChannel

Channel getChannel()