FileDocCategorySizeDatePackage
HAServiceMBean.javaAPI DocJBoss 4.2.13954Fri Jul 13 20:52:38 BST 2007org.jboss.ha.jmx

HAServiceMBean

public interface HAServiceMBean implements NotificationBroadcaster, org.jboss.system.ServiceMBean

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

author
Ivelin Ivanov
version
$Revision: 57188 $

Fields Summary
Constructors Summary
Methods Summary
public voidcallMethodOnPartition(java.lang.String methodName, java.lang.Object[] args)
Convenience method for broadcasting a call to all members of a partition.

param
methodName
param
args
throws
Exception

public org.jboss.ha.framework.server.ClusterPartitionMBeangetClusterPartition()
Get the underlying partition used by this service.

return
the partition

public java.io.SerializablegetDistributedState(java.lang.String key)
Convenience method for sharing state across a cluster partition. Delegates to the DistributedStateService

param
key key for the distributed object
return
Serializable the distributed object

public java.lang.StringgetPartitionName()
Name of the underlying partition that determine the cluster to use.

deprecate
use {@link #getClusterPartition()}

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

param
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
javax.management.NotificationBroadcasterSupport#sendNotification(Notification)

public voidsetClusterPartition(org.jboss.ha.framework.server.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.

param
clusterPartition the partition

public voidsetDistributedState(java.lang.String key, java.io.Serializable value)
Convenience method for sharing state across a cluster partition. Delegates to the DistributedStateService

param
key key for the distributed object
param
value the distributed object

public voidsetPartitionName(java.lang.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.

deprecate
use {@link #setClusterPartition()}