org.apache.catalina.ha

Interface CatalinaCluster

public interface CatalinaCluster extends Cluster

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

Version: $Revision: 467222 $, $Date: 2006-10-24 05:17:11 +0200 (Tue, 24 Oct 2006) $

Author: Filip Hanik

Field Summary
Stringinfo
Descriptive information about this component implementation.
Method Summary
voidaddClusterListener(ClusterListener listener)
voidaddValve(Valve valve)
ChannelgetChannel()
ClusterDeployergetClusterDeployer()
MembergetLocalMember()
Return the member that represents this node.
LoggetLogger()
Returns the associates logger with this cluster.
ManagergetManager(String name)
StringgetManagerName(String name, Manager manager)
MapgetManagers()
Member[]getMembers()
Returns all the members currently participating in the cluster.
Valve[]getValves()
booleanhasMembers()
Returns that cluster has members.
voidremoveClusterListener(ClusterListener listener)
voidsend(ClusterMessage msg)
Sends a message to all the members in the cluster
voidsend(ClusterMessage msg, Member dest)
Sends a message to a specific member in the cluster.
voidsendClusterDomain(ClusterMessage msg)
Sends a message to a all members at local cluster domain
voidsetChannel(Channel channel)
voidsetClusterDeployer(ClusterDeployer deployer)
voidstart()
Start the cluster, the owning container will invoke this
voidstop()
Stops the cluster, the owning container will invoke this

Field Detail

info

public String info
Descriptive information about this component implementation.

Method Detail

addClusterListener

public void addClusterListener(ClusterListener listener)

addValve

public void addValve(Valve valve)

getChannel

public Channel getChannel()

getClusterDeployer

public ClusterDeployer getClusterDeployer()

getLocalMember

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

Returns: Member

getLogger

public Log getLogger()
Returns the associates logger with this cluster.

Returns: Log

getManager

public Manager getManager(String name)

getManagerName

public String getManagerName(String name, Manager manager)

getManagers

public Map getManagers()

Returns: The map of managers

getMembers

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

Returns: Member[]

getValves

public Valve[] getValves()

hasMembers

public boolean hasMembers()
Returns that cluster has members.

removeClusterListener

public void removeClusterListener(ClusterListener listener)

send

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

Parameters: msg ClusterMessage

send

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

Parameters: msg ClusterMessage dest Member

sendClusterDomain

public void sendClusterDomain(ClusterMessage msg)
Sends a message to a all members at local cluster domain

Parameters: msg ClusterMessage

setChannel

public void setChannel(Channel channel)

setClusterDeployer

public void setClusterDeployer(ClusterDeployer deployer)

start

public void start()
Start the cluster, the owning container will invoke this

Throws: Exception - if failure to start cluster

stop

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

Throws: LifecycleException

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