RemoteUsage (Rhino 2.5 Remote API)

java.lang.Object
- com.opencloud.slee.remote.RemoteUsage

```
public class RemoteUsage
extends Object
```
Create proxies for Usage-related MBeans and helper classes to read usage parameters.

Author:

OpenCloud

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RemoteUsage.Profiles` Create proxies for Profile Table Usage MBeans and helper classes to read usage parameters.
`static class`	`RemoteUsage.Resources` Create proxies for Resource Adaptor Entity Usage MBeans and helper classes to read usage parameters.
`static class`	`RemoteUsage.Sbbs` Create proxies for SBB Usage MBeans and helper classes to read usage parameters.
`static class`	`RemoteUsage.Subsystems` Create proxies for SLEE Subsystem Usage MBeans and helper classes to read usage parameters.
`static class`	`RemoteUsage.UsageNotificationManager` Helps enabling/disabling notifications for usage parameters.
`static class`	`RemoteUsage.UsageReader` Helps obtaining usage parameters by name.

Method Summary

Methods
Modifier and Type	Method and Description
`static UsageMBean`	`getUsageMBean(MBeanServerConnection server, NotificationSource notificationSource)` Get a UsageMBean for a notification source.
`static UsageMBean`	`getUsageMBean(MBeanServerConnection server, NotificationSource notificationSource, String paramSetName)` Get a UsageMBean for a notification source and parameter set.
`static UsageMBean`	`getUsageMBean(MBeanServerConnection server, ObjectName objectName)` Get a proxy for a UsageMBean with the given object name.
`static RemoteUsage.UsageNotificationManager`	`getUsageNotificationManager(MBeanServerConnection server, NotificationSource notificationSource)` Get a UsageNotificationManager helper for a notification source.
`static RemoteUsage.UsageNotificationManager`	`getUsageNotificationManager(MBeanServerConnection server, NotificationSource notificationSource, String upiType)` Get a UsageNotificationManager helper for a notification source and usage parameters interface type.
`static UsageNotificationManagerMBean`	`getUsageNotificationManagerMBean(MBeanServerConnection server, NotificationSource notificationSource)` Get a UsageNotificationManagerMBean for a notification source.
`static UsageNotificationManagerMBean`	`getUsageNotificationManagerMBean(MBeanServerConnection server, NotificationSource notificationSource, String upiType)` Get a UsageNotificationManagerMBean for a notification source and usage parameters interface type.
`static UsageNotificationManagerMBean`	`getUsageNotificationManagerMBean(MBeanServerConnection server, ObjectName objectName)` Get a proxy for a UsageNotificationManagerMBean with the given object name.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getUsageMBean
```
public static UsageMBean getUsageMBean(MBeanServerConnection server,
                       ObjectName objectName)
```
Get a proxy for a UsageMBean with the given object name.

Parameters:
server - a server connection
objectName - the objectName of the Usage MBean

Returns:
a proxy to a UsageMBean on the server

getUsageNotificationManagerMBean

public static UsageNotificationManagerMBean getUsageNotificationManagerMBean(MBeanServerConnection server,
                                                             ObjectName objectName)

Get a proxy for a UsageNotificationManagerMBean with the given object name.

Parameters:: server - a server connection; objectName - the objectName of the Usage MBean
Returns:: a proxy to a UsageNotificationManagerMBean on the server

getUsageMBean
```
public static UsageMBean getUsageMBean(MBeanServerConnection server,
                       NotificationSource notificationSource)
                                throws InvalidArgumentException,
                                       UnrecognizedServiceException,
                                       UnrecognizedSbbException,
                                       ManagementException,
                                       UnrecognizedProfileTableNameException,
                                       UnrecognizedResourceAdaptorEntityException,
                                       UnrecognizedSubsystemException
```
Get a UsageMBean for a notification source.

Parameters:
server - a server connection
notificationSource - a NotificationSource instance to determine the type of usage and the name of the component

Returns:
a proxy to a UsageMBean on the server

Throws:

InvalidArgumentException

UnrecognizedServiceException - if the notification source contains a ServiceID that not a recognizable ServiceID for the SLEE or it does not correspond with a Service installed in the SLEE

UnrecognizedSbbException - if the notification source contains a SbbID that 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 a UsageMBean could not be obtained due to a system-level failure

UnrecognizedProfileTableNameException

UnrecognizedResourceAdaptorEntityException

UnrecognizedSubsystemException

getUsageMBean

public static UsageMBean getUsageMBean(MBeanServerConnection server,
                       NotificationSource notificationSource,
                       String paramSetName)
                                throws InvalidArgumentException,
                                       UnrecognizedUsageParameterSetNameException,
                                       UnrecognizedServiceException,
                                       UnrecognizedSbbException,
                                       ManagementException,
                                       UnrecognizedProfileTableNameException,
                                       UnrecognizedResourceAdaptorEntityException,
                                       UnrecognizedSubsystemException

Get a UsageMBean for a notification source and parameter set.

Parameters:: server - a server connection; notificationSource - a NotificationSource instance to determine the type of usage and the name of the component; paramSetName - the name of the usage parameter set
Returns:: a proxy to a UsageMBean on the server
Throws:: InvalidArgumentException; UnrecognizedUsageParameterSetNameException; UnrecognizedServiceException - if the notification source contains a ServiceID that not a recognizable ServiceID for the SLEE or it does not correspond with a Service installed in the SLEE; UnrecognizedSbbException - if the notification source contains a SbbID that 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; UnrecognizedProfileTableNameException; UnrecognizedResourceAdaptorEntityException; UnrecognizedSubsystemException

getUsageNotificationManagerMBean

public static UsageNotificationManagerMBean getUsageNotificationManagerMBean(MBeanServerConnection server,
                                                             NotificationSource notificationSource)
                                                                      throws InvalidArgumentException,
                                                                             UnrecognizedServiceException,
                                                                             UnrecognizedSbbException,
                                                                             ManagementException,
                                                                             UnrecognizedProfileTableNameException,
                                                                             UnrecognizedResourceAdaptorEntityException,
                                                                             UnrecognizedSubsystemException

Get a UsageNotificationManagerMBean for a notification source.

Parameters:: server - a server connection; notificationSource - a NotificationSource instance to determine the type of usage and the name of the component
Returns:: a proxy to a UsageNotificationManagerMBean on the server
Throws:: InvalidArgumentException; UnrecognizedServiceException - if the notification source contains a ServiceID that not a recognizable ServiceID for the SLEE or it does not correspond with a Service installed in the SLEE; UnrecognizedSbbException - if the notification source contains a SbbID that 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; UnrecognizedProfileTableNameException; UnrecognizedResourceAdaptorEntityException; UnrecognizedSubsystemException

getUsageNotificationManagerMBean

public static UsageNotificationManagerMBean getUsageNotificationManagerMBean(MBeanServerConnection server,
                                                             NotificationSource notificationSource,
                                                             String upiType)
                                                                      throws InvalidArgumentException,
                                                                             UnrecognizedServiceException,
                                                                             UnrecognizedSbbException,
                                                                             ManagementException,
                                                                             UnrecognizedProfileTableNameException,
                                                                             UnrecognizedResourceAdaptorEntityException,
                                                                             UnrecognizedSubsystemException,
                                                                             UnrecognizedUsageParametersInterfaceTypeException

Get a UsageNotificationManagerMBean for a notification source and usage parameters interface type.

Parameters:: server - a server connection; notificationSource - a NotificationSource instance to determine the type of usage and the name of the component; upiType - the usage parameters interface type
Returns:: a proxy to a UsageNotificationManagerMBean on the server
Throws:: InvalidArgumentException; UnrecognizedServiceException - if the notification source contains a ServiceID that not a recognizable ServiceID for the SLEE or it does not correspond with a Service installed in the SLEE; UnrecognizedSbbException - if the notification source contains a SbbID that 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; UnrecognizedProfileTableNameException; UnrecognizedResourceAdaptorEntityException; UnrecognizedSubsystemException; UnrecognizedUsageParametersInterfaceTypeException

getUsageNotificationManager

public static RemoteUsage.UsageNotificationManager getUsageNotificationManager(MBeanServerConnection server,
                                                               NotificationSource notificationSource)
                                                                        throws InvalidArgumentException,
                                                                               UnrecognizedServiceException,
                                                                               UnrecognizedSbbException,
                                                                               ManagementException,
                                                                               UnrecognizedProfileTableNameException,
                                                                               UnrecognizedResourceAdaptorEntityException,
                                                                               UnrecognizedSubsystemException

Get a UsageNotificationManager helper for a notification source.

Parameters:: server - a server connection; notificationSource - a NotificationSource instance to determine the type of usage and the name of the component
Returns:: a UsageNotificationManager helper object
Throws:: InvalidArgumentException; UnrecognizedServiceException - if the notification source contains a ServiceID that not a recognizable ServiceID for the SLEE or it does not correspond with a Service installed in the SLEE; UnrecognizedSbbException - if the notification source contains a SbbID that 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; UnrecognizedProfileTableNameException; UnrecognizedResourceAdaptorEntityException; UnrecognizedSubsystemException

getUsageNotificationManager

public static RemoteUsage.UsageNotificationManager getUsageNotificationManager(MBeanServerConnection server,
                                                               NotificationSource notificationSource,
                                                               String upiType)
                                                                        throws InvalidArgumentException,
                                                                               UnrecognizedServiceException,
                                                                               UnrecognizedSbbException,
                                                                               ManagementException,
                                                                               UnrecognizedProfileTableNameException,
                                                                               UnrecognizedResourceAdaptorEntityException,
                                                                               UnrecognizedSubsystemException,
                                                                               UnrecognizedUsageParametersInterfaceTypeException

Get a UsageNotificationManager helper for a notification source and usage parameters interface type.

Parameters:: server - a server connection; notificationSource - a NotificationSource instance to determine the type of usage and the name of the component; upiType - the usage parameters interface type
Returns:: a UsageNotificationManager helper object
Throws:: InvalidArgumentException; UnrecognizedServiceException - if the notification source contains a ServiceID that not a recognizable ServiceID for the SLEE or it does not correspond with a Service installed in the SLEE; UnrecognizedSbbException - if the notification source contains a SbbID that 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; UnrecognizedProfileTableNameException; UnrecognizedResourceAdaptorEntityException; UnrecognizedSubsystemException; UnrecognizedUsageParametersInterfaceTypeException

Class RemoteUsage

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getUsageMBean

getUsageNotificationManagerMBean

getUsageMBean

getUsageMBean

getUsageNotificationManagerMBean

getUsageNotificationManagerMBean

getUsageNotificationManager

getUsageNotificationManager