|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The ServiceUsageMBean
interface defines service usage-related
management operations. Using a ServiceUsageMBean
object a management
client may get access to SbbUsageMBean
objects, reset the usage
parameters for an individual SBB used in the represented Service, reset
usage parameters for all SBBs used in the represented Service, or modify the
list of named usage parameter sets an SBB is allowed to use.
Each SBB maintains seperate sets of usage information for each Service that it
participates in. A ServiceUsageMBean
object provides management of
usage information accumulated for a single Service for all the SBBs participating
in that Service.
The Object Name of a ServiceUsageMBean
object can be obtained by
a management client via the ServiceManagementMBean.getServiceUsageMBean(javax.slee.ServiceID)
method.
Method Summary | |
void |
close()
Notify the SLEE that the service usage MBean is no longer required by the management client. |
void |
createUsageParameterSet(SbbID id,
java.lang.String name)
Create a new usage parameter set that the specified SBB is permitted to use in the one-argument form of the get-usage-parameters methods, when the service component identifer argument of the get-usage-parameters method identifies the Service that this MBean provides usage management access for. |
javax.management.ObjectName |
getSbbUsageMBean(SbbID id)
Get the JMX Object Name of an SbbUsageMBean object that provides
management access to the unamed usage parameter set for the specified SBB. |
javax.management.ObjectName |
getSbbUsageMBean(SbbID id,
java.lang.String name)
Get the JMX Object Name of an SbbUsageMBean object that provides
management access to the named usage parameter set for the specified SBB. |
ServiceID |
getService()
Get the component identifier of the Service that this MBean provides usage management access for. |
java.lang.String[] |
getUsageParameterSets(SbbID id)
Get the names of the usage parameter sets that the specified SBB is permitted to use in the one-argument form of the get-usage-parameters methods, when the service component identifer argument of the get-usage-parameters method identifies the Service that this MBean provides usage management access for. |
void |
removeUsageParameterSet(SbbID id,
java.lang.String name)
Remove an existing usage parameter set that the specified SBB is permitted to use in the one-argument form of the get-usage-parameters methods, when the service component identifer argument of the get-usage-parameters method identifies the Service that this MBean provides usage management access for. |
void |
resetAllUsageParameters()
Reset all usage parameters in the unamed usage parameter set, and all named usage parameter sets, of all SBB participating in the Service whose usage information is being managed by this MBean. |
void |
resetAllUsageParameters(SbbID id)
Reset all usage parameters in the unamed usage parameter set, and all named usage parameter sets, of the specified SBB. |
Method Detail |
public ServiceID getService() throws ManagementException
ManagementException
- if the Service component identifier could not be
obtained due to a system-level failure.public void createUsageParameterSet(SbbID id, java.lang.String name) throws java.lang.NullPointerException, UnrecognizedSbbException, InvalidArgumentException, UsageParameterSetNameAlreadyExistsException, ManagementException
id
- 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.name
- the usage parameter set name. Names must be non-null and greater than 0
in length.java.lang.NullPointerException
- if either argument is null
.UnrecognizedSbbException
- if id
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
- if name
is zero-length or the identified
SBB participates in this service but does not define a usage parameters interface.UsageParameterSetNameAlreadyExistsException
- if the name has already been used to
create a usage parameter set for the SBB.ManagementException
- if the usage parameter set could not be created due to
a system-level failure.public void removeUsageParameterSet(SbbID id, java.lang.String name) throws java.lang.NullPointerException, UnrecognizedSbbException, InvalidArgumentException, UnrecognizedUsageParameterSetNameException, ManagementException
id
- 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.name
- the usage parameter set name.java.lang.NullPointerException
- if either argument is null
.UnrecognizedSbbException
- if id
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
- if the identified SBB participates in this service
but does not define a usage parameters interface.UnrecognizedUsageParameterSetNameException
- if the name does not identify a
usage parameter set that has been created for the SBB.ManagementException
- if the name could not be removed due to a system-level failure.public java.lang.String[] getUsageParameterSets(SbbID id) throws java.lang.NullPointerException, UnrecognizedSbbException, InvalidArgumentException, ManagementException
id
- 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.java.lang.NullPointerException
- if either argument is null
.InvalidArgumentException
- if the identified SBB participates in this service
but does not define a usage parameters interface.UnrecognizedSbbException
- if id
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 names could not be obtained due to a system-level
failure.public javax.management.ObjectName getSbbUsageMBean(SbbID id) throws java.lang.NullPointerException, UnrecognizedSbbException, InvalidArgumentException, ManagementException
SbbUsageMBean
object that provides
management access to the unamed usage parameter set for the specified SBB. The SBB
must be participating in the Service that this MBean provides usage management access
for, and must have defined a usage parameter interface.id
- 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.SbbUsageMBean
object.java.lang.NullPointerException
- if id
is null
.UnrecognizedSbbException
- if id
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
- if the identified SBB participates in this service
but does not define a usage parameters interface.ManagementException
- if the object name could not be obtained due to a
system-level failure.public javax.management.ObjectName getSbbUsageMBean(SbbID id, java.lang.String name) throws java.lang.NullPointerException, UnrecognizedSbbException, InvalidArgumentException, UnrecognizedUsageParameterSetNameException, ManagementException
SbbUsageMBean
object that provides
management access to the named usage parameter set for the specified SBB. The SBB
must be participating in the Service that this MBean provides usage management access
for, and must have defined a usage parameter interface.id
- 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.name
- the name of the usage parameter set. The name must be one of the names
returned by getUsageParameterSets
(id)
.SbbUsageMBean
object.java.lang.NullPointerException
- if either parameter is null
.UnrecognizedSbbException
- if id
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
- if the identified SBB participates in this service
but does not define a usage parameters interface.UnrecognizedUsageParameterSetNameException
- if the named usage parameter set
has not been created for the SBB.ManagementException
- if the object name could not be obtained due to a
system-level failure.public void resetAllUsageParameters(SbbID id) throws java.lang.NullPointerException, UnrecognizedSbbException, InvalidArgumentException, ManagementException
id
- 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.java.lang.NullPointerException
- if id
is null
.UnrecognizedSbbException
- if id
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
- if the identified SBB participates in this service
but does not define a usage parameters interface.ManagementException
- if the values of the usage parameters could not be
reset 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.public void close() throws ManagementException
ManagementException
- if the service usage MBean could not be closed by the SLEE
due to a system-level failure.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |