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.

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


Field Summary
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 getServiceManagementMBean()
          Get the JMX Object Name of the SLEE's ServiceManagementMBean object.
 SleeState getState()
          Get the current operational state of the SLEE.
 javax.management.ObjectName getTraceMBean()
          Get the JMX Object Name of the SLEE's TraceMBean object.
 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

SLEE_STATE_CHANGE_NOTIFICATION_TYPE

public 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".
Method Detail

getState

public 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

public 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

public 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

public 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

public javax.management.ObjectName getDeploymentMBean()
Get the JMX Object Name of the SLEE's DeploymentMBean object.
Returns:
the Object Name of the DeploymentMBean object.

getServiceManagementMBean

public javax.management.ObjectName getServiceManagementMBean()
Get the JMX Object Name of the SLEE's ServiceManagementMBean object.
Returns:
the Object Name of the ServiceManagementMBean object.

getProfileProvisioningMBean

public javax.management.ObjectName getProfileProvisioningMBean()
Get the JMX Object Name of the SLEE's ProfileProvisioningMBean object.
Returns:
the Object Name of the ProfileProvisioningMBean object.

getTraceMBean

public javax.management.ObjectName getTraceMBean()
Get the JMX Object Name of the SLEE's TraceMBean object.
Returns:
the Object Name of the TraceMBean object.

getAlarmMBean

public javax.management.ObjectName getAlarmMBean()
Get the JMX Object Name of the SLEE's AlarmMBean object.
Returns:
the Object Name of the AlarmMBean object.