com.opencloud.slee.resources.insis.management

Interface INCompositionManagementMBean

All Superinterfaces:

CompositionManagementMBean

public interface INCompositionManagementMBean
extends CompositionManagementMBean

The INCompositionManagementMBean provides additional IN-specific management operations for to SIS service composition components installed in a SIS RA entity.

Field Summary

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

SIS_MANAGEMENT_TYPE

Method Summary

Methods

Modifier and Type	Method and Description
FCIInteraction	getFCIInteraction(CompositionID id) Get the FCI interaction settings for a composition in the SIS-IN RA entity.
OnlineChargingInteraction	getOnlineChargingInteraction(CompositionID id) Get the Online Charging interaction settings for a composition in the SIS-IN RA entity.
boolean	getOptimisationsEnabled(CompositionID id) Determine if composition execution optimisations have been enabled for a composition in the SIS-IN RA entity.
ServiceRefID[]	getServiceRefs(CompositionID id) Get the service references used in the composition.
void	setFCIInteraction(CompositionID id, FCIInteraction fciInteraction) Set the FCI interaction settings for a composition in the SIS-IN RA entity.
void	setOnlineChargingInteraction(CompositionID id, OnlineChargingInteraction interaction) Set the Online Charging interaction settings for a composition in the SIS-IN RA entity.
void	setOptimisationsEnabled(CompositionID id, boolean enabled) Set the optimisations flag for a composition in the SIS-IN RA entity.

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

getComposition, getCompositions, getDebugLevel, getDependencies, getReferringComponents, install, install, isAuditLoggingEnabled, isInstalled, replace, replace, setAuditLoggingEnabled, setDebugLevel, uninstall

Method Detail

getOptimisationsEnabled

boolean getOptimisationsEnabled(CompositionID id)
                                throws NullPointerException,
                                       UnrecognizedComponentException,
                                       ManagementException

Determine if composition execution optimisations have been enabled for a composition in the SIS-IN RA entity.

Parameters:

id - the identifier for the composition.

Returns:

true if optimisations have been enabled for the composition, false otherwise.

Throws:

NullPointerException - if id is null.

UnrecognizedComponentException - if a composition with the specified ID is not found.

ManagementException - if an error occurs communicating with the management server.

See Also:

setOptimisationsEnabled(com.opencloud.slee.resources.sis.components.CompositionID, boolean)

setOptimisationsEnabled

void setOptimisationsEnabled(CompositionID id,
                           boolean enabled)
                             throws NullPointerException,
                                    UnrecognizedComponentException,
                                    ManagementException

Set the optimisations flag for a composition in the SIS-IN RA entity.

Parameters:

id - the identifier for the composition.

enabled - boolean value indicating whether optimisations should be enabled or not for the compostion.

Throws:

NullPointerException - if id is null.

UnrecognizedComponentException - if a composition with the specified ID is not found.

ManagementException - if an error occurs communicating with the management server.

See Also:

getOptimisationsEnabled(com.opencloud.slee.resources.sis.components.CompositionID)

getServiceRefs

ServiceRefID[] getServiceRefs(CompositionID id)
                              throws NullPointerException,
                                     UnrecognizedComponentException,
                                     ManagementException

Get the service references used in the composition. A valid service reference is required if setting an FCI or online charging interaction mode of "nominated service".

Parameters:

id - the identifier for the composition.

Returns:

an array of service reference component identifiers.

Throws:

NullPointerException - if id is null.

UnrecognizedComponentException - if a composition with the specified ID is not found.

ManagementException - if an error occurs communicating with the management server.

See Also:

setFCIInteraction(com.opencloud.slee.resources.sis.components.CompositionID, com.opencloud.slee.resources.sis.script.in.FCIInteraction), setOnlineChargingInteraction(com.opencloud.slee.resources.sis.components.CompositionID, com.opencloud.slee.resources.sis.script.in.OnlineChargingInteraction)

getFCIInteraction

FCIInteraction getFCIInteraction(CompositionID id)
                                 throws NullPointerException,
                                        UnrecognizedComponentException,
                                        ManagementException

Get the FCI interaction settings for a composition in the SIS-IN RA entity.

Parameters:

id - the identifier for the composition.

Returns:

the FCI interaction settings for the composition.

Throws:

NullPointerException - if id is null.

UnrecognizedComponentException - if a composition with the specified ID is not found.

ManagementException - if an error occurs communicating with the management server.

See Also:

setFCIInteraction(com.opencloud.slee.resources.sis.components.CompositionID, com.opencloud.slee.resources.sis.script.in.FCIInteraction)

setFCIInteraction

void setFCIInteraction(CompositionID id,
                     FCIInteraction fciInteraction)
                       throws NullPointerException,
                              UnrecognizedComponentException,
                              InvalidArgumentException,
                              ManagementException

Set the FCI interaction settings for a composition in the SIS-IN RA entity.

Parameters:

id - the identifier for the composition.

fciInteraction - the FCI interaction settings.

Throws:

NullPointerException - if either argument is null.

UnrecognizedComponentException - if a composition with the specified ID is not found.

InvalidArgumentException - if interaction specifies the "nominated service" mode for which the specified service alias does not exist in the composition.

ManagementException - if an error occurs communicating with the management server.

See Also:

getFCIInteraction(com.opencloud.slee.resources.sis.components.CompositionID), getServiceRefs(com.opencloud.slee.resources.sis.components.CompositionID)

getOnlineChargingInteraction

OnlineChargingInteraction getOnlineChargingInteraction(CompositionID id)
                                                       throws NullPointerException,
                                                              UnrecognizedComponentException,
                                                              ManagementException

Get the Online Charging interaction settings for a composition in the SIS-IN RA entity. This relates to the handling of Apply Charging, Send Charging Information, and Call Information Request messages.

Parameters:

id - the identifier for the composition.

Returns:

the Online Charging interaction settings for the composition.

Throws:

NullPointerException - if id is null.

UnrecognizedComponentException - if a composition with the specified ID is not found.

ManagementException - if an error occurs communicating with the management server.

See Also:

setOnlineChargingInteraction(com.opencloud.slee.resources.sis.components.CompositionID, com.opencloud.slee.resources.sis.script.in.OnlineChargingInteraction)

setOnlineChargingInteraction

void setOnlineChargingInteraction(CompositionID id,
                                OnlineChargingInteraction interaction)
                                  throws NullPointerException,
                                         UnrecognizedComponentException,
                                         InvalidArgumentException,
                                         ManagementException

Set the Online Charging interaction settings for a composition in the SIS-IN RA entity. This relates to the handling of Apply Charging, Send Charging Information, and Call Information Request messages.

Parameters:

id - the identifier for the composition.

interaction - the Online Charging interaction settings.

Throws:

NullPointerException - if either argument is null.

UnrecognizedComponentException - if a composition with the specified ID is not found.

InvalidArgumentException - if interaction specifies the "nominated service" mode for which the specified service alias does not exist in the composition.

ManagementException - if an error occurs communicating with the management server.

See Also:

getOnlineChargingInteraction(com.opencloud.slee.resources.sis.components.CompositionID), getServiceRefs(com.opencloud.slee.resources.sis.components.CompositionID)