Package org.apache.axis2.clustering.tribes

Class TribesClusteringAgent

java.lang.Object

org.apache.axis2.clustering.tribes.TribesClusteringAgent

All Implemented Interfaces:

org.apache.axis2.clustering.ClusteringAgent, org.apache.axis2.description.ParameterInclude

public class TribesClusteringAgent
extends Object
implements org.apache.axis2.clustering.ClusteringAgent

The main ClusteringAgent class for the Tribes based clustering implementation

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_SUB_DOMAIN

Constructor Summary

Constructors

Constructor	Description
TribesClusteringAgent()

Method Summary

Modifier and Type	Method	Description
void	addGroupManagementAgent(org.apache.axis2.clustering.management.GroupManagementAgent agent, String applicationDomain)
void	addGroupManagementAgent(org.apache.axis2.clustering.management.GroupManagementAgent agent, String applicationDomain, String applicationSubDomain)
void	addParameter(org.apache.axis2.description.Parameter param)
void	deserializeParameters(org.apache.axiom.om.OMElement parameterElement)
void	finalize()
int	getAliveMemberCount()
Set<String>	getDomains()
org.apache.axis2.clustering.management.GroupManagementAgent	getGroupManagementAgent(String applicationDomain)
org.apache.axis2.clustering.management.GroupManagementAgent	getGroupManagementAgent(String applicationDomain, String applicationSubDomain)
List<org.apache.axis2.clustering.Member>	getMembers()
org.apache.axis2.clustering.management.NodeManager	getNodeManager()
org.apache.axis2.description.Parameter	getParameter(String name)
ArrayList	getParameters()
org.apache.axis2.clustering.state.StateManager	getStateManager()
void	init()	Initialize the cluster.
boolean	isCoordinator()
boolean	isParameterLocked(String parameterName)
void	removeParameter(org.apache.axis2.description.Parameter param)
List<org.apache.axis2.clustering.ClusteringCommand>	sendMessage(org.apache.axis2.clustering.ClusteringMessage message, boolean isRpcMessage)
void	setConfigurationContext(org.apache.axis2.context.ConfigurationContext configurationContext)
void	setMembers(List<org.apache.axis2.clustering.Member> members)
void	setNodeManager(org.apache.axis2.clustering.management.NodeManager nodeManager)
void	setStateManager(org.apache.axis2.clustering.state.StateManager stateManager)
void	shutdown()	Shutdown the cluster.
boolean	synchronizeAllMembers()	Method to check whether all members in the cluster have to be kept in sync at all times.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_SUB_DOMAIN

public static final String DEFAULT_SUB_DOMAIN

See Also:

Constant Field Values

Constructor Detail

TribesClusteringAgent

public TribesClusteringAgent()

Method Detail

setMembers

public void setMembers(List<org.apache.axis2.clustering.Member> members)

Specified by:

setMembers in interface org.apache.axis2.clustering.ClusteringAgent

getMembers

public List<org.apache.axis2.clustering.Member> getMembers()

Specified by:

getMembers in interface org.apache.axis2.clustering.ClusteringAgent

getAliveMemberCount

public int getAliveMemberCount()

Specified by:

getAliveMemberCount in interface org.apache.axis2.clustering.ClusteringAgent

addGroupManagementAgent

public void addGroupManagementAgent(org.apache.axis2.clustering.management.GroupManagementAgent agent,
                                    String applicationDomain)

Specified by:

addGroupManagementAgent in interface org.apache.axis2.clustering.ClusteringAgent

addGroupManagementAgent

public void addGroupManagementAgent(org.apache.axis2.clustering.management.GroupManagementAgent agent,
                                    String applicationDomain,
                                    String applicationSubDomain)

Specified by:

addGroupManagementAgent in interface org.apache.axis2.clustering.ClusteringAgent

getGroupManagementAgent

public org.apache.axis2.clustering.management.GroupManagementAgent getGroupManagementAgent(String applicationDomain)

Specified by:

getGroupManagementAgent in interface org.apache.axis2.clustering.ClusteringAgent

getGroupManagementAgent

public org.apache.axis2.clustering.management.GroupManagementAgent getGroupManagementAgent(String applicationDomain,
                                                                                           String applicationSubDomain)

Specified by:

getGroupManagementAgent in interface org.apache.axis2.clustering.ClusteringAgent

getDomains

public Set<String> getDomains()

Specified by:

getDomains in interface org.apache.axis2.clustering.ClusteringAgent

getStateManager

public org.apache.axis2.clustering.state.StateManager getStateManager()

Specified by:

getStateManager in interface org.apache.axis2.clustering.ClusteringAgent

getNodeManager

public org.apache.axis2.clustering.management.NodeManager getNodeManager()

Specified by:

getNodeManager in interface org.apache.axis2.clustering.ClusteringAgent

isCoordinator

public boolean isCoordinator()

Specified by:

isCoordinator in interface org.apache.axis2.clustering.ClusteringAgent

init

public void init()
          throws org.apache.axis2.clustering.ClusteringFault

Initialize the cluster.

Specified by:

init in interface org.apache.axis2.clustering.ClusteringAgent

Throws:

org.apache.axis2.clustering.ClusteringFault - If initialization fails

finalize

public void finalize()

Specified by:

finalize in interface org.apache.axis2.clustering.ClusteringAgent

Overrides:

finalize in class Object

sendMessage

public List<org.apache.axis2.clustering.ClusteringCommand> sendMessage(org.apache.axis2.clustering.ClusteringMessage message,
                                                                       boolean isRpcMessage)
                                                                throws org.apache.axis2.clustering.ClusteringFault

Specified by:

sendMessage in interface org.apache.axis2.clustering.ClusteringAgent

Throws:

org.apache.axis2.clustering.ClusteringFault

setNodeManager

public void setNodeManager(org.apache.axis2.clustering.management.NodeManager nodeManager)

Specified by:

setNodeManager in interface org.apache.axis2.clustering.ClusteringAgent

setStateManager

public void setStateManager(org.apache.axis2.clustering.state.StateManager stateManager)

Specified by:

setStateManager in interface org.apache.axis2.clustering.ClusteringAgent

addParameter

public void addParameter(org.apache.axis2.description.Parameter param)
                  throws org.apache.axis2.AxisFault

Specified by:

addParameter in interface org.apache.axis2.description.ParameterInclude

Throws:

org.apache.axis2.AxisFault

deserializeParameters

public void deserializeParameters(org.apache.axiom.om.OMElement parameterElement)
                           throws org.apache.axis2.AxisFault

Specified by:

deserializeParameters in interface org.apache.axis2.description.ParameterInclude

Throws:

org.apache.axis2.AxisFault

getParameter

public org.apache.axis2.description.Parameter getParameter(String name)

Specified by:

getParameter in interface org.apache.axis2.description.ParameterInclude

getParameters

public ArrayList getParameters()

Specified by:

getParameters in interface org.apache.axis2.description.ParameterInclude

isParameterLocked

public boolean isParameterLocked(String parameterName)

Specified by:

isParameterLocked in interface org.apache.axis2.description.ParameterInclude

removeParameter

public void removeParameter(org.apache.axis2.description.Parameter param)
                     throws org.apache.axis2.AxisFault

Specified by:

removeParameter in interface org.apache.axis2.description.ParameterInclude

Throws:

org.apache.axis2.AxisFault

shutdown

public void shutdown()
              throws org.apache.axis2.clustering.ClusteringFault

Shutdown the cluster. This member will leave the cluster when this method is called.

Specified by:

shutdown in interface org.apache.axis2.clustering.ClusteringAgent

Throws:

org.apache.axis2.clustering.ClusteringFault - If an error occurs while shutting down

setConfigurationContext

public void setConfigurationContext(org.apache.axis2.context.ConfigurationContext configurationContext)

Specified by:

setConfigurationContext in interface org.apache.axis2.clustering.ClusteringAgent

synchronizeAllMembers

public boolean synchronizeAllMembers()

Method to check whether all members in the cluster have to be kept in sync at all times. Typically, this will require each member in the cluster to ACKnowledge receipt of a particular message, which may have a significant performance hit.

Returns:

true - if all members in the cluster should be kept in sync at all times, false otherwise