org.jboss.ha.framework.server
Interface ClusterPartitionMBean

All Superinterfaces:

org.jboss.system.Service, org.jboss.system.ServiceMBean

All Known Implementing Classes:

ClusterPartition

public interface ClusterPartitionMBean
extends org.jboss.system.ServiceMBean

Management Bean for Cluster HAPartitions. It will start a JGroups channel and initialize the ReplicantManager and DistributedStateService.

Version:

$Revision: 1.19.2.2 $

Revisions:

Author:

Bill Burke., Sacha Labourey.

Field Summary

static javax.management.ObjectName

OBJECT_NAME

Fields inherited from interface org.jboss.system.ServiceMBean

CREATE_EVENT, CREATED, DESTROY_EVENT, DESTROYED, FAILED, REGISTERED, START_EVENT, STARTED, STARTING, states, STOP_EVENT, STOPPED, STOPPING, UNREGISTERED

Method Summary

boolean	getAllowSynchronousMembershipNotifications() Returns whether this partition will synchronously notify any HAPartition.HAMembershipListener of membership changes using the calling thread from the underlying group communications layer (e.g.
Vector	getCurrentView() Return the list of member nodes that built from the current view
boolean	getDeadlockDetection() Determine if deadlock detection is enabled
HAPartition	getHAPartition() Access to the underlying HAPartition without going through JNDI
String	getJGroupsVersion() The version of JGroups this is running on
long	getMethodCallTimeout() Max time (in ms) to wait for synchronous group method calls (HAPartition.callMethodOnCluster(String, String, Object[], Class[], boolean))
InetAddress	getNodeAddress() The node address used to generate the node name
String	getNodeName() Uniquely identifies this node.
String	getPartitionName() Name of the partition being built.
String	getPartitionProperties() Get JGroups property string a la JDBC see JGroups web site for more information
long	getStateTransferTimeout()
void	setAllowSynchronousMembershipNotifications(boolean allowSync) Sets whether this partition will synchronously notify any HAPartition.HAMembershipListener of membership changes using the calling thread from the underlying group communications layer (e.g.
void	setDeadlockDetection(boolean doit)
void	setMethodCallTimeout(long timeout)
void	setNodeAddress(InetAddress address)
void	setNodeName(String node)
void	setPartitionConfig(Element config) A write-only attribute that allows for an xml specification of the PartitionProperties string.
void	setPartitionName(String newName)
void	setPartitionProperties(String newProps)
void	setStateTransferTimeout(long timeout)
String	showHistory()
String	showHistoryAsXML()
void	startChannelDebugger()
void	startChannelDebugger(boolean accumulative)
void	stopChannelDebugger()

Methods inherited from interface org.jboss.system.ServiceMBean

getName, getState, getStateString, jbossInternalLifecycle

Methods inherited from interface org.jboss.system.Service

create, destroy, start, stop

Field Detail

OBJECT_NAME

static final javax.management.ObjectName OBJECT_NAME

Method Detail

getPartitionName

String getPartitionName()

Name of the partition being built. All nodes/services belonging to a partition with the same name are clustered together.

setPartitionName

void setPartitionName(String newName)

getPartitionProperties

String getPartitionProperties()

Get JGroups property string a la JDBC see JGroups web site for more information

setPartitionProperties

void setPartitionProperties(String newProps)

setPartitionConfig

void setPartitionConfig(Element config)

A write-only attribute that allows for an xml specification of the PartitionProperties string. For example, a string like: UDP(mcast_addr=228.1.2.3):PING(timeout=2000):MERGE2(min_interval=5000;max_interval=10000):FD" would be specified in xml as:

getNodeName

String getNodeName()

Uniquely identifies this node. MUST be unique accros the whole cluster! Cannot be changed once the partition has been started (otherwise an exception is thrown)

setNodeName

void setNodeName(String node)
                 throws Exception

Throws:

Exception

getNodeAddress

InetAddress getNodeAddress()

The node address used to generate the node name

setNodeAddress

void setNodeAddress(InetAddress address)

getJGroupsVersion

String getJGroupsVersion()

The version of JGroups this is running on

getStateTransferTimeout

long getStateTransferTimeout()

setStateTransferTimeout

void setStateTransferTimeout(long timeout)

getMethodCallTimeout

long getMethodCallTimeout()

Max time (in ms) to wait for synchronous group method calls (HAPartition.callMethodOnCluster(String, String, Object[], Class[], boolean))

setMethodCallTimeout

void setMethodCallTimeout(long timeout)

getDeadlockDetection

boolean getDeadlockDetection()

Determine if deadlock detection is enabled

setDeadlockDetection

void setDeadlockDetection(boolean doit)

getAllowSynchronousMembershipNotifications

boolean getAllowSynchronousMembershipNotifications()

Returns whether this partition will synchronously notify any HAPartition.HAMembershipListener of membership changes using the calling thread from the underlying group communications layer (e.g. JGroups).

Returns:

true if registered listeners that don't implement AsynchHAMembershipExtendedListener or AsynchHAMembershipListener will be notified synchronously of membership changes; false if those listeners will be notified asynchronously. Default is false.

setAllowSynchronousMembershipNotifications

void setAllowSynchronousMembershipNotifications(boolean allowSync)

Sets whether this partition will synchronously notify any HAPartition.HAMembershipListener of membership changes using the calling thread from the underlying group communications layer (e.g. JGroups).

Parameters:

allowSync - true if registered listeners that don't implement AsynchHAMembershipExtendedListener or AsynchHAMembershipListener should be notified synchronously of membership changes; false if those listeners can be notified asynchronously. Default is false.

getHAPartition

HAPartition getHAPartition()

Access to the underlying HAPartition without going through JNDI

Returns:

the HAPartition for the cluster service

getCurrentView

Vector getCurrentView()

Return the list of member nodes that built from the current view

Returns:

A Vector Strings representing the host:port values of the nodes

showHistory

String showHistory()

showHistoryAsXML

String showHistoryAsXML()

startChannelDebugger

void startChannelDebugger()

startChannelDebugger

void startChannelDebugger(boolean accumulative)

stopChannelDebugger

void stopChannelDebugger()