|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The SbbUsageMBean
interface must be implemented by a SBB Usage MBean Class
generated by the SLEE. This interface contains functionality that provides basic
management of an SBB's usage parameters. The Object Name of a SbbUsageMBean
object can be obtained by a management client by invoking one of the getSbbUsageMBean
methods on a ServiceUsageMBean
object.
Interface extension
During SBB deployment the SbbUsageMBean
interface is extended to provide access
to the usage parameters defined by the SBB. Each counter-type usage parameter causes the
addition of a managed operation with the following signature:
public long get<usage-parameter-name>(boolean reset);
Each sample-type usage parameter causes the addition of a managed operation with the following signature:
public SampleStatistics get<usage-parameter-name>(boolean reset);
In each operation, usage-parameter-name
is the name of the usage
parameter, with the first letter capitalized. The reset
parameter taken by
each operation is used to optionally reset the usage parameter value after the return
result has been obtained.
Notifications
Since SbbUsageMBean
objects can emit Usage
notifications, it is required that a SbbUsageMBean
object implement
the javax.management.NotificationBroadcaster
interface.
Field Summary | |
static java.lang.String |
USAGE_NOTIFICATION_TYPE
The notification type of usage notifications emitted by this MBean. |
Method Summary | |
void |
close()
Notify the SLEE that the SBB usage MBean is no longer required by the management client. |
SbbID |
getSbb()
Get the component identifier of the SBB that this MBean is presenting usage information for. |
ServiceID |
getService()
Get the component identifier of the Service containing the SBB that this MBean is presenting usage information for. |
java.lang.String |
getUsageParameterSet()
Get the name of the SBB usage parameter set that this MBean is presenting usage information for. |
void |
resetAllUsageParameters()
Reset all SBB usage parameters in the usage parameter set managed by this MBean. |
Field Detail |
public static final java.lang.String USAGE_NOTIFICATION_TYPE
Method Detail |
public ServiceID getService() throws ManagementException
ManagementException
- if the Service component identifier could not be
obtained due to a system-level failure.public SbbID getSbb() throws ManagementException
ManagementException
- if the SBB component identifier could not be
obtained due to a system-level failure.public java.lang.String getUsageParameterSet() throws ManagementException
null
if this MBean is presenting usage
information for the SBB's default usage parameter set.ManagementException
- if the SBB usage parameter set name could not be
obtained due to a system-level failure.public void close() throws InvalidStateException, ManagementException
InvalidStateException
- if notification listeners are still attached to the sbb
usage MBean.ManagementException
- if the SBB usage MBean could not be closed by the SLEE
due to a system-level failure.public void resetAllUsageParameters() throws ManagementException
ManagementException
- if the values of the usage parameters could not be
reset due to a system-level failure.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |