org.mobicents.slee.management

Interface ServiceManagementExtMBean

All Superinterfaces:

javax.slee.management.ServiceManagementMBean

public interface ServiceManagementExtMBean
extends javax.slee.management.ServiceManagementMBean

Extends ServiceManagementMBean, adding capability to retrieve and update a Service's Sbb configuration.

Author:

Eduardo Martins

Field Summary

Fields inherited from interface javax.slee.management.ServiceManagementMBean

OBJECT_NAME, SERVICE_STATE_CHANGE_NOTIFICATION_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
ConfigProperties	getConfigurationProperties(javax.slee.ServiceID serviceID, javax.slee.SbbID sbbID) Get the configuration properties, and their default values if any, for the specified Service's SBB.
void	updateConfigurationProperties(javax.slee.ServiceID serviceID, javax.slee.SbbID sbbID, ConfigProperties properties) Reconfigure a service with new configuration properties.

Methods inherited from interface javax.slee.management.ServiceManagementMBean

activate, activate, deactivate, deactivate, deactivateAndActivate, deactivateAndActivate, getServices, getServiceUsageMBean, getState

Method Detail

getConfigurationProperties

ConfigProperties getConfigurationProperties(javax.slee.ServiceID serviceID,
                                          javax.slee.SbbID sbbID)
                                            throws NullPointerException,
                                                   javax.slee.UnrecognizedSbbException,
                                                   javax.slee.UnrecognizedServiceException,
                                                   javax.slee.management.ManagementException

Get the configuration properties, and their default values if any, for the specified Service's SBB.

Parameters:

serviceID - the identifier of the service.

sbbID - the identifier of the SBB.

Returns:

a ConfigProperties object containing the configuration properties of the Service's SBB.

Throws:

NullPointerException - if either argument is null.

javax.slee.UnrecognizedSbbException - if sbbID 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 identified by serviceID.

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

javax.slee.management.ManagementException - if the configuration properties could not be obtained due to a system-level failure.

updateConfigurationProperties

void updateConfigurationProperties(javax.slee.ServiceID serviceID,
                                 javax.slee.SbbID sbbID,
                                 ConfigProperties properties)
                                   throws NullPointerException,
                                          javax.slee.UnrecognizedSbbException,
                                          javax.slee.UnrecognizedServiceException,
                                          InvalidConfigurationException,
                                          javax.slee.management.ManagementException

Reconfigure a service with new configuration properties. Properties are specified using a ConfigProperties object.

Only properties that need updating need to be included in the ConfigProperties object.

The management client must ensure that all properties included in the ConfigProperties object have a non-null value before passing it to this method. The sbbVerifyConfiguration method is invoked on a SBB object to test validity of configuration.

An org.mobicents.slee.ServiceConfigurationUpdateEvent#org.mobicents.slee# 1.1 event is fired in the Service's Activity Context, which may be used to apply some service logic.

Parameters:

serviceID - the identifier of the service.

sbbID - the identifier of the SBB.

properties - the values of configuration properties to be updated for the Service's SBB.

Throws:

NullPointerException - if either argument is null.

javax.slee.UnrecognizedSbbException - if sbbID 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 identified by serviceID.

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

InvalidConfigurationException - if one or more of the configuration properties has a null value, or if the configuration properties were not valid for the SBB as determined by the sbbVerifyConfiguration method.

javax.slee.management.ManagementException - if the Service's SBB configuration properties could not be updated due to a system-level failure.