UsageNotificationManagerMBean (Rhino 3.1 Management Extensions API)

All Superinterfaces:: UsageNotificationManagerMBean

public interface UsageNotificationManagerMBean
extends UsageNotificationManagerMBean

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`NAMESPACE_KEY`	The JMX Object Name property key that identifies the namespace that the Usage Notification Manager MBean belongs to.
`static String`	`USAGE_PARAMETERS_INTERFACE_TYPE_KEY`	The JMX Object Name property key that identifies the type of the usage parameters interface that the Usage Notification Manager MBean is providing usage information for.

Fields inherited from interface javax.slee.usage.UsageNotificationManagerMBean
BASE_OBJECT_NAME, NOTIFICATION_SOURCE_KEY

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getNamespace()`	Get the namespace that the usage parameters managed by this Usage Notification Manager MBean reside in.
`String`	`getUsageParametersInterfaceType()`	Get the usage parameters interface type of the usage parameters managed by this Usage Notification Manager MBean.
`TabularData`	`tabulateAll()`	Get the values of all usage notifications-enabled flags for the usage parameters managed by this Usage Notification Manager MBean.

Methods inherited from interface javax.slee.usage.UsageNotificationManagerMBean
close, getNotificationSource

Field Detail
- NAMESPACE_KEY
```
static final String NAMESPACE_KEY
```
  The JMX Object Name property key that identifies the namespace that the Usage Notification Manager MBean belongs to. This key is equal to the string "namespace". This key is only present in the Object Name if the Usage Notification Manager 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
- USAGE_PARAMETERS_INTERFACE_TYPE_KEY
```
static final String USAGE_PARAMETERS_INTERFACE_TYPE_KEY
```
  The JMX Object Name property key that identifies the type of the usage parameters interface that the Usage Notification Manager MBean is providing usage information for. This key is equal to the string "upiType". This attribute is only present in Usage Notification Manager MBeans for usage parameter interfaces declared using the Rhino extension mechanism.
  
  See Also:
  
  UsageNotificationManagerMBean.BASE_OBJECT_NAME, Constant Field Values

Method Detail

getNamespace
```
String getNamespace()
```
Get the namespace that the usage parameters managed by this Usage Notification Manager MBean reside in.

Returns:

the namespace, or null if the usage parameters reside in the default namespace.

getUsageParametersInterfaceType
```
String getUsageParametersInterfaceType()
                                throws ManagementException
```
Get the usage parameters interface type of the usage parameters managed by this Usage Notification Manager MBean.

This method only returns a non-null value if the usage parameters interface was declared using the Rhino extension mechanism.

Returns:

the usage parameters interface type name, or null if the usage parameters interface was declared using the standard SLEE mechanism.

Throws:

ManagementException - if a system-level failure occurs.

Since:

Rhino 2.4.0

tabulateAll

TabularData tabulateAll()
                 throws ManagementException

Get the values of all usage notifications-enabled flags for the usage parameters managed by this Usage Notification Manager MBean.

This method returns tabular data with the following structure:

Field

Open Type

Description

parameter-name

String

The name of the usage parameter.

notifications-enabled

Boolean

Flag indicating whether or not usage notifications are enabled for this usage parameter.

Returns:: Tabulated values for all usage notifications-enabled flags for the usage parameters managed by this Usage Notification Manager MBean.
Throws:: ManagementException - if the values of the flags could not be obtained due to a system-level failure.