javax.slee.management

Interface ServiceManagementMBean

public interface ServiceManagementMBean

The ServiceManagementMBean interface defines Service-related management operations. Using the ServiceManagementMBean a management client may get or change the operational states of Services, and get the set of services that are in a particular state.

The JMX Object Name of a ServiceManagementMBean object is specified by the OBJECT_NAME constant. The Object Name can also be obtained by a management client via the SleeManagementMBean.getServiceManagementMBean() method.

Field Summary

Fields

Modifier and Type	Field and Description
static String	OBJECT_NAME The JMX Object Name string of the SLEE Service Management MBean, equal to the string "javax.slee.management:name=ServiceManagement".
static String	SERVICE_STATE_CHANGE_NOTIFICATION_TYPE The notification type of ServiceStateChange notifications emitted by this MBean.

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(ServiceID id) Activate a Service.
void	activate(ServiceID[] ids) Activate a set of Services.
void	deactivate(ServiceID id) Deactivate a Service.
void	deactivate(ServiceID[] ids) Deactivate a set of Services.
void	deactivateAndActivate(ServiceID[] deactivateIDs, ServiceID[] activateIDs) Deactivate one set of Services and activate another set of Services.
void	deactivateAndActivate(ServiceID deactivateID, ServiceID activateID) Deactivate one Service and activate another Service.
ServiceID[]	getServices(ServiceState state) Get the set of services that are in a particular state.
ObjectName	getServiceUsageMBean(ServiceID id) Get the JMX Object Name of a ServiceUsageMBean object for a Service.
ServiceState	getState(ServiceID id) Get the current state of a Service.

Field Detail

OBJECT_NAME

static final String OBJECT_NAME

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

Since:

SLEE 1.1

See Also:

Constant Field Values

SERVICE_STATE_CHANGE_NOTIFICATION_TYPE

static final String SERVICE_STATE_CHANGE_NOTIFICATION_TYPE

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

Since:

SLEE 1.1

See Also:

Constant Field Values

Method Detail

getState

ServiceState getState(ServiceID id)
                      throws NullPointerException,
                             UnrecognizedServiceException,
                             ManagementException

Get the current state of a Service.

Parameters:

id - the component identifier of the Service.

Returns:

the current state of the Service.

Throws:

NullPointerException - if id is null.

UnrecognizedServiceException - if id is not a recognizable ServiceID for the SLEE or it does not correspond with a Service installed in the SLEE.

ManagementException - if the state of the Service could not be obtained due to a system-level failure.

getServices

ServiceID[] getServices(ServiceState state)
                        throws NullPointerException,
                               ManagementException

Get the set of services that are in a particular state.

Parameters:

state - the required state.

Returns:

an array of ServiceID objects identifying the services that are in the specified state.

Throws:

NullPointerException - if state is null.

ManagementException - if the set of services could not be obtained due to a system-level failure.

activate

void activate(ServiceID id)
              throws NullPointerException,
                     UnrecognizedServiceException,
                     InvalidStateException,
                     InvalidLinkNameBindingStateException,
                     ManagementException

Activate a Service. The Service must currently be in the ServiceState.INACTIVE state, and transitions to ServiceState.ACTIVE state during this method invocation.

Parameters:

id - the component identifier of the Service.

Throws:

NullPointerException - if id is null.

UnrecognizedServiceException - if id is not a recognizable ServiceID for the SLEE or it does not correspond with a Service installed in the SLEE.

InvalidStateException - if the current state of the Service is not ServiceState.INACTIVE.

InvalidLinkNameBindingStateException - if a resource adaptor entity link name binding required by an SBB in the Service does not exist or is bound to a resource adaptor entity that does not implement the resource adaptor type expected by the SBB.

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

activate

void activate(ServiceID[] ids)
              throws NullPointerException,
                     InvalidArgumentException,
                     UnrecognizedServiceException,
                     InvalidStateException,
                     InvalidLinkNameBindingStateException,
                     ManagementException

Activate a set of Services. All Services in the set must currently be in the ServiceState.INACTIVE state, and transition to ServiceState.ACTIVE state during this method invocation.

Parameters:

ids - a set of component identifiers of the Services to be activated.

Throws:

NullPointerException - if ids is null.

InvalidArgumentException - if ids is zero-length, or contains null or duplicate elements.

UnrecognizedServiceException - if any member of ids is not a recognizable ServiceID for the SLEE or does not correspond with a Service installed in the SLEE.

InvalidStateException - if the current state of any of the Services identified by ids is not ServiceState.INACTIVE.

InvalidLinkNameBindingStateException - if a resource adaptor entity link name binding required by an SBB in any of the Services does not exist or is bound to a resource adaptor entity that does not implement the resource adaptor type expected by the SBB.

ManagementException - if the state of any Service could not be changed due to a system-level failure. In the case of such an error the state of all Services identified in ids remains unchanged.

deactivate

void deactivate(ServiceID id)
                throws NullPointerException,
                       UnrecognizedServiceException,
                       InvalidStateException,
                       ManagementException

Deactivate a Service. The Service must currently be in the ServiceState.ACTIVE state, and transitions to ServiceState.STOPPING state during this method invocation.

Parameters:

id - the component identifier of the Service.

Throws:

NullPointerException - if id is null.

UnrecognizedServiceException - if id is not a recognizable ServiceID for the SLEE or it does not correspond with a Service installed in the SLEE.

InvalidStateException - if the current state of the Service is not ServiceState.ACTIVE.

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

deactivate

void deactivate(ServiceID[] ids)
                throws NullPointerException,
                       InvalidArgumentException,
                       UnrecognizedServiceException,
                       InvalidStateException,
                       ManagementException

Deactivate a set of Services. All Services in the set must currently be in the ServiceState.ACTIVE state, and transition to ServiceState.STOPPING state during this method invocation.

Parameters:

ids - a set of component identifiers of Services to be deactivated.

Throws:

NullPointerException - if ids is null.

InvalidArgumentException - if ids is zero-length, or contains null or duplicate elements.

UnrecognizedServiceException - if any member of ids is not a recognizable ServiceID for the SLEE or does not correspond with a Service installed in the SLEE.

InvalidStateException - if the current state of any of the Services identified by ids is not ServiceState.ACTIVE.

ManagementException - if the state of any Service could not be changed due to a system-level failure. In the case of such an error the state of all Services identified in ids remains unchanged.

deactivateAndActivate

void deactivateAndActivate(ServiceID deactivateID,
                         ServiceID activateID)
                           throws NullPointerException,
                                  InvalidArgumentException,
                                  UnrecognizedServiceException,
                                  InvalidStateException,
                                  InvalidLinkNameBindingStateException,
                                  ManagementException

Deactivate one Service and activate another Service. The first Service must currently be in the ServiceState.ACTIVE state, and transitions to ServiceState.STOPPING state during this method invocation. The second Service must be in the ServiceState.INACTIVE state and transitions to the ServiceState.ACTIVE state during this method invocation.

Parameters:

deactivateID - the component identifier of the Service to be deactivated.

activateID - the component identifier of the Service to be activated.

Throws:

NullPointerException - if either argument is null.

InvalidArgumentException - if deactivateID and activateID identify the same Service.

UnrecognizedServiceException - if either argument is not a recognizable ServiceID for the SLEE or does not correspond with a Service installed in the SLEE.

InvalidStateException - if the current state of the Service identified by deactivateID is not ServiceState.ACTIVE or the the current state of the Service identified by activateID is not ServiceState.INACTIVE.

InvalidLinkNameBindingStateException - if a resource adaptor entity link name binding required by an SBB in the activating Service does not exist or is bound to a resource adaptor entity that does not implement the resource adaptor type expected by the SBB.

ManagementException - if the state of either Service could not be changed due to a system-level failure. In the case of such an error the state of both Services remains unchanged.

deactivateAndActivate

void deactivateAndActivate(ServiceID[] deactivateIDs,
                         ServiceID[] activateIDs)
                           throws NullPointerException,
                                  InvalidArgumentException,
                                  UnrecognizedServiceException,
                                  InvalidStateException,
                                  InvalidLinkNameBindingStateException,
                                  ManagementException

Deactivate one set of Services and activate another set of Services. All Services in the first set must currently be in the ServiceState.ACTIVE state, and transition to ServiceState.STOPPING state during this method invocation. All Services in the second set must be in the ServiceState.INACTIVE state and transition to the ServiceState.ACTIVE state during this method invocation.

Parameters:

deactivateIDs - a set of component identifiers of Services to be deactivated.

activateIDs - a set of component identifiers of Services to be activated.

Throws:

NullPointerException - if either argument is null.

InvalidArgumentException - if either argument is zero-length, contains null or duplicate elements, or a Service identified by a a component identifier in deactivateIDs is the same as a Service identified by a component identifier in activateIDs.

UnrecognizedServiceException - if any member of deactivateIDs or activateIDs is not a recognizable ServiceID for the SLEE or does not correspond with a Service installed in the SLEE.

InvalidStateException - if the current state of any of the Services identified by deactivateIDs is not ServiceState.ACTIVE or the the current state of any of the Services identified by activateIDs is not ServiceState.INACTIVE.

InvalidLinkNameBindingStateException - if a resource adaptor entity link name binding required by an SBB in any of the activating Services does not exist or is bound to a resource adaptor entity that does not implement the resource adaptor type expected by the SBB.

ManagementException - if the state of any of the Services could not be changed due to a system-level failure. In the case of such an error the state of all Services identified in deactivateIDs and activateIDs remains unchanged.

getServiceUsageMBean

ObjectName getServiceUsageMBean(ServiceID id)
                                throws NullPointerException,
                                       UnrecognizedServiceException,
                                       ManagementException

Get the JMX Object Name of a ServiceUsageMBean object for a Service.

The JMX Object name of the Service Usage MBean is composed of at least:

• the base name which specifies the domain and type of the MBean
• the ServiceUsageMBean.SERVICE_NAME_KEY property, with a value equal to id.getName()
• the ServiceUsageMBean.SERVICE_VENDOR_KEY property, with a value equal to id.getVendor()
• the ServiceUsageMBean.SERVICE_VERSION_KEY property, with a value equal to id.getVersion()

Parameters:

id - the component identifier of the Service.

Returns:

the Object Name of a ServiceUsageMBean object for the specified Service.

Throws:

NullPointerException - if id is null.

UnrecognizedServiceException - if id is not a recognizable ServiceID for the SLEE or it does not correspond with a Service installed in the SLEE.

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