org.jboss.ha.framework.server
Interface ClusterPartitionMBean

All Superinterfaces:
Service, ServiceMBean
All Known Implementing Classes:
ClusterPartition

public interface ClusterPartitionMBean
extends ServiceMBean

MBean interface for ClusterPartition.

Version:
$Revision: 81751 $

Revisions:

Author:
Bill Burke., Sacha Labourey.

Field Summary
static ObjectName OBJECT_NAME
          Deprecated. not used; will be removed in AS 6
 
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.
 String getCacheConfigName()
          Gets the configuration name under which our cache is registered with the cache manager.
 String getChannelStackName()
          Gets the name of the JGroups channel protocol stack configuration provided to the channel factory.
 Vector<String> getCurrentView()
          Return the list of member nodes that built from the current view
 boolean getDeadlockDetection()
          Deprecated. will be removed in AS 6
 org.jboss.ha.framework.interfaces.DistributedReplicantManager getDistributedReplicantManager()
          Deprecated. will be removed in AS 6
 org.jboss.ha.framework.interfaces.DistributedState getDistributedStateService()
          Deprecated. will be removed in AS 6; use JBoss Cache for distributed caching
 org.jboss.ha.framework.interfaces.HAPartition getHAPartition()
          Deprecated. will be removed in AS 6
 String getJGroupsVersion()
          The version of JGroups this is running on
 long getMethodCallTimeout()
          Gets the 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 across the entire cluster.
 String getPartitionName()
          Name of the partition being built.
 long getStateTransferTimeout()
          Number of milliseconds to wait until state has been transferred, or zero to wait forever.
 String showHistory()
          Gets a listing of significant events since the instantiation of this service (e.g.
 String showHistoryAsXML()
          Gets a listing of significant events since the instantiation of this service (e.g.
 
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

@Deprecated
static final ObjectName OBJECT_NAME
Deprecated. not used; will be removed in AS 6
Not used.

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.


getNodeName

String getNodeName()
Uniquely identifies this node across the entire cluster. MUST be unique accros the whole cluster!


getNodeAddress

InetAddress getNodeAddress()
The node address used to generate the node name


getJGroupsVersion

String getJGroupsVersion()
The version of JGroups this is running on


getStateTransferTimeout

long getStateTransferTimeout()
Number of milliseconds to wait until state has been transferred, or zero to wait forever. Increase this value for large states


getMethodCallTimeout

long getMethodCallTimeout()
Gets the max time (in ms) to wait for synchronous group method calls (HAPartition.callMethodOnCluster(String, String, Object[], Class[], boolean))


getDeadlockDetection

@Deprecated
boolean getDeadlockDetection()
Deprecated. will be removed in AS 6

Deprecated; always returns false.

Returns:
false

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.

getHAPartition

@Deprecated
org.jboss.ha.framework.interfaces.HAPartition getHAPartition()
Deprecated. will be removed in AS 6

Access to the underlying HAPartition without going through JNDI

Returns:
the HAPartition for the cluster service

getDistributedReplicantManager

@Deprecated
org.jboss.ha.framework.interfaces.DistributedReplicantManager getDistributedReplicantManager()
Deprecated. will be removed in AS 6

Access to the DistributedReplicantManager implementation


getDistributedStateService

@Deprecated
org.jboss.ha.framework.interfaces.DistributedState getDistributedStateService()
Deprecated. will be removed in AS 6; use JBoss Cache for distributed caching

Access to the DistributedState implementation


getCacheConfigName

String getCacheConfigName()
Gets the configuration name under which our cache is registered with the cache manager.


getChannelStackName

String getChannelStackName()
Gets the name of the JGroups channel protocol stack configuration provided to the channel factory.


getCurrentView

Vector<String> 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()
Gets a listing of significant events since the instantiation of this service (e.g. view changes, member suspicions).

Returns:
a String with one event per line

showHistoryAsXML

String showHistoryAsXML()
Gets a listing of significant events since the instantiation of this service (e.g. view changes, member suspicions) in an XML format.

Returns:
an XML string with each historical event wrapped in an "event" element, with all surrounded by an "events" element.


Copyright © 2009 JBoss, a division of Red Hat, Inc.. All Rights Reserved.