org.apache.catalina.cluster
Interface CatalinaCluster

All Superinterfaces:
Cluster, ListenCallback
All Known Implementing Classes:
SimpleTcpCluster

public interface CatalinaCluster
extends Cluster, ListenCallback

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

Version:
$Revision: 1.9 $, $Date: 2004/11/11 14:47:26 $
Author:
Filip Hanik

Field Summary
static java.lang.String info
          Descriptive information about this component implementation.
 
Method Summary
 void addClusterListener(MessageListener listener)
           
 void addManager(java.lang.String name, ClusterManager manager)
           
 void addValve(Valve valve)
           
 ClusterDeployer getClusterDeployer()
           
 ClusterReceiver getClusterReceiver()
           
 ClusterSender getClusterSender()
           
 Member getLocalMember()
          Return the member that represents this node.
 org.apache.commons.logging.Log getLogger()
          Returns the associates logger with this cluster
 Manager getManager(java.lang.String name)
           
 Member[] getMembers()
          returns all the members currently participating in the cluster
 MembershipService getMembershipService()
           
 Valve getValve()
           
 void removeClusterListener(MessageListener listener)
           
 void removeManager(java.lang.String name)
           
 void send(ClusterMessage msg)
          Sends a message to all the members in the cluster
 void send(ClusterMessage msg, Member dest)
          Sends a message to a specific member in the cluster
 void setClusterDeployer(ClusterDeployer deployer)
           
 void setClusterReceiver(ClusterReceiver receiver)
           
 void setClusterSender(ClusterSender sender)
           
 void setMembershipService(MembershipService service)
           
 void start()
          Start the cluster, the owning container will invoke this
 void stop()
          Stops the cluster, the owning container will invoke this
 
Methods inherited from interface org.apache.catalina.Cluster
backgroundProcess, createManager, getClusterName, getContainer, getInfo, getProtocol, installContext, setClusterName, setContainer, setProtocol, startContext, stop
 
Methods inherited from interface org.apache.catalina.cluster.io.ListenCallback
messageDataReceived
 

Field Detail

info

public static final java.lang.String info
Descriptive information about this component implementation.

See Also:
Constant Field Values
Method Detail

start

public 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

public void stop()
          throws LifecycleException
Stops the cluster, the owning container will invoke this

Throws:
LifecycleException

getLogger

public org.apache.commons.logging.Log getLogger()
Returns the associates logger with this cluster

Returns:
Log

send

public void send(ClusterMessage msg)
Sends a message to all the members in the cluster

Parameters:
msg - SessionMessage

send

public void send(ClusterMessage msg,
                 Member dest)
Sends a message to a specific member in the cluster

Parameters:
msg - SessionMessage
dest - Member

getMembers

public Member[] getMembers()
returns all the members currently participating in the cluster

Returns:
Member[]

getLocalMember

public Member getLocalMember()
Return the member that represents this node.

Returns:
Member

setClusterSender

public void setClusterSender(ClusterSender sender)

getClusterSender

public ClusterSender getClusterSender()

setClusterReceiver

public void setClusterReceiver(ClusterReceiver receiver)

getClusterReceiver

public ClusterReceiver getClusterReceiver()

setMembershipService

public void setMembershipService(MembershipService service)

getMembershipService

public MembershipService getMembershipService()

addValve

public void addValve(Valve valve)

addClusterListener

public void addClusterListener(MessageListener listener)

removeClusterListener

public void removeClusterListener(MessageListener listener)

setClusterDeployer

public void setClusterDeployer(ClusterDeployer deployer)

getClusterDeployer

public ClusterDeployer getClusterDeployer()

getManager

public Manager getManager(java.lang.String name)

removeManager

public void removeManager(java.lang.String name)

addManager

public void addManager(java.lang.String name,
                       ClusterManager manager)

getValve

public Valve getValve()


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