javax.slee.management
Interface SleeManagementMBean

public interface SleeManagementMBean

The SleeManagementMBean interface defines the central management interface for the SLEE. This interface provides access a management client with the JMX Object Names of other SLEE management MBeans, and allows the operational state of the SLEE to be changed.

Note: As of SLEE 1.1, the JMX Object Names of the MBeans defined by the SLEE specification have been standardized. Each MBean interface defines one or more constants that specify the name and properties of the MBean's Object Name.

Notifications
Every time the operational state of the SLEE changes, the SleeManagementMBean object must emit a SleeStateChangeNotification. Therefore it is required that the SleeManagementMBean object implement the javax.management.NotificationBroadcaster interface.

Field Summary

static java.lang.String	OBJECT_NAME The JMX Object Name string of the SLEE Management MBean, equal to the string "javax.slee.management:name=SleeManagement".
static java.lang.String	SLEE_STATE_CHANGE_NOTIFICATION_TYPE The notification type of SleeStateChange notifications emitted by this MBean.

Method Summary

javax.management.ObjectName	getAlarmMBean() Get the JMX Object Name of the SLEE's AlarmMBean object.
javax.management.ObjectName	getDeploymentMBean() Get the JMX Object Name of the SLEE's DeploymentMBean object.
javax.management.ObjectName	getProfileProvisioningMBean() Get the JMX Object Name of the SLEE's ProfileProvisioningMBean object.
javax.management.ObjectName	getResourceManagementMBean() Get the JMX Object Name of the SLEE's ResourceManagementMBean object.
javax.management.ObjectName	getServiceManagementMBean() Get the JMX Object Name of the SLEE's ServiceManagementMBean object.
java.lang.String	getSleeName() Get the name of the SLEE implementation.
java.lang.String	getSleeVendor() Get the vendor of the SLEE implementation.
java.lang.String	getSleeVersion() Get the version of the SLEE implementation.
SleeState	getState() Get the current operational state of the SLEE.
java.lang.String[]	getSubsystems() Get the names of the SLEE internal components or subsystems defined by the SLEE implementation.
javax.management.ObjectName	getTraceMBean() Get the JMX Object Name of the SLEE's TraceMBean object.
javax.management.ObjectName	getUsageMBean(java.lang.String subsystemName) Get the JMX Object Name of a UsageMBean object that provides management access to the unnamed usage parameter set for the specified SLEE internal component or subsystem.
javax.management.ObjectName	getUsageMBean(java.lang.String subsystemName, java.lang.String paramSetName) Get the JMX Object Name of a UsageMBean object that provides management access to the named usage parameter set for the specified SLEE internal component or subsystem.
javax.management.ObjectName	getUsageNotificationManagerMBean(java.lang.String subsystemName) Get the JMX Object Name of a UsageNotificationManagerMBean that provides management access to the usage notification manager for the specified SLEE internal component or subsystem.
java.lang.String[]	getUsageParameterSets(java.lang.String subsystemName) Get the names of the usage parameter sets that the specified SLEE internal component or subsystem is permitted to use.
boolean	hasUsage(java.lang.String subsystemName) Determine if usage information is available for the specified SLEE internal component or subsystem.
void	shutdown() Shutdown and terminate all SLEE processes related to this server image.
void	start() Request that the SLEE's event routing subsystem be started.
void	stop() Request that the SLEE's event routing subsystem be stopped.

Field Detail

OBJECT_NAME

static final java.lang.String OBJECT_NAME

The JMX Object Name string of the SLEE Management MBean, equal to the string "javax.slee.management:name=SleeManagement".

Since:

SLEE 1.1

See Also:

Constant Field Values

SLEE_STATE_CHANGE_NOTIFICATION_TYPE

static final java.lang.String SLEE_STATE_CHANGE_NOTIFICATION_TYPE

The notification type of SleeStateChange notifications emitted by this MBean. The notification type is equal to the string "javax.slee.management.sleestatechange".

See Also:

Constant Field Values

Method Detail

getSleeName

java.lang.String getSleeName()

Get the name of the SLEE implementation. This may be a product name.

Returns:

the name of the SLEE implementation.

Since:

SLEE 1.1

getSleeVendor

java.lang.String getSleeVendor()

Get the vendor of the SLEE implementation.

Returns:

the vendor of the SLEE implementation.

Since:

SLEE 1.1

getSleeVersion

java.lang.String getSleeVersion()

Get the version of the SLEE implementation.

Returns:

the version of the SLEE implementation.

Since:

SLEE 1.1

getState

SleeState getState()
                   throws ManagementException

Get the current operational state of the SLEE.

Returns:

a SleeState object that indicates the current operational state of the SLEE.

Throws:

ManagementException - if the operatioanl state could not be determined due to a system-level failure.

start

void start()
           throws InvalidStateException,
                  ManagementException

Request that the SLEE's event routing subsystem be started. The SLEE must be in the Stopped state, and transitions to the Starting state during this method invocation. The SLEE spontaneously moves out of the Starting state when conditions dictate.

Throws:

InvalidStateException - if the SLEE is not currently in the Stopped state.

ManagementException - if the operational state of the SLEE could not be changed due to a system-level failure.

stop

void stop()
          throws InvalidStateException,
                 ManagementException

Request that the SLEE's event routing subsystem be stopped. The SLEE must be in the Running state, and transitions to the Stopping state during this method invocation. The SLEE spontaneously moves out of the Stopping state when conditions dictate.

Throws:

InvalidStateException - if the SLEE is not currently in the Running state.

ManagementException - if the operational state of the SLEE could not be changed due to a system-level failure.

shutdown

void shutdown()
              throws InvalidStateException,
                     ManagementException

Shutdown and terminate all SLEE processes related to this server image. In a distributed SLEE all nodes should terminate in response to this request. This method should never return, and does not cause the emission of a SleeStateChange notification.

Throws:

InvalidStateException - if the SLEE is not currently in the Stopped state.

ManagementException - if the operational state of the SLEE could not be changed due to a system-level failure.

getDeploymentMBean

javax.management.ObjectName getDeploymentMBean()

Get the JMX Object Name of the SLEE's DeploymentMBean object.

Returns:

the Object Name of the DeploymentMBean object.

getServiceManagementMBean

javax.management.ObjectName getServiceManagementMBean()

Get the JMX Object Name of the SLEE's ServiceManagementMBean object.

Returns:

the Object Name of the ServiceManagementMBean object.

getProfileProvisioningMBean

javax.management.ObjectName getProfileProvisioningMBean()

Get the JMX Object Name of the SLEE's ProfileProvisioningMBean object.

Returns:

the Object Name of the ProfileProvisioningMBean object.

getTraceMBean

javax.management.ObjectName getTraceMBean()

Get the JMX Object Name of the SLEE's TraceMBean object.

Returns:

the Object Name of the TraceMBean object.

getAlarmMBean

javax.management.ObjectName getAlarmMBean()

Get the JMX Object Name of the SLEE's AlarmMBean object.

Returns:

the Object Name of the AlarmMBean object.

getResourceManagementMBean

javax.management.ObjectName getResourceManagementMBean()

Get the JMX Object Name of the SLEE's ResourceManagementMBean object.

Returns:

the Object Name of the ResourceManagementMBean object.

Since:

SLEE 1.1

getSubsystems

java.lang.String[] getSubsystems()
                                 throws ManagementException

Get the names of the SLEE internal components or subsystems defined by the SLEE implementation. Internal subsystems of the SLEE implementation that generate TraceNotifications, AlarmNotifications, or UsageNotifications should be named in the return value of this method.

Subsystem names may be any vendor-defined string. The SLEE specification does not define any restrictions on the format of these names.

Returns:

the names of the SLEE internal components or subsystems defined by the SLEE implementation that may generate notifications. If the SLEE implementation does not have any internal components or subsystems that generate SLEE-defined notifications this method may return either null or a zero-length array.

Throws:

ManagementException - if the name could not obtained due to a system-level failure.

Since:

SLEE 1.1

hasUsage

boolean hasUsage(java.lang.String subsystemName)
                 throws java.lang.NullPointerException,
                        UnrecognizedSubsystemException,
                        ManagementException

Determine if usage information is available for the specified SLEE internal component or subsystem.

Parameters:

subsystemName - the name of the SLEE internal component or subsystem.

Returns:

true if the SLEE implementation provides usage information for the specified subsystem, false otherwise.

Throws:

java.lang.NullPointerException - if subsystemName is null.

UnrecognizedSubsystemException - if subsystemName does not correspond with a recognized SLEE internal component or subsystem.

ManagementException - if a system-level failure occurrs.

Since:

SLEE 1.1

getUsageParameterSets

java.lang.String[] getUsageParameterSets(java.lang.String subsystemName)
                                         throws java.lang.NullPointerException,
                                                UnrecognizedSubsystemException,
                                                InvalidArgumentException,
                                                ManagementException

Get the names of the usage parameter sets that the specified SLEE internal component or subsystem is permitted to use. Note that the names returned by this method may change over the lifetime of the SLEE.

Parameters:

subsystemName - the name of the internal component or subsystem.

Returns:

the names of the usage parameter sets that the internal component or subsystem uses.

Throws:

java.lang.NullPointerException - if subsystemName is null.

UnrecognizedSubsystemException - if subsystemName does not correspond with a recognized SLEE internal component or subsystem.

InvalidArgumentException - if the SLEE does not provide usage information for the specified subsystem.

ManagementException - if the usage parameter set names could not be obtained due to a system-level failure.

Since:

SLEE 1.1

getUsageMBean

javax.management.ObjectName getUsageMBean(java.lang.String subsystemName)
                                          throws java.lang.NullPointerException,
                                                 UnrecognizedSubsystemException,
                                                 InvalidArgumentException,
                                                 ManagementException

Get the JMX Object Name of a UsageMBean object that provides management access to the unnamed usage parameter set for the specified SLEE internal component or subsystem. The subsystem must be providing usage information, ie. hasUsage(subsystemName) returns true.

Parameters:

subsystemName - the name of the internal component or subsystem.

Returns:

the Object Name of a UsageMBean object for the subsystem.

Throws:

java.lang.NullPointerException - if subsystemName is null.

UnrecognizedSubsystemException - if subsystemName does not correspond with a recognized SLEE internal component or subsystem.

InvalidArgumentException - if usage information is not available for the specified subsystem.

ManagementException - if the Object Name could not be obtained due to a system-level failure.

Since:

SLEE 1.1

getUsageMBean

javax.management.ObjectName getUsageMBean(java.lang.String subsystemName,
                                          java.lang.String paramSetName)
                                          throws java.lang.NullPointerException,
                                                 UnrecognizedSubsystemException,
                                                 InvalidArgumentException,
                                                 UnrecognizedUsageParameterSetNameException,
                                                 ManagementException

Get the JMX Object Name of a UsageMBean object that provides management access to the named usage parameter set for the specified SLEE internal component or subsystem. The subsystem must be providing usage information, ie. hasUsage(subsystemName) returns true.

Parameters:

subsystemName - the name of the internal component or subsystem.

paramSetName - the name of the usage parameter set. The name must be one of the names returned by getUsageParameterSets(subsystemName).

Returns:

the Object Name of a UsageMBean object for the subsystem.

Throws:

java.lang.NullPointerException - if either argument is null.

UnrecognizedSubsystemException - if subsystemName does not correspond with a recognized SLEE internal component or subsystem.

InvalidArgumentException - if usage information is not available for the specified subsystem.

UnrecognizedUsageParameterSetNameException - if the named usage parameter set does not exist for the specified subsystem.

ManagementException - if the Object Name could not be obtained due to a system-level failure.

Since:

SLEE 1.1

getUsageNotificationManagerMBean

javax.management.ObjectName getUsageNotificationManagerMBean(java.lang.String subsystemName)
                                                             throws java.lang.NullPointerException,
                                                                    UnrecognizedSubsystemException,
                                                                    InvalidArgumentException,
                                                                    ManagementException

Get the JMX Object Name of a UsageNotificationManagerMBean that provides management access to the usage notification manager for the specified SLEE internal component or subsystem. The subsystem must be providing usage information, ie. hasUsage(subsystemName) returns true.

Parameters:

subsystemName - the name of the internal component or subsystem.

Returns:

the Object Name of a UsageNotificationManagerMBean object for the subsystem.

Throws:

java.lang.NullPointerException - if subsystemName is null.

UnrecognizedSubsystemException - if subsystemName does not correspond with a recognized SLEE internal component or subsystem.

InvalidArgumentException - if usage information is not available for the specified subsystem.

ManagementException - if the Object Name could not be obtained due to a system-level failure.

Since:

SLEE 1.1