com.tangosol.net.management

Interface MBeanServerProxy

public interface MBeanServerProxy

MBeanServerProxy allows any cluster node that runs the Management service to obtain and set attributes or invoke methods on registered MBeans.

Application logic can use MBeanServerProxy as follows:

   Cluster          cluster  = CacheFactory.ensureCluster();
   Registry         registry = cluster.getManagement();
   MBeanServerProxy proxy    = registry.getMBeanServerProxy();
   String           sName    = registry.ensureGlobalName(
      "type=PartitionAssignment,service=partitioned,responsibility=DistributionCoordinator");

   String sStatusHA = (String) proxy.getAttribute(sName, "HAStatus");
 

Since:

Coherence 12.2.1

Author:

bbc 2014.09.24

Method Summary

Modifier and Type	Method and Description
Object	getAttribute(String sName, String sAttr) Obtain the value of the specified MBean attribute.
Object	invoke(String sName, String sOpName, Object[] aoParams, String[] asSignature) Invoke an operation on the specified MBean.
boolean	isMBeanRegistered(String sName) Check whether or not an MBean with the specified name is already registered.
Set<String>	queryNames(String sPattern, Filter<ObjectName> filter) Get the names of MBeans controlled by the MBean server that is collocated with the cluster registry.
void	setAttribute(String sName, String sAttr, Object oValue) Set the value of the specified MBean attribute.

Method Detail

getAttribute

Object getAttribute(String sName,
                    String sAttr)

Obtain the value of the specified MBean attribute.

Parameters:

sName - the MBean name

sAttr - the attribute name

Returns:

the value of the retrieved attribute

setAttribute

void setAttribute(String sName,
                  String sAttr,
                  Object oValue)

Set the value of the specified MBean attribute.

Parameters:

sName - the MBean name

sAttr - the attribute name

oValue - the attribute value

invoke

Object invoke(String sName,
              String sOpName,
              Object[] aoParams,
              String[] asSignature)

Invoke an operation on the specified MBean.

Parameters:

sName - the MBean name to invoke the method on

sOpName - the name of the method to be invoked

aoParams - an array containing the method parameters

asSignature - an optional array containing the method signatures, this parameter is only necessary if there are multiple methods with the same name

Returns:

the result of invocation

queryNames

Set<String> queryNames(String sPattern,
                       Filter<ObjectName> filter)

Get the names of MBeans controlled by the MBean server that is collocated with the cluster registry.

Parameters:

sPattern - the MBean name pattern identifying MBean names to be retrieved; this pattern is the same as in the MBeanServer.queryNames method; if null, the name of all registered MBeans will be retrieved

filter - (optional) the filter to be applied for selecting MBeans

Returns:

a set of MBean names matching the pattern and the filter

isMBeanRegistered

boolean isMBeanRegistered(String sName)

Check whether or not an MBean with the specified name is already registered.

Parameters:

sName - the MBean name

Returns:

true iff the specified name is already registered