com.opencloud.slee.resources.sis.management

Interface ServiceRefManagementMBean

public interface ServiceRefManagementMBean

The ServiceRefManagementMBean provides management operations for creating, removing, viewing, and configuring SIS service references installed in a SIS RA entity.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SIS_MANAGEMENT_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
ObjectName	createExternalPlatform(String name, ExternalAddressSelectionMode selectionMode) Create an external platform definition in the SIS.
void	createExternalServiceRef(String name, ExternalPlatformID extPlatformID) Create an external service reference in the SIS.
void	createLocalServiceRef(String name, ServiceID serviceID) Create a local service reference in the SIS.
long	getDefaultTimeout(ServiceRefID serviceRefID) Get the default invocation timeout for a service reference.
Object[]	getDependencies(ServiceRefID serviceRefID) Get the set of components that a given service reference component depends on.
CompositeData	getDescriptor(ServiceRefID serviceRefID) Get information about a service reference in the SIS.
ObjectName	getExternalPlatformMBean(ExternalPlatformID extPlatformID) Get the JMX Object Name for an external platform definition.
ExternalPlatformID[]	getExternalPlatforms() Get the component identifiers of all external platform definitions in the SIS.
String	getINApplicationContext(ServiceRefID serviceRefID) Get the IN application context that the service will be invoked with.
String	getINAssistingDialogApplicationContext(ServiceRefID serviceRefID) Get the IN application context that the service will be invoked with for assisting dialogs.
SISComponent[]	getReferringComponents(ServiceRefID serviceRefID) Get the set of components that depend on a given service reference component.
ServiceRefID[]	getServiceRefs() Get the component identifiers of all service references in the SIS.
int	getStaticChargingPriority(ServiceRefID serviceRefID) Get the static charging priority for a service reference.
String[]	getSupportedApplicationContexts() Get the list of supported application contexts that may be configured for a service reference.
void	removeExternalPlatform(ExternalPlatformID extPlatformID) Remove an external platform definition from the SIS.
void	removeServiceRef(ServiceRefID serviceRefID) Remove a service reference from the SIS.
void	replaceServiceRef(String name, ExternalPlatformID extPlatformID) Replace a service reference in the SIS with a new external service reference.
void	replaceServiceRef(String name, ServiceID serviceID) Replace a service reference in the SIS with a new local service reference.
void	setDefaultTimeout(ServiceRefID serviceRefID, long timeout) Set the default invocation timeout for a service reference.
void	setINApplicationContext(ServiceRefID serviceRefID, String appContextName) Set the IN application context that the service will be invoked with.
void	setINAssistingDialogApplicationContext(ServiceRefID serviceRefID, String appContextName) Set the IN application context that the service will be invoked with for assisting dialogs.
void	setStaticChargingPriority(ServiceRefID serviceRefID, int priority) Set the static charging priority for a service reference.

Field Detail

SIS_MANAGEMENT_TYPE

static final String SIS_MANAGEMENT_TYPE

See Also:

Constant Field Values

Method Detail

createLocalServiceRef

void createLocalServiceRef(String name,
                         ServiceID serviceID)
                           throws NullPointerException,
                                  AlreadyDeployedException,
                                  DeploymentException,
                                  ManagementException

Create a local service reference in the SIS.

Parameters:

name - the name for the new service reference. The name is used in compositions to identify the service to be invoked.

serviceID - the SLEE component ID of the local service.

Throws:

NullPointerException - if either argument is null.

AlreadyDeployedException - if the specified name is already in use in the SIS RA entity.

DeploymentException - if the service reference cannot be created due to a missing dependency.

ManagementException - if the service reference could not be created due to a system-level-failure.

createExternalServiceRef

void createExternalServiceRef(String name,
                            ExternalPlatformID extPlatformID)
                              throws NullPointerException,
                                     AlreadyDeployedException,
                                     DeploymentException,
                                     ManagementException

Create an external service reference in the SIS.

Parameters:

name - the name for the new service reference. The name is used in compositions to identify the service to be invoked.

extPlatformID - the component identifier of the external platform definition where the service is located.

Throws:

NullPointerException - if either argument is null.

AlreadyDeployedException - if the specified name is already in use in the SIS RA entity.

DeploymentException - if the service reference cannot be created due to a missing dependency.

ManagementException - if the service reference could not be created due to a system-level-failure.

replaceServiceRef

void replaceServiceRef(String name,
                     ServiceID serviceID)
                       throws NullPointerException,
                              DeploymentException,
                              ManagementException

Replace a service reference in the SIS with a new local service reference. If a service reference with the specified name exists in the SIS then it is replaced with the new service reference. If a service reference with the specified name does not exist, then this method behaves in the same way as createLocalServiceRef(String, ServiceID).

Parameters:

name - the name of the service reference to be replaced.

serviceID - the SLEE component ID of the local service.

Throws:

NullPointerException - if either argument is null.

DeploymentException - if the service reference cannot be created due to a missing dependency.

ManagementException - if the service reference could not be created due to a system-level-failure.

replaceServiceRef

void replaceServiceRef(String name,
                     ExternalPlatformID extPlatformID)
                       throws NullPointerException,
                              DeploymentException,
                              ManagementException

Replace a service reference in the SIS with a new external service reference. If a service reference with the specified name exists in the SIS then it is replaced with the new service reference. If a service reference with the specified name does not exist, then this method behaves in the same way as createExternalServiceRef(String, ExternalPlatformID).

Parameters:

name - the name of the service reference to be replaced.

extPlatformID - the component identifier of the external platform definition where the service is located.

Throws:

NullPointerException - if either argument is null.

DeploymentException - if the service reference cannot be created due to a missing dependency.

ManagementException - if the service reference could not be created due to a system-level-failure.

removeServiceRef

void removeServiceRef(ServiceRefID serviceRefID)
                      throws NullPointerException,
                             UnrecognizedComponentException,
                             DependencyException,
                             ManagementException

Remove a service reference from the SIS.

Parameters:

serviceRefID - the component identifier of the service reference to remove.

Throws:

NullPointerException - if serviceRefID is null.

UnrecognizedComponentException - if serviceRefID does not match a current service reference.

DependencyException - if the service reference cannot currently be removed due to a composition dependency on it.

ManagementException - if the service reference could not be removed due to a system-level failure.

setDefaultTimeout

void setDefaultTimeout(ServiceRefID serviceRefID,
                     long timeout)
                       throws NullPointerException,
                              IllegalArgumentException,
                              UnrecognizedComponentException,
                              ManagementException

Set the default invocation timeout for a service reference. This is the period of time the SIS will wait for a response from the service, when required, before assuming no response is forthcoming.

The minimum timeout is 100ms. A value of zero may also be specified to indicate that the SIS's global default service timeout should be used for this service.

Parameters:

serviceRefID - the component identifier of the service reference to update.

timeout - the timeout value, measured in milliseconds. Must be either 0 or a value equal to or greater than 100

Throws:

NullPointerException - if serviceRefID is null.

IllegalArgumentException - if timeout is invalid.

UnrecognizedComponentException - if serviceRefID does not match a current service reference.

ManagementException - if the service reference could not be updated due to a system-level failure.

See Also:

getDefaultTimeout(com.opencloud.slee.resources.sis.components.ServiceRefID)

getDefaultTimeout

long getDefaultTimeout(ServiceRefID serviceRefID)
                       throws NullPointerException,
                              UnrecognizedComponentException,
                              ManagementException

Get the default invocation timeout for a service reference.

Parameters:

serviceRefID - the component identifier of the service reference to interrogate.

Returns:

the default timeout.

Throws:

NullPointerException - if serviceRefID is null.

UnrecognizedComponentException - if serviceRefID does not match a current service reference.

ManagementException - if the service reference could not be interrogated due to a system-level failure

See Also:

setDefaultTimeout(com.opencloud.slee.resources.sis.components.ServiceRefID, long)

setStaticChargingPriority

void setStaticChargingPriority(ServiceRefID serviceRefID,
                             int priority)
                               throws NullPointerException,
                                      UnrecognizedComponentException,
                                      ManagementException

Set the static charging priority for a service reference. This charging priority is used in service compositions that choose to handle IN charging message interactions using the STATIC_PRIORITIES option.

Parameters:

serviceRefID - the component identifier of the service reference to update.

priority - the static charging priority. A priority X is a higher priority than priority Y if X > Y.

Throws:

NullPointerException - if serviceRefID is null.

UnrecognizedComponentException - if serviceRefID does not match a current service reference.

ManagementException - if the service reference could not be updated due to a system-level failure.

See Also:

getStaticChargingPriority(com.opencloud.slee.resources.sis.components.ServiceRefID)

getStaticChargingPriority

int getStaticChargingPriority(ServiceRefID serviceRefID)
                              throws NullPointerException,
                                     UnrecognizedComponentException,
                                     ManagementException

Get the static charging priority for a service reference. This charging priority is used in service compositions that choose to handle IN charging message interactions using the STATIC_PRIORITIES option.

Parameters:

serviceRefID - the component identifier of the service reference to interrogate.

Returns:

the static charging priority.

Throws:

NullPointerException - if serviceRefID is null.

UnrecognizedComponentException - if serviceRefID does not match a current service reference.

ManagementException - if the service reference could not be interrogated due to a system-level failure

See Also:

setStaticChargingPriority(com.opencloud.slee.resources.sis.components.ServiceRefID, int)

setINApplicationContext

void setINApplicationContext(ServiceRefID serviceRefID,
                           String appContextName)
                             throws NullPointerException,
                                    UnrecognizedComponentException,
                                    InvalidArgumentException,
                                    ManagementException

Set the IN application context that the service will be invoked with. If this application context is set to a non-null value, the service will always be invoked via a dialog with this application context rather than the application context of the triggering network dialog.

Parameters:

serviceRefID - the component identifier of the service reference to update.

appContextName - the TCAP application context name. The names of supported application context can be obtained via getSupportedApplicationContexts().

Throws:

NullPointerException - if serviceRefID is null.

UnrecognizedComponentException - if serviceRefID does not match a current service reference.

IllegalArgumentException - if appContextName is non-null and does not match a known application context.

ManagementException - if the service reference could not be updated due to a system-level failure.

InvalidArgumentException

See Also:

getINApplicationContext(ServiceRefID), getSupportedApplicationContexts()

getINApplicationContext

String getINApplicationContext(ServiceRefID serviceRefID)
                               throws NullPointerException,
                                      UnrecognizedComponentException,
                                      ManagementException

Get the IN application context that the service will be invoked with.

Parameters:

serviceRefID - the component identifier of the service reference to interrogate.

Returns:

the TCAP application context name, or null if none has been set.

Throws:

NullPointerException - if serviceRefID is null.

UnrecognizedComponentException - if serviceRefID does not match a current service reference.

ManagementException - if the service reference could not be interrogated due to a system-level failure

See Also:

setINApplicationContext(ServiceRefID, String)

setINAssistingDialogApplicationContext

void setINAssistingDialogApplicationContext(ServiceRefID serviceRefID,
                                          String appContextName)
                                            throws NullPointerException,
                                                   UnrecognizedComponentException,
                                                   InvalidArgumentException,
                                                   ManagementException

Set the IN application context that the service will be invoked with for assisting dialogs. If this application context is set to a non-null value, the service will always be invoked via a dialog with this application context rather than the application context of the triggering network dialog.

Parameters:

serviceRefID - the component identifier of the service reference to update.

appContextName - the TCAP application context name. The names of supported application context can be obtained via getSupportedApplicationContexts().

Throws:

NullPointerException - if serviceRefID is null.

UnrecognizedComponentException - if serviceRefID does not match a current service reference.

IllegalArgumentException - if appContextName is non-null and does not match a known application context.

ManagementException - if the service reference could not be updated due to a system-level failure.

InvalidArgumentException

See Also:

getINApplicationContext(ServiceRefID), getSupportedApplicationContexts()

getINAssistingDialogApplicationContext

String getINAssistingDialogApplicationContext(ServiceRefID serviceRefID)
                                              throws NullPointerException,
                                                     UnrecognizedComponentException,
                                                     ManagementException

Get the IN application context that the service will be invoked with for assisting dialogs.

Parameters:

serviceRefID - the component identifier of the service reference to interrogate.

Returns:

the TCAP application context name, or null if none has been set.

Throws:

NullPointerException - if serviceRefID is null.

UnrecognizedComponentException - if serviceRefID does not match a current service reference.

ManagementException - if the service reference could not be interrogated due to a system-level failure

See Also:

setINApplicationContext(ServiceRefID, String)

getSupportedApplicationContexts

String[] getSupportedApplicationContexts()
                                         throws ManagementException

Get the list of supported application contexts that may be configured for a service reference.

Returns:

a list of application context names.

Throws:

ManagementException

getServiceRefs

ServiceRefID[] getServiceRefs()
                              throws ManagementException

Get the component identifiers of all service references in the SIS.

Returns:

the identifiers of all service references in the SIS.

Throws:

ManagementException - if the service references could not be obtained due to a system-level failure.

getDescriptor

CompositeData getDescriptor(ServiceRefID serviceRefID)
                            throws NullPointerException,
                                   UnrecognizedComponentException,
                                   ManagementException

Get information about a service reference in the SIS.

This method returns a CompositeData type with the following fields:

Field	Open Type	Description
name	String	The name of the service reference.
type	String	The type of the service reference, either "local" or "external".
serviceName	String	The name component of the referenced service component identifier. This field is only present if this is a local service reference.
serviceVendor	String	The vendor component of the referenced service component identifier. This field is only present if this is a local service reference.
serviceVersion	String	The version component of the referenced service component identifier. This field is only present if this is a local service reference.
extPlatformName	String	The name component of the referenced external platform identifier. This field is only present if this is an external service referenced.
defaultTimeout	Long	The default timeout configured for the service.
chargingPriority	Integer	The static charging priority configured for the service.
inApplicationContext	String	The IN application context that the service will be invoked with. If empty then the triggering application context will be used.
inAssistingDialogApplicationContext	String	The IN application context that the service will be invoked with for assisting dialogs. If empty then the triggering application context will be used.

Parameters:

serviceRefID - the component identifier of the service reference.

Returns:

a CompositeData object as described above.

Throws:

NullPointerException - if serviceRefID is null.

UnrecognizedComponentException - if serviceRefID does not match a current service reference.

ManagementException - if the service reference descriptor could not be obtained due to a system-level failure.

getDependencies

Object[] getDependencies(ServiceRefID serviceRefID)
                         throws NullPointerException,
                                UnrecognizedComponentException,
                                ManagementException

Get the set of components that a given service reference component depends on. A service reference component may depend on:

• local services
• external platforms

Parameters:

serviceRefID - the component identifier of the service reference.

Returns:

the set of dependent components.

Throws:

NullPointerException - if id is null

UnrecognizedComponentException - if id does not match an installed component

ManagementException - if the dependencies could not be retrieved due to a system-level failure.

getReferringComponents

SISComponent[] getReferringComponents(ServiceRefID serviceRefID)
                                      throws NullPointerException,
                                             UnrecognizedComponentException,
                                             ManagementException

Get the set of components that depend on a given service reference component. A service reference component may be referred to by:

• triggers
• compositions

Parameters:

serviceRefID - the component identifier of the service reference.

Returns:

the set of referring components.

Throws:

NullPointerException - if id is null.

UnrecognizedComponentException - if id does not match an installed component.

ManagementException - if the referring components could not be retrieved due to a system-level failure.

createExternalPlatform

ObjectName createExternalPlatform(String name,
                                ExternalAddressSelectionMode selectionMode)
                                  throws NullPointerException,
                                         AlreadyDeployedException,
                                         ManagementException

Create an external platform definition in the SIS.

Parameters:

name - the name for the new external platform. The name is used in external service references to identify the external platform.

selectionMode - the mode which the SIS will use to select an address for the external service each time it is invoked.

Returns:

the Object Name of an ExternalPlatformManagementMBean used to manage the external platform definition.

Throws:

NullPointerException - if either argument is null.

AlreadyDeployedException - if the specified name is already in use in the SIS RA entity.

ManagementException - if the service reference could not be created due to a system-level-failure.

removeExternalPlatform

void removeExternalPlatform(ExternalPlatformID extPlatformID)
                            throws NullPointerException,
                                   UnrecognizedComponentException,
                                   DependencyException,
                                   ManagementException

Remove an external platform definition from the SIS.

Parameters:

extPlatformID - the component identifier of the external platform definition to remove.

Throws:

NullPointerException - if extPlatformID is null.

UnrecognizedComponentException - if extPlatformID does not match a current external platform.

DependencyException - if the external platform definition cannot currently be removed due to an external service reference dependency on it.

ManagementException - if the external platform definition could not be removed due to a system-level failure.

getExternalPlatforms

ExternalPlatformID[] getExternalPlatforms()
                                          throws ManagementException

Get the component identifiers of all external platform definitions in the SIS.

Returns:

the identifiers of all external platform definitions in the SIS.

Throws:

ManagementException - if the external platform definitions could not be obtained due to a system-level failure.

getExternalPlatformMBean

ObjectName getExternalPlatformMBean(ExternalPlatformID extPlatformID)
                                    throws NullPointerException,
                                           UnrecognizedComponentException,
                                           ManagementException

Get the JMX Object Name for an external platform definition.

Parameters:

extPlatformID - the component identifier of the external platform definition.

Returns:

the Object Name of an ExternalPlatformManagementMBean used to manage the external platform definition.

Throws:

NullPointerException - if extPlatformID is null.

UnrecognizedComponentException - if extPlatformID does not match a current external platform.

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