Package com.opencloud.slee.remote

Class RemoteUsage.Sbbs

java.lang.Object

com.opencloud.slee.remote.RemoteUsage.Sbbs

Enclosing class:

RemoteUsage

public static class RemoteUsage.Sbbs
extends Object

Create proxies for SBB Usage MBeans and helper classes to read usage parameters.

Method Summary

Modifier and Type	Method	Description
static ServiceUsageMBean	getServiceUsageMBean(MBeanServerConnection server, ServiceID serviceID)	Provides a ServiceUsageMBean proxy object for a ServiceID.
static UsageMBean	getUsageMBean(MBeanServerConnection server, ServiceUsageMBean serviceUsageMBean, SbbID sbbID)	Get a UsageMBean for the unnamed parameter set of an SBB.
static UsageMBean	getUsageMBean(MBeanServerConnection server, ServiceUsageMBean serviceUsageMBean, SbbID sbbID, int nodeID)	Get a UsageMBean for the unnamed parameter set of an SBB on the specified node.
static UsageMBean	getUsageMBean(MBeanServerConnection server, ServiceUsageMBean serviceUsageMBean, SbbID sbbID, String paramSetName)	Get a UsageMBean for the specified parameter set of an SBB.
static UsageMBean	getUsageMBean(MBeanServerConnection server, ServiceUsageMBean serviceUsageMBean, SbbID sbbID, String paramSetName, int nodeID)	Get a UsageMBean for the specified parameter set of an SBB on the specified node.
static UsageMBean	getUsageMBean(MBeanServerConnection server, ServiceID serviceID, SbbID sbbID)	Get a UsageMBean for the unnamed parameter set for an SBB.
static UsageMBean	getUsageMBean(MBeanServerConnection server, ServiceID serviceID, SbbID sbbID, int nodeID)	Get a UsageMBean for the unnamed parameter set of an SBB on the specified node.
static UsageMBean	getUsageMBean(MBeanServerConnection server, ServiceID serviceID, SbbID sbbID, String paramSetName)	Get a UsageMBean for the specified parameter set of an SBB.
static UsageMBean	getUsageMBean(MBeanServerConnection server, ServiceID serviceID, SbbID sbbID, String paramSetName, int nodeID)	Get a UsageMBean for the specified parameter set of an SBB on the specified node.
static RemoteUsage.UsageNotificationManager	getUsageNotificationManager(MBeanServerConnection server, ServiceID serviceID, SbbID sbbID)	Get a RemoteUsage.UsageNotificationManager.
static RemoteUsage.UsageNotificationManager	getUsageNotificationManager(MBeanServerConnection server, ServiceID serviceID, SbbID sbbID, String upiType)	Get a RemoteUsage.UsageNotificationManager.
static UsageNotificationManagerMBean	getUsageNotificationManagerMBean(MBeanServerConnection server, ServiceUsageMBean serviceUsageMBean, SbbID sbbID)	Get a UsageNotificationManagerMBean for an SBB.
static UsageNotificationManagerMBean	getUsageNotificationManagerMBean(MBeanServerConnection server, ServiceUsageMBean serviceUsageMBean, SbbID sbbID, String upiType)	Get a UsageNotificationManagerMBean for an SBB.
static RemoteUsage.UsageReader	getUsageReader(MBeanServerConnection server, ServiceID serviceID, SbbID sbbID)	Get a RemoteUsage.UsageReader for the unnamed parameter set.
static RemoteUsage.UsageReader	getUsageReader(MBeanServerConnection server, ServiceID serviceID, SbbID sbbID, int nodeID)	Get a RemoteUsage.UsageReader for the unnamed parameter set on the specified node.
static RemoteUsage.UsageReader	getUsageReader(MBeanServerConnection server, ServiceID serviceID, SbbID sbbID, String paramSetName)	Get a RemoteUsage.UsageReader for the specified usage parameter set.
static RemoteUsage.UsageReader	getUsageReader(MBeanServerConnection server, ServiceID serviceID, SbbID sbbID, String paramSetName, int nodeID)	Get a RemoteUsage.UsageReader for the specified usage parameter set on the specified node.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getServiceUsageMBean

public static ServiceUsageMBean getServiceUsageMBean(MBeanServerConnection server,
                                                     ServiceID serviceID)
                                              throws NullPointerException,
                                                     UnrecognizedServiceException,
                                                     ManagementException

Provides a ServiceUsageMBean proxy object for a ServiceID.

Parameters:

serviceID - the component identifier of the Service

Returns:

a ServiceUsageMBean proxy

Throws:

NullPointerException - if serviceId is null

UnrecognizedServiceException - if serviceId is not a recognizable ServiceID for the SLEE or it does not correspond with a Service installed in the SLEE

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

getUsageMBean

public static UsageMBean getUsageMBean(MBeanServerConnection server,
                                       ServiceID serviceID,
                                       SbbID sbbID)
                                throws UnrecognizedServiceException,
                                       ManagementException,
                                       InvalidArgumentException,
                                       UnrecognizedSbbException

Get a UsageMBean for the unnamed parameter set for an SBB.

Parameters:

server - a server connection

serviceID - the component identifier of the Service

sbbID - 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:

a proxy to a UsageMBean on the server

Throws:

UnrecognizedServiceException - if serviceId is not a recognizable ServiceID for the SLEE or it does not correspond with a Service installed in the SLEE

UnrecognizedSbbException - if `sbbId` 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

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

getUsageMBean

public static UsageMBean getUsageMBean(MBeanServerConnection server,
                                       ServiceID serviceID,
                                       SbbID sbbID,
                                       String paramSetName)
                                throws UnrecognizedServiceException,
                                       ManagementException,
                                       InvalidArgumentException,
                                       UnrecognizedUsageParameterSetNameException,
                                       UnrecognizedSbbException

Get a UsageMBean for the specified parameter set of an SBB.

Parameters:

server - a server connection

serviceID - the component identifier of the Service

sbbID - 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

Returns:

a proxy to a UsageMBean on the server

Throws:

UnrecognizedServiceException - if `serviceID` is not a recognizable ServiceID for the SLEE or it does not correspond with a Service installed in the SLEE

UnrecognizedSbbException - if `sbbID` 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

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

InvalidArgumentException

UnrecognizedUsageParameterSetNameException

getUsageMBean

public static UsageMBean getUsageMBean(MBeanServerConnection server,
                                       ServiceID serviceID,
                                       SbbID sbbID,
                                       int nodeID)
                                throws UnrecognizedServiceException,
                                       ManagementException,
                                       InvalidArgumentException,
                                       UnrecognizedUsageParameterSetNameException,
                                       UnrecognizedSbbException

Get a UsageMBean for the unnamed parameter set of an SBB on the specified node.

Parameters:

server - a server connection

serviceID - the component identifier of the Service

sbbID - 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:

a proxy to a UsageMBean on the server

Throws:

UnrecognizedServiceException - if `serviceID` is not a recognizable ServiceID for the SLEE or it does not correspond with a Service installed in the SLEE

UnrecognizedSbbException - if `sbbID` 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

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

InvalidArgumentException

UnrecognizedUsageParameterSetNameException

getUsageMBean

public static UsageMBean getUsageMBean(MBeanServerConnection server,
                                       ServiceID serviceID,
                                       SbbID sbbID,
                                       String paramSetName,
                                       int nodeID)
                                throws UnrecognizedServiceException,
                                       ManagementException,
                                       InvalidArgumentException,
                                       UnrecognizedUsageParameterSetNameException,
                                       UnrecognizedSbbException

Get a UsageMBean for the specified parameter set of an SBB on the specified node.

Parameters:

server - a server connection

serviceID - the component identifier of the Service

sbbID - 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

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

Returns:

a proxy to a UsageMBean on the server

Throws:

UnrecognizedServiceException - if `serviceID` is not a recognizable ServiceID for the SLEE or it does not correspond with a Service installed in the SLEE

UnrecognizedSbbException - if `sbbID` 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

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

InvalidArgumentException

UnrecognizedUsageParameterSetNameException

getUsageMBean

public static UsageMBean getUsageMBean(MBeanServerConnection server,
                                       ServiceUsageMBean serviceUsageMBean,
                                       SbbID sbbID)
                                throws NullPointerException,
                                       UnrecognizedSbbException,
                                       InvalidArgumentException,
                                       ManagementException

Get a UsageMBean for the unnamed parameter set of an SBB. Use this method if you already have a ServiceUsageMBean reference.

Parameters:

server - a server connection

serviceUsageMBean -

sbbID - 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:

a proxy to a UsageMBean on the server

Throws:

NullPointerException

UnrecognizedSbbException - if `sbbId` 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

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

getUsageMBean

public static UsageMBean getUsageMBean(MBeanServerConnection server,
                                       ServiceUsageMBean serviceUsageMBean,
                                       SbbID sbbID,
                                       String paramSetName)
                                throws NullPointerException,
                                       UnrecognizedSbbException,
                                       InvalidArgumentException,
                                       UnrecognizedUsageParameterSetNameException,
                                       ManagementException

Get a UsageMBean for the specified parameter set of an SBB. Use this method if you already have a ServiceUsageMBean reference.

Parameters:

server - a server connection

serviceUsageMBean -

sbbID - 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

Returns:

a proxy to a UsageMBean on the server

Throws:

NullPointerException

UnrecognizedSbbException - if `sbbId` 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

UnrecognizedUsageParameterSetNameException

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

getUsageMBean

public static UsageMBean getUsageMBean(MBeanServerConnection server,
                                       ServiceUsageMBean serviceUsageMBean,
                                       SbbID sbbID,
                                       int nodeID)
                                throws NullPointerException,
                                       UnrecognizedSbbException,
                                       InvalidArgumentException,
                                       UnrecognizedUsageParameterSetNameException,
                                       ManagementException

Get a UsageMBean for the unnamed parameter set of an SBB on the specified node. Use this method if you already have a ServiceUsageMBean reference.

Parameters:

server - a server connection

serviceUsageMBean -

sbbID - 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:

a proxy to a UsageMBean on the server

Throws:

NullPointerException

UnrecognizedSbbException - if `sbbId` 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

UnrecognizedUsageParameterSetNameException

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

getUsageMBean

public static UsageMBean getUsageMBean(MBeanServerConnection server,
                                       ServiceUsageMBean serviceUsageMBean,
                                       SbbID sbbID,
                                       String paramSetName,
                                       int nodeID)
                                throws NullPointerException,
                                       UnrecognizedSbbException,
                                       InvalidArgumentException,
                                       UnrecognizedUsageParameterSetNameException,
                                       ManagementException

Get a UsageMBean for the specified parameter set of an SBB on the specified node. Use this method if you already have a ServiceUsageMBean reference.

Parameters:

server - a server connection

serviceUsageMBean -

sbbID - 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

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

Returns:

a proxy to a UsageMBean on the server

Throws:

NullPointerException

UnrecognizedSbbException - if `sbbId` 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

UnrecognizedUsageParameterSetNameException

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

getUsageNotificationManagerMBean

public static UsageNotificationManagerMBean getUsageNotificationManagerMBean(MBeanServerConnection server,
                                                                             ServiceUsageMBean serviceUsageMBean,
                                                                             SbbID sbbID)
                                                                      throws NullPointerException,
                                                                             UnrecognizedSbbException,
                                                                             InvalidArgumentException,
                                                                             ManagementException

Get a UsageNotificationManagerMBean for an SBB.

Parameters:

server - a server connection

serviceUsageMBean -

sbbID - 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:

a proxy to a UsageNotificationManagerMBean on the server

Throws:

NullPointerException

UnrecognizedSbbException

InvalidArgumentException

ManagementException

getUsageNotificationManagerMBean

public static UsageNotificationManagerMBean getUsageNotificationManagerMBean(MBeanServerConnection server,
                                                                             ServiceUsageMBean serviceUsageMBean,
                                                                             SbbID sbbID,
                                                                             String upiType)
                                                                      throws NullPointerException,
                                                                             UnrecognizedSbbException,
                                                                             InvalidArgumentException,
                                                                             UnrecognizedUsageParametersInterfaceTypeException,
                                                                             ManagementException

Get a UsageNotificationManagerMBean for an SBB.

Parameters:

server - a server connection

serviceUsageMBean -

sbbID - 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 parameter set type

Returns:

a proxy to a UsageNotificationManagerMBean on the server

Throws:

NullPointerException

UnrecognizedSbbException

InvalidArgumentException

ManagementException

UnrecognizedUsageParametersInterfaceTypeException

getUsageReader

public static RemoteUsage.UsageReader getUsageReader(MBeanServerConnection server,
                                                     ServiceID serviceID,
                                                     SbbID sbbID)
                                              throws UnrecognizedServiceException,
                                                     ManagementException,
                                                     InvalidArgumentException,
                                                     UnrecognizedSbbException

Get a RemoteUsage.UsageReader for the unnamed parameter set.

Parameters:

server - a server connection

serviceID - the component identifier of the Service

sbbID - 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:

a UsageReader helper object

Throws:

UnrecognizedServiceException

ManagementException

InvalidArgumentException

UnrecognizedSbbException

getUsageReader

public static RemoteUsage.UsageReader getUsageReader(MBeanServerConnection server,
                                                     ServiceID serviceID,
                                                     SbbID sbbID,
                                                     String paramSetName)
                                              throws UnrecognizedServiceException,
                                                     ManagementException,
                                                     InvalidArgumentException,
                                                     UnrecognizedUsageParameterSetNameException,
                                                     UnrecognizedSbbException

Get a RemoteUsage.UsageReader for the specified usage parameter set.

Parameters:

server - a server connection

serviceID - the component identifier of the Service

sbbID - 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

Returns:

a UsageReader helper object

Throws:

UnrecognizedServiceException

ManagementException

InvalidArgumentException

UnrecognizedUsageParameterSetNameException

UnrecognizedSbbException

getUsageReader

public static RemoteUsage.UsageReader getUsageReader(MBeanServerConnection server,
                                                     ServiceID serviceID,
                                                     SbbID sbbID,
                                                     int nodeID)
                                              throws UnrecognizedServiceException,
                                                     ManagementException,
                                                     InvalidArgumentException,
                                                     UnrecognizedUsageParameterSetNameException,
                                                     UnrecognizedSbbException

Get a RemoteUsage.UsageReader for the unnamed parameter set on the specified node.

Parameters:

server - a server connection

serviceID - the component identifier of the Service

sbbID - 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:

a UsageReader helper object

Throws:

UnrecognizedServiceException

ManagementException

InvalidArgumentException

UnrecognizedUsageParameterSetNameException

UnrecognizedSbbException

getUsageReader

public static RemoteUsage.UsageReader getUsageReader(MBeanServerConnection server,
                                                     ServiceID serviceID,
                                                     SbbID sbbID,
                                                     String paramSetName,
                                                     int nodeID)
                                              throws UnrecognizedServiceException,
                                                     ManagementException,
                                                     InvalidArgumentException,
                                                     UnrecognizedUsageParameterSetNameException,
                                                     UnrecognizedSbbException

Get a RemoteUsage.UsageReader for the specified usage parameter set on the specified node.

Parameters:

server - a server connection

serviceID - the component identifier of the Service

sbbID - 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

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

Returns:

a UsageReader helper object

Throws:

UnrecognizedServiceException

ManagementException

InvalidArgumentException

UnrecognizedUsageParameterSetNameException

UnrecognizedSbbException

getUsageNotificationManager

public static RemoteUsage.UsageNotificationManager getUsageNotificationManager(MBeanServerConnection server,
                                                                               ServiceID serviceID,
                                                                               SbbID sbbID)
                                                                        throws InvalidArgumentException,
                                                                               ManagementException,
                                                                               UnrecognizedServiceException,
                                                                               UnrecognizedSbbException

Get a RemoteUsage.UsageNotificationManager.

Parameters:

server - a server connection

serviceID - the component identifier of the Service

sbbID - 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:

a UsageNotificationManager helper object

Throws:

InvalidArgumentException

ManagementException

UnrecognizedServiceException

UnrecognizedSbbException

getUsageNotificationManager

public static RemoteUsage.UsageNotificationManager getUsageNotificationManager(MBeanServerConnection server,
                                                                               ServiceID serviceID,
                                                                               SbbID sbbID,
                                                                               String upiType)
                                                                        throws InvalidArgumentException,
                                                                               ManagementException,
                                                                               UnrecognizedServiceException,
                                                                               UnrecognizedSbbException,
                                                                               UnrecognizedUsageParametersInterfaceTypeException

Get a RemoteUsage.UsageNotificationManager.

Parameters:

server - a server connection

serviceID - the component identifier of the Service

sbbID - 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

Returns:

a UsageNotificationManager helper object

Throws:

InvalidArgumentException

ManagementException

UnrecognizedServiceException

UnrecognizedSbbException

UnrecognizedUsageParametersInterfaceTypeException