com.opencloud.slee.resources.insis.management

Interface INServiceRefManagementMBean

All Superinterfaces:

ServiceRefManagementMBean

public interface INServiceRefManagementMBean
extends ServiceRefManagementMBean

The INServiceRefManagementMBean provides additional IN-specific management operations for SIS service refs created in a SIS RA entity.

Field Summary

Fields inherited from interface com.opencloud.slee.resources.sis.management.ServiceRefManagementMBean

SIS_MANAGEMENT_TYPE

Method Summary

Modifier and Type	Method and Description
String	getApplicationContext(ServiceRefID serviceRefID) Get the application context that the service will be invoked with.
String	getAssistingDialogApplicationContext(ServiceRefID serviceRefID) Get the application context that the service will be invoked with for assisting dialogs.
CompositeData	getDescriptor(ServiceRefID serviceRefID) Get information about a service reference in the SIS.
String[]	getSupportedApplicationContexts() Get the list of supported application contexts that may be configured for a service reference.
void	setApplicationContext(ServiceRefID serviceRefID, String appContextName) Set the application context that the service will be invoked with.
void	setAssistingDialogApplicationContext(ServiceRefID serviceRefID, String appContextName) Set the application context that the service will be invoked with for assisting dialogs.

Methods inherited from interface com.opencloud.slee.resources.sis.management.ServiceRefManagementMBean

createExternalPlatform, createExternalServiceRef, createLocalServiceRef, getDefaultTimeout, getDependencies, getExternalPlatformMBean, getExternalPlatforms, getReferringComponents, getServiceRefs, getStaticChargingPriority, removeExternalPlatform, removeServiceRef, replaceServiceRef, replaceServiceRef, setDefaultTimeout, setStaticChargingPriority

Method Detail

setApplicationContext

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

Set the 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:

getApplicationContext(ServiceRefID), getSupportedApplicationContexts()

getApplicationContext

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

Get the 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:

setApplicationContext(ServiceRefID, String)

setAssistingDialogApplicationContext

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

Set the 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:

getApplicationContext(ServiceRefID), getSupportedApplicationContexts()

getAssistingDialogApplicationContext

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

Get the 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:

setApplicationContext(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

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.

Specified by:

getDescriptor in interface ServiceRefManagementMBean

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.