org.jboss.ha.jmx
Interface HAServiceMBean

All Superinterfaces:

javax.management.NotificationBroadcaster, org.jboss.system.Service, org.jboss.system.ServiceMBean

All Known Subinterfaces:

HASingletonControllerMBean, HASingletonMBean

All Known Implementing Classes:

HAServiceMBeanSupport, HASingletonController, HASingletonSupport

public interface HAServiceMBean
extends org.jboss.system.ServiceMBean, javax.management.NotificationBroadcaster

HA-Service interface. Defines common functionality for partition symmetric (farming) services.

Version:

$Revision: 1.2.8.2 $

Author:

Ivelin Ivanov

Field Summary

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

void	callMethodOnPartition(String methodName, Object[] args) Convenience method for broadcasting a call to all members of a partition.
ClusterPartitionMBean	getClusterPartition() Get the underlying partition used by this service.
Serializable	getDistributedState(String key) Convenience method for sharing state across a cluster partition.
String	getPartitionName() Name of the underlying partition that determine the cluster to use.
void	sendNotification(javax.management.Notification notification) Broadcast the notification to the remote listener nodes (if any) and then invoke super.sendNotification() to notify local listeners.
void	setClusterPartition(ClusterPartitionMBean clusterPartition) Sets the underlying partition used by this service.
void	setDistributedState(String key, Serializable value) Convenience method for sharing state across a cluster partition.
void	setPartitionName(String partitionName) Set the name of the underlying partition that determine the cluster to use.

Methods inherited from interface org.jboss.system.ServiceMBean

getName, getState, getStateString, jbossInternalLifecycle

Methods inherited from interface org.jboss.system.Service

create, destroy, start, stop

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Method Detail

getPartitionName

String getPartitionName()

Name of the underlying partition that determine the cluster to use.

setPartitionName

void setPartitionName(String partitionName)

Set the name of the underlying partition that determine the cluster to use. Can be set only when the MBean is not in a STARTED or STARTING state.

getClusterPartition

ClusterPartitionMBean getClusterPartition()

Get the underlying partition used by this service.

Returns:

the partition

setClusterPartition

void setClusterPartition(ClusterPartitionMBean clusterPartition)

Sets the underlying partition used by this service. Can be set only when the MBean is not in a STARTED or STARTING state.

Parameters:

clusterPartition - the partition

callMethodOnPartition

void callMethodOnPartition(String methodName,
                           Object[] args)
                           throws Exception

Convenience method for broadcasting a call to all members of a partition.

Parameters:

methodName -

args -

Throws:

Exception

getDistributedState

Serializable getDistributedState(String key)

Convenience method for sharing state across a cluster partition. Delegates to the DistributedStateService

Parameters:

key - key for the distributed object

Returns:

Serializable the distributed object

setDistributedState

void setDistributedState(String key,
                         Serializable value)
                         throws Exception

Convenience method for sharing state across a cluster partition. Delegates to the DistributedStateService

Parameters:

key - key for the distributed object

value - the distributed object

Throws:

Exception

sendNotification

void sendNotification(javax.management.Notification notification)

Broadcast the notification to the remote listener nodes (if any) and then invoke super.sendNotification() to notify local listeners.

Parameters:

notification - sent out to local listeners and other nodes. It should be serializable. It is recommended that the source of the notification is an ObjectName of an MBean that is is available on all nodes where the broadcaster MBean is registered.

See Also:

NotificationBroadcasterSupport.sendNotification(Notification)