Package com.opencloud.rhino.management.service

Interface ServiceUsageMBean

All Superinterfaces:

ServiceUsageMBean

public interface ServiceUsageMBean
extends ServiceUsageMBean

Rhino extensions to SLEE Service Usage MBeans.

To simplify matters, Rhino only emits Usage Notifications on Usage MBeans representing cluster-wide usage state, created using the getSbbUsageMBean(SbbID) or getSbbUsageMBean(SbbID, String) methods. Usage MBeans created using the getSbbUsageMBean(SbbID, int) or getSbbUsageMBean(SbbID, 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 Service Usage MBean belongs to.

Fields inherited from interface javax.slee.management.ServiceUsageMBean

BASE_OBJECT_NAME, SERVICE_NAME_KEY, SERVICE_VENDOR_KEY, SERVICE_VERSION_KEY

Method Summary

Modifier and Type	Method	Description
ObjectName	getSbbUsageMBean(SbbID id)
ObjectName	getSbbUsageMBean(SbbID id, 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 specified SBB.
ObjectName	getSbbUsageMBean(SbbID id, String paramSetName)
ObjectName	getSbbUsageMBean(SbbID id, 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 specified SBB.
ObjectName	getSbbUsageNotificationManagerMBean(SbbID id)
ObjectName	getSbbUsageNotificationManagerMBean(SbbID id, String upiType)	Get the JMX Object Name of a UsageNotificationManagerMBean that provides management access to the usage notification manager for the specified usage parameter set type for the specified SBB.
String[]	getUsageParameterSets(SbbID id)
String[]	getUsageParametersInterfaceTypes(SbbID id)	Get the names of the usage parameters interface types that the specified SBB has declared.

Methods inherited from interface javax.slee.management.ServiceUsageMBean

close, createUsageParameterSet, getService, removeUsageParameterSet, resetAllUsageParameters, resetAllUsageParameters

Field Detail

NAMESPACE_KEY

static final String NAMESPACE_KEY

The JMX Object Name property key that identifies the namespace that the Service Usage MBean belongs to. This key is equal to the string "namespace". This key is only present in the Object Name if the Service 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

getSbbUsageMBean

ObjectName getSbbUsageMBean(SbbID id,
                            int nodeID)
                     throws NullPointerException,
                            UnrecognizedSbbException,
                            InvalidArgumentException,
                            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 specified SBB. The SBB must be participating in the Service that this MBean provides usage management access for, and must have defined a usage parameter interface.

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 getSbbUsageMBean(SbbID) 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 getSbbUsageMBean(SbbID).

Parameters:

id - the component identifier of the SBB. The SBB must be an SBB that is used in the Service whose usage information is being managed by this MBean.

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 SBB.

Throws:

NullPointerException - if id is null.

UnrecognizedSbbException - if id is not a recognizable SbbID for the SLEE, does not correspond with an SBB installed in the SLEE, or is not an SBB that participates in the Service whose usage information is being managed by this MBean.

InvalidArgumentException - if the identified SBB participates in this service but does not define a usage parameters interface.

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

getSbbUsageMBean

ObjectName getSbbUsageMBean(SbbID id,
                            String paramSetName,
                            int nodeID)
                     throws NullPointerException,
                            UnrecognizedSbbException,
                            InvalidArgumentException,
                            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 specified SBB. The SBB must be participating in the Service that this MBean provides usage management access for, and must have defined a usage parameters interface.

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 getSbbUsageMBean(SbbID, 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 getSbbUsageMBean(SbbID, String).

Parameters:

id - the component identifier of the SBB. The SBB must be an SBB that is used in the Service whose usage information is being managed by this MBean.

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

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 SBB.

Throws:

NullPointerException - if either parameter is null.

UnrecognizedSbbException - if id is not a recognizable SbbID for the SLEE, does not correspond with an SBB installed in the SLEE, or is not an SBB that participates in the Service whose usage information is being managed by this MBean.

InvalidArgumentException - if the identified SBB participates in this service but does not define a usage parameters interface.

UnrecognizedUsageParameterSetNameException - if the named usage parameter set has not been created for the SBB.

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

getSbbUsageMBean

ObjectName getSbbUsageMBean(SbbID id)
                     throws NullPointerException,
                            UnrecognizedSbbException,
                            InvalidArgumentException,
                            ManagementException

Specified by:

getSbbUsageMBean in interface ServiceUsageMBean

Throws:

NullPointerException

UnrecognizedSbbException

InvalidArgumentException

ManagementException

getSbbUsageMBean

ObjectName getSbbUsageMBean(SbbID id,
                            String paramSetName)
                     throws NullPointerException,
                            UnrecognizedSbbException,
                            InvalidArgumentException,
                            UnrecognizedUsageParameterSetNameException,
                            ManagementException

Specified by:

getSbbUsageMBean in interface ServiceUsageMBean

Throws:

NullPointerException

UnrecognizedSbbException

InvalidArgumentException

UnrecognizedUsageParameterSetNameException

ManagementException

getUsageParameterSets

String[] getUsageParameterSets(SbbID id)
                        throws NullPointerException,
                               UnrecognizedSbbException,
                               InvalidArgumentException,
                               ManagementException

Specified by:

getUsageParameterSets in interface ServiceUsageMBean

Throws:

NullPointerException

UnrecognizedSbbException

InvalidArgumentException

ManagementException

getUsageParametersInterfaceTypes

String[] getUsageParametersInterfaceTypes(SbbID id)
                                   throws NullPointerException,
                                          UnrecognizedSbbException,
                                          InvalidArgumentException,
                                          ManagementException

Get the names of the usage parameters interface types that the specified SBB has declared. This method only returns a non zero-length result if the SBB has declared usage parameter interfaces using the Rhino extension mechanism.

Parameters:

id - the component identifier of the SBB. The SBB must be an SBB that is used in the Service whose usage information is being managed by this MBean.

Returns:

the names of the usage parameters interface types that the SBB has declared.

Throws:

NullPointerException - if id is null.

UnrecognizedSbbException - if id is not a recognizable SbbID for the SLEE, does not correspond with an SBB installed in the SLEE, or is not an SBB that participates in the Service whose usage information is being managed by this MBean.

InvalidArgumentException - if the identified SBB participates in this service but does not define a usage parameters interface.

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

Since:

Rhino 2.4.0

getSbbUsageNotificationManagerMBean

ObjectName getSbbUsageNotificationManagerMBean(SbbID id)
                                        throws NullPointerException,
                                               UnrecognizedSbbException,
                                               InvalidArgumentException,
                                               ManagementException

Specified by:

getSbbUsageNotificationManagerMBean in interface ServiceUsageMBean

Throws:

NullPointerException

UnrecognizedSbbException

InvalidArgumentException

ManagementException

getSbbUsageNotificationManagerMBean

ObjectName getSbbUsageNotificationManagerMBean(SbbID id,
                                               String upiType)
                                        throws NullPointerException,
                                               UnrecognizedSbbException,
                                               InvalidArgumentException,
                                               UnrecognizedUsageParametersInterfaceTypeException,
                                               ManagementException

Get the JMX Object Name of a UsageNotificationManagerMBean that provides management access to the usage notification manager for the specified usage parameter set type for the specified SBB. The SBB must be participating in the Service that this MBean provides usage management access for, and must have defined at least one usage parameters interface.

Parameters:

id - the component identifier of the SBB. The SBB must be an SBB that is used in the Service whose usage information is being managed by this MBean.

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

Throws:

NullPointerException - if either parameter is null.

UnrecognizedSbbException - if id is not a recognizable SbbID for the SLEE, does not correspond with an SBB installed in the SLEE, or is not an SBB that participates in the Service whose usage information is being managed by this MBean.

InvalidArgumentException - if the identified SBB participates in this service but does not define a usage parameters interface.

UnrecognizedUsageParametersInterfaceTypeException - if the named usage parameters interface type does not exist for the SBB.

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

Since:

Rhino 2.4.0