Package com.opencloud.rhino.management.resource

Interface ResourceUsageMBean

All Superinterfaces:

ResourceUsageMBean

public interface ResourceUsageMBean
extends ResourceUsageMBean

Rhino extensions to SLEE Resource Usage MBeans.

To simplify matters, Rhino only emits Usage Notifications on Usage MBeans representing cluster-wide usage state, created using the ResourceUsageMBean.getUsageMBean() or getUsageMBean(String) methods. Usage MBeans created using the getUsageMBean(int) or getUsageMBean(String, int) methods, representing usage state on a single node, will not emit any usage notifications.

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAMESPACE_KEY	The JMX Object Name property key that identifies the namespace that the Resource Usage MBean belongs to.

Fields inherited from interface javax.slee.management.ResourceUsageMBean

BASE_OBJECT_NAME, RESOURCE_ADAPTOR_ENTITY_NAME_KEY

Method Summary

Modifier and Type	Method	Description
ObjectName	getUsageMBean(int nodeID)	Get the JMX Object Name of a UsageMBean object that provides management access to the unnamed usage parameter set on the specified node for the resource adaptor entity that this MBean is providing usage management access for.
ObjectName	getUsageMBean(String paramSetName)
ObjectName	getUsageMBean(String paramSetName, int nodeID)	Get the JMX Object Name of a UsageMBean object that provides management access to the named usage parameter set on the specified node for the resource adaptor entity that this MBean is providing usage management access for.
ObjectName	getUsageNotificationManagerMBean(String upiType)	Get the JMX Object Name of a UsageNotificationManagerMBean that provides management access to the usage notification manager for the specified usage parameters interface type for the resource adaptor entity that this MBean is providing usage management access for.
String[]	getUsageParametersInterfaceTypes()	Get the names of the usage parameters interface types that resource adaptor of the resource adaptor entity that this MBean is providing usage management access for has declared.

Methods inherited from interface javax.slee.management.ResourceUsageMBean

close, createUsageParameterSet, getEntityName, getUsageMBean, getUsageNotificationManagerMBean, getUsageParameterSets, removeUsageParameterSet, resetAllUsageParameters

Field Detail

NAMESPACE_KEY

static final String NAMESPACE_KEY

The JMX Object Name property key that identifies the namespace that the Resource Usage MBean belongs to. This key is equal to the string "namespace". This key is only present in the Object Name if the Resource Usage MBean resides in a user-defined namespace, rather than the default namespace. The value of this key, if present, is the quoted name of the namespace.

Since:

Rhino 2.5.0

See Also:

Constant Field Values

Method Detail

getUsageMBean

ObjectName getUsageMBean(int nodeID)
                  throws ManagementException

Get the JMX Object Name of a UsageMBean object that provides management access to the unnamed usage parameter set on the specified node for the resource adaptor entity that this MBean is providing usage management access for.

The Usage MBean referenced by the Object Name returned by this method will operate only on the usage state stored by the specified node, in contrast to the Usage MBean referenced by ResourceUsageMBean.getUsageMBean() which will operate on and/or aggregate usage state from the entire cluster.

The Usage MBean referenced by the Object Name does not emit usage notifications. Usage notifications are only emitted by the Usage MBean referenced by ResourceUsageMBean.getUsageMBean().

Parameters:

nodeID - the node ID of the node whose usage state should be accessed by the Usage MBean.

Returns:

the Object Name of a UsageMBean object for the unnamed usage parameter set for the resource adaptor entity.

Throws:

ManagementException - if the Object Name could not be obtained due to a system-level failure.

getUsageMBean

ObjectName getUsageMBean(String paramSetName,
                         int nodeID)
                  throws NullPointerException,
                         UnrecognizedUsageParameterSetNameException,
                         ManagementException

Get the JMX Object Name of a UsageMBean object that provides management access to the named usage parameter set on the specified node for the resource adaptor entity that this MBean is providing usage management access for.

The Usage MBean referenced by the Object Name returned by this method will operate only on the usage state stored by the specified node, in contrast to the Usage MBean referenced by getUsageMBean(String) which will operate on and/or aggregate usage state from the entire cluster.

The Usage MBean referenced by the Object Name does not emit usage notifications. Usage notifications are only emitted by the Usage MBean referenced by getUsageMBean(String).

Parameters:

paramSetName - the name of the usage parameter set. The name must be one of the names returned by ResourceUsageMBean.getUsageParameterSets().

nodeID - the node ID of the node whose usage state should be accessed by the Usage MBean.

Returns:

the Object Name of a UsageMBean object for the named usage parameter set for the resource adaptor entity.

Throws:

NullPointerException - if paramSetName is null.

UnrecognizedUsageParameterSetNameException - if the named usage parameter set has not been created for the resource adaptor entity.

ManagementException - if the Object Name could not be obtained due to a system-level failure.

getUsageMBean

ObjectName getUsageMBean(String paramSetName)
                  throws NullPointerException,
                         UnrecognizedUsageParameterSetNameException,
                         ManagementException

Specified by:

getUsageMBean in interface ResourceUsageMBean

Throws:

NullPointerException

UnrecognizedUsageParameterSetNameException

ManagementException

getUsageParametersInterfaceTypes

String[] getUsageParametersInterfaceTypes()
                                   throws ManagementException

Get the names of the usage parameters interface types that resource adaptor of the resource adaptor entity that this MBean is providing usage management access for has declared. This method only returns a non zero-length result if the resource adaptor has declared usage parameter interfaces using the Rhino extension mechanism.

Returns:

the names of the usage parameters interface types that the resource adaptor has declared.

Throws:

ManagementException - if the names could not be obtained due to a system-level failure.

Since:

Rhino 2.4.0

getUsageNotificationManagerMBean

ObjectName getUsageNotificationManagerMBean(String upiType)
                                     throws UnrecognizedUsageParametersInterfaceTypeException,
                                            ManagementException

Get the JMX Object Name of a UsageNotificationManagerMBean that provides management access to the usage notification manager for the specified usage parameters interface type for the resource adaptor entity that this MBean is providing usage management access for.

Parameters:

upiType - the the usage parameters interface type. This type must be one of the type names returned by getUsageParametersInterfaceTypes.

Throws:

UnrecognizedUsageParametersInterfaceTypeException - if the named usage parameters interface type does not exist for the resource adaptor entity.

ManagementException - if the Object Name could not be obtained due to a system-level failure.

Since:

Rhino 2.4.0