Package com.opencloud.slee.remote

Class RemoteUsage.Resources

java.lang.Object

com.opencloud.slee.remote.RemoteUsage.Resources

Enclosing class:

RemoteUsage

public static class RemoteUsage.Resources
extends Object

Create proxies for Resource Adaptor Entity Usage MBeans and helper classes to read usage parameters.

Method Summary

Modifier and Type	Method	Description
static ResourceUsageMBean	getResourceUsageMBean(MBeanServerConnection server, String entityName)	Provides a ResourceUsageMBean proxy object for a RA entity name.
static UsageMBean	getUsageMBean(MBeanServerConnection server, ResourceUsageMBean resourceUsageMBean)	Get a UsageMBean for the unnamed parameter set of an RA entity.
static UsageMBean	getUsageMBean(MBeanServerConnection server, ResourceUsageMBean resourceUsageMBean, int nodeID)	Get a UsageMBean for the unnamed parameter set of an RA entity on the specified node.
static UsageMBean	getUsageMBean(MBeanServerConnection server, ResourceUsageMBean resourceUsageMBean, String paramSetName)	Get a UsageMBean for the specified parameter set of an RA entity.
static UsageMBean	getUsageMBean(MBeanServerConnection server, ResourceUsageMBean resourceUsageMBean, String paramSetName, int nodeID)	Get a UsageMBean for the specified parameter set of an RA entity on the specified node.
static UsageMBean	getUsageMBean(MBeanServerConnection server, String raEntityName)	Get a UsageMBean for the unnamed parameter set of an RA entity.
static UsageMBean	getUsageMBean(MBeanServerConnection server, String raEntityName, int nodeID)	Get a UsageMBean for the unnamed usage parameter set of an RA entity on the specified node.
static UsageMBean	getUsageMBean(MBeanServerConnection server, String raEntityName, String paramSetName)	Get a UsageMBean for the specified usage parameter set of an RA entity.
static UsageMBean	getUsageMBean(MBeanServerConnection server, String raEntityName, String paramSetName, int nodeID)	Get a UsageMBean for the specified usage parameter set of an RA entity on the specified node.
static RemoteUsage.UsageNotificationManager	getUsageNotificationManager(MBeanServerConnection server, String entityName)	Get a RemoteUsage.UsageNotificationManager.
static RemoteUsage.UsageNotificationManager	getUsageNotificationManager(MBeanServerConnection server, String entityName, String upiType)	Get a RemoteUsage.UsageNotificationManager.
static UsageNotificationManagerMBean	getUsageNotificationManagerMBean(MBeanServerConnection server, ResourceUsageMBean resourceUsageMBean)	Get a UsageNotificationManagerMBean for an RA entity.
static UsageNotificationManagerMBean	getUsageNotificationManagerMBean(MBeanServerConnection server, ResourceUsageMBean resourceUsageMBean, String paramSetType)	Get a UsageNotificationManagerMBean for an RA entity.
static RemoteUsage.UsageReader	getUsageReader(MBeanServerConnection server, String entityName)	Get a RemoteUsage.UsageReader for the unnamed usage parameter set.
static RemoteUsage.UsageReader	getUsageReader(MBeanServerConnection server, String entityName, int nodeID)	Get a RemoteUsage.UsageReader for the unnamed usage parameter set on the specified node.
static RemoteUsage.UsageReader	getUsageReader(MBeanServerConnection server, String entityName, String paramSetName)	Get a RemoteUsage.UsageReader for the specified usage parameter set.
static RemoteUsage.UsageReader	getUsageReader(MBeanServerConnection server, String entityName, 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

getResourceUsageMBean

public static ResourceUsageMBean getResourceUsageMBean(MBeanServerConnection server,
                                                       String entityName)
                                                throws InvalidArgumentException,
                                                       UnrecognizedResourceAdaptorEntityException,
                                                       ManagementException

Provides a ResourceUsageMBean proxy object for a RA entity name.

Parameters:

entityName - the RA entity name

Returns:

a ResourceUsageMBean proxy

Throws:

NullPointerException - if entityName is null

UnrecognizedResourceAdaptorEntityException - if the entity is unrecognized

ManagementException - if a management exception occurs

InvalidArgumentException

getUsageMBean

public static UsageMBean getUsageMBean(MBeanServerConnection server,
                                       String raEntityName)
                                throws ManagementException,
                                       InvalidArgumentException,
                                       UnrecognizedResourceAdaptorEntityException

Get a UsageMBean for the unnamed parameter set of an RA entity.

Parameters:

server - a server connection

raEntityName -

Returns:

a proxy to a UsageMBean on the server

Throws:

ManagementException

InvalidArgumentException

UnrecognizedResourceAdaptorEntityException

getUsageMBean

public static UsageMBean getUsageMBean(MBeanServerConnection server,
                                       String raEntityName,
                                       String paramSetName)
                                throws NullPointerException,
                                       UnrecognizedUsageParameterSetNameException,
                                       ManagementException,
                                       InvalidArgumentException,
                                       UnrecognizedResourceAdaptorEntityException

Get a UsageMBean for the specified usage parameter set of an RA entity.

Parameters:

server - a server connection

raEntityName - the name of the resource adaptor entity

paramSetName - the name of the usage parameter set

Returns:

a proxy to a UsageMBean on the server

Throws:

NullPointerException

UnrecognizedUsageParameterSetNameException

ManagementException

InvalidArgumentException

UnrecognizedResourceAdaptorEntityException

getUsageMBean

public static UsageMBean getUsageMBean(MBeanServerConnection server,
                                       String raEntityName,
                                       int nodeID)
                                throws NullPointerException,
                                       UnrecognizedUsageParameterSetNameException,
                                       ManagementException,
                                       InvalidArgumentException,
                                       UnrecognizedResourceAdaptorEntityException

Get a UsageMBean for the unnamed usage parameter set of an RA entity on the specified node.

Parameters:

server - a server connection

raEntityName - the name of the resource adaptor entity

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

UnrecognizedUsageParameterSetNameException

ManagementException

InvalidArgumentException

UnrecognizedResourceAdaptorEntityException

getUsageMBean

public static UsageMBean getUsageMBean(MBeanServerConnection server,
                                       String raEntityName,
                                       String paramSetName,
                                       int nodeID)
                                throws NullPointerException,
                                       UnrecognizedUsageParameterSetNameException,
                                       ManagementException,
                                       InvalidArgumentException,
                                       UnrecognizedResourceAdaptorEntityException

Get a UsageMBean for the specified usage parameter set of an RA entity on the specified node.

Parameters:

server - a server connection

raEntityName - the name of the resource adaptor entity.

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

UnrecognizedUsageParameterSetNameException

ManagementException

InvalidArgumentException

UnrecognizedResourceAdaptorEntityException

getUsageMBean

public static UsageMBean getUsageMBean(MBeanServerConnection server,
                                       ResourceUsageMBean resourceUsageMBean)
                                throws ManagementException

Get a UsageMBean for the unnamed parameter set of an RA entity. Use this method if you already have a ResourceUsageMBean reference.

Parameters:

server - a server connection

resourceUsageMBean - a ResourceUsageMBean obtained previously

Returns:

a proxy to a UsageMBean on the server

Throws:

ManagementException

getUsageMBean

public static UsageMBean getUsageMBean(MBeanServerConnection server,
                                       ResourceUsageMBean resourceUsageMBean,
                                       String paramSetName)
                                throws NullPointerException,
                                       UnrecognizedUsageParameterSetNameException,
                                       ManagementException

Get a UsageMBean for the specified parameter set of an RA entity. Use this method if you already have a ResourceUsageMBean reference.

Parameters:

server - a server connection

resourceUsageMBean - a ResourceUsageMBean obtained previously

paramSetName - the name of the usage parameter set

Returns:

a proxy to a UsageMBean on the server

Throws:

NullPointerException

UnrecognizedUsageParameterSetNameException

ManagementException

getUsageMBean

public static UsageMBean getUsageMBean(MBeanServerConnection server,
                                       ResourceUsageMBean resourceUsageMBean,
                                       int nodeID)
                                throws NullPointerException,
                                       UnrecognizedUsageParameterSetNameException,
                                       ManagementException

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

Parameters:

server - a server connection

resourceUsageMBean - a ResourceUsageMBean obtained previously

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

UnrecognizedUsageParameterSetNameException

ManagementException

getUsageMBean

public static UsageMBean getUsageMBean(MBeanServerConnection server,
                                       ResourceUsageMBean resourceUsageMBean,
                                       String paramSetName,
                                       int nodeID)
                                throws NullPointerException,
                                       UnrecognizedUsageParameterSetNameException,
                                       ManagementException

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

Parameters:

server - a server connection

resourceUsageMBean - a ResourceUsageMBean obtained previously

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

UnrecognizedUsageParameterSetNameException

ManagementException

getUsageNotificationManagerMBean

public static UsageNotificationManagerMBean getUsageNotificationManagerMBean(MBeanServerConnection server,
                                                                             ResourceUsageMBean resourceUsageMBean)
                                                                      throws ManagementException

Get a UsageNotificationManagerMBean for an RA entity.

Parameters:

server - a server connection

resourceUsageMBean - a ResourceUsageMBean obtained previously

Returns:

a proxy to a UsageNotificationManagerMBean on the server

Throws:

ManagementException

getUsageNotificationManagerMBean

public static UsageNotificationManagerMBean getUsageNotificationManagerMBean(MBeanServerConnection server,
                                                                             ResourceUsageMBean resourceUsageMBean,
                                                                             String paramSetType)
                                                                      throws UnrecognizedUsageParametersInterfaceTypeException,
                                                                             ManagementException

Get a UsageNotificationManagerMBean for an RA entity.

Parameters:

server - a server connection

resourceUsageMBean - a ResourceUsageMBean obtained previously

paramSetType - the usage parameter set type

Returns:

a proxy to a UsageNotificationManagerMBean on the server

Throws:

ManagementException

UnrecognizedUsageParametersInterfaceTypeException

getUsageReader

public static RemoteUsage.UsageReader getUsageReader(MBeanServerConnection server,
                                                     String entityName)
                                              throws InvalidArgumentException,
                                                     UnrecognizedResourceAdaptorEntityException,
                                                     ManagementException

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

Parameters:

server - a server connection

entityName -

Returns:

a UsageReader helper object

Throws:

InvalidArgumentException

UnrecognizedResourceAdaptorEntityException

ManagementException

getUsageReader

public static RemoteUsage.UsageReader getUsageReader(MBeanServerConnection server,
                                                     String entityName,
                                                     String paramSetName)
                                              throws InvalidArgumentException,
                                                     UnrecognizedResourceAdaptorEntityException,
                                                     ManagementException,
                                                     UnrecognizedUsageParameterSetNameException

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

Parameters:

server - a server connection

entityName - the name of the resource adaptor entity.

paramSetName - the name of the usage parameter set

Returns:

a UsageReader helper object

Throws:

InvalidArgumentException

UnrecognizedResourceAdaptorEntityException

UnrecognizedUsageParameterSetNameException

ManagementException

getUsageReader

public static RemoteUsage.UsageReader getUsageReader(MBeanServerConnection server,
                                                     String entityName,
                                                     int nodeID)
                                              throws InvalidArgumentException,
                                                     UnrecognizedResourceAdaptorEntityException,
                                                     ManagementException,
                                                     UnrecognizedUsageParameterSetNameException

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

Parameters:

server - a server connection

entityName - the name of the resource adaptor entity.

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

Returns:

a UsageReader helper object

Throws:

InvalidArgumentException

UnrecognizedResourceAdaptorEntityException

UnrecognizedUsageParameterSetNameException

ManagementException

getUsageReader

public static RemoteUsage.UsageReader getUsageReader(MBeanServerConnection server,
                                                     String entityName,
                                                     String paramSetName,
                                                     int nodeID)
                                              throws InvalidArgumentException,
                                                     UnrecognizedResourceAdaptorEntityException,
                                                     ManagementException,
                                                     UnrecognizedUsageParameterSetNameException

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

Parameters:

server - a server connection

entityName - the name of the resource adaptor entity.

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:

InvalidArgumentException

UnrecognizedResourceAdaptorEntityException

UnrecognizedUsageParameterSetNameException

ManagementException

getUsageNotificationManager

public static RemoteUsage.UsageNotificationManager getUsageNotificationManager(MBeanServerConnection server,
                                                                               String entityName)
                                                                        throws InvalidArgumentException,
                                                                               ManagementException,
                                                                               UnrecognizedResourceAdaptorEntityException

Get a RemoteUsage.UsageNotificationManager.

Parameters:

server - a server connection

entityName - the name of the resource adaptor entity.

Returns:

a UsageNotificationManager helper object

Throws:

InvalidArgumentException

UnrecognizedResourceAdaptorEntityException

ManagementException

getUsageNotificationManager

public static RemoteUsage.UsageNotificationManager getUsageNotificationManager(MBeanServerConnection server,
                                                                               String entityName,
                                                                               String upiType)
                                                                        throws InvalidArgumentException,
                                                                               ManagementException,
                                                                               UnrecognizedResourceAdaptorEntityException,
                                                                               UnrecognizedUsageParametersInterfaceTypeException

Get a RemoteUsage.UsageNotificationManager.

Parameters:

server - a server connection

entityName - the name of the resource adaptor entity.

upiType - the usage parameters interface type

Returns:

a UsageNotificationManager helper object

Throws:

InvalidArgumentException

UnrecognizedResourceAdaptorEntityException

UnrecognizedUsageParametersInterfaceTypeException

ManagementException