Package com.opencloud.slee.resources.sis.management

Interface CompositionManagementMBean

public interface CompositionManagementMBean

The CompositionManagementMBean provides management operations for installing, uninstalling and viewing SIS service composition components installed in a SIS RA entity.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SIS_MANAGEMENT_TYPE

Method Summary

Modifier and Type	Method	Description
String	getComposition(CompositionID id)	Retrieves the XML form of the service composition component
CompositionID[]	getCompositions()	Get the identifiers of all composition components installed in the SIS.
int	getDebugLevel(CompositionID id)	Get the fine-grained tracing debug level for a composition.
Object[]	getDependencies(CompositionID id)	Get the set of components that a given composition component depends on.
SISComponent[]	getReferringComponents(CompositionID id)	Get the set of components that depend on a given composition component.
CompositionID	install(byte[] content)	Installs a service composition component into the SIS.
CompositionID	install(String url)	Installs a service composition component into the SIS.
boolean	isAuditLoggingEnabled(CompositionID id)	Determine whether audit logging is enabled for a composition.
boolean	isInstalled(CompositionID id)	Determine whether a composition is installed in the SIS.
CompositionID	replace(byte[] content)	Replaces a service composition component in the SIS.
CompositionID	replace(String url)	Replaces a service composition component in the SIS.
void	setAuditLoggingEnabled(CompositionID id, boolean enabled)	Set the audit logging flag for a composition.
void	setDebugLevel(CompositionID id, int debugLevel)	Set the fine-grained tracing debug level for a composition.
void	uninstall(CompositionID id)	Uninstall a service composition component from the SIS.

Field Detail

SIS_MANAGEMENT_TYPE

static final String SIS_MANAGEMENT_TYPE

See Also:

Constant Field Values

Method Detail

install

CompositionID install(String url)
               throws NullPointerException,
                      MalformedURLException,
                      AlreadyDeployedException,
                      DeploymentException,
                      ManagementException

Installs a service composition component into the SIS. The composition XML file is retrieved using the specified URL.

Parameters:

url - the URL of the composition XML file to install

Returns:

the CompositionID that identifies the installed component.

Throws:

NullPointerException - if url is null

MalformedURLException - if url is not a properly formatted URL

AlreadyDeployedException - if a component with the same CompositionID is already installed

DeploymentException - if the component's contents are not valid

ManagementException - if the component could not be installed due to a system-level failure.

install

CompositionID install(byte[] content)
               throws NullPointerException,
                      AlreadyDeployedException,
                      DeploymentException,
                      ManagementException

Installs a service composition component into the SIS. The composition XML data is read from the specified byte array.

Parameters:

content - the composition XML content to be installed

Returns:

the CompositionID that identifies the installed component.

Throws:

NullPointerException - if content is null

AlreadyDeployedException - if a component with the same CompositionID is already installed

DeploymentException - if the component's contents are not valid

ManagementException - if the component could not be installed due to a system-level failure.

replace

CompositionID replace(String url)
               throws NullPointerException,
                      MalformedURLException,
                      DeploymentException,
                      ManagementException

Replaces a service composition component in the SIS. The composition XML file is retrieved using the specified URL. If a composition with the same identity exists in the SIS then it is replaced with the new composition. If a composition with the same identity does not exist, then this method behaves in the same way as install(String).

Parameters:

url - the URL of the composition XML file to install

Returns:

the CompositionID that identifies the reinstalled component.

Throws:

NullPointerException - if url is null

MalformedURLException - if url is not a properly formatted URL

DeploymentException - if the component's contents are not valid

ManagementException - if the component could not be installed due to a system-level failure.

replace

CompositionID replace(byte[] content)
               throws NullPointerException,
                      DeploymentException,
                      ManagementException

Replaces a service composition component in the SIS. The composition XML data is read from the specified byte array. If a composition with the same identity exists in the SIS then it is replaced with the new composition. If a composition with the same identity does not exist, then this method behaves in the same way as install(byte[]).

Parameters:

content - the composition XML content to be installed

Returns:

the CompositionID that identifies the reinstalled component.

Throws:

NullPointerException - if content is null

DeploymentException - if the component's contents are not valid

ManagementException - if the component could not be installed due to a system-level failure.

uninstall

void uninstall(CompositionID id)
        throws NullPointerException,
               UnrecognizedComponentException,
               DependencyException,
               ManagementException

Uninstall a service composition component from the SIS.

Parameters:

id - the identifier of the component to uninstall

Throws:

NullPointerException - if id is null

UnrecognizedComponentException - if id does not match an installed component

DependencyException - if another installed SIS component depends on this component

ManagementException - if the component could not be uninstalled due to a system-level failure.

isInstalled

boolean isInstalled(CompositionID id)
             throws NullPointerException,
                    ManagementException

Determine whether a composition is installed in the SIS.

Parameters:

id - the identifier of the component.

Returns:

true if the specified composition is installed in the SIS, false otherwise.

Throws:

NullPointerException - if id is null.

ManagementException - if the presence of the component could not be determined due to a system-level failure.

getCompositions

CompositionID[] getCompositions()
                         throws ManagementException

Get the identifiers of all composition components installed in the SIS.

Returns:

an array of CompositionIDs

Throws:

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

getComposition

String getComposition(CompositionID id)
               throws NullPointerException,
                      UnrecognizedComponentException,
                      ManagementException

Retrieves the XML form of the service composition component

Parameters:

id - the identifier of the component

Returns:

a string containing the composition in its XML form

Throws:

NullPointerException - if id is null

UnrecognizedComponentException - if id does not match an installed component

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

getDependencies

Object[] getDependencies(CompositionID id)
                  throws NullPointerException,
                         UnrecognizedComponentException,
                         ManagementException

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

• macros
• extension references
• service references

Parameters:

id - the identifier of the component.

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(CompositionID id)
                               throws NullPointerException,
                                      UnrecognizedComponentException,
                                      ManagementException

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

• triggers

Parameters:

id - the identifier of the component.

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.

getDebugLevel

int getDebugLevel(CompositionID id)
           throws NullPointerException,
                  UnrecognizedComponentException,
                  ManagementException

Get the fine-grained tracing debug level for a composition.

Parameters:

id - the identifier for the composition.

Returns:

the debug level 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:

setDebugLevel(com.opencloud.slee.resources.sis.components.CompositionID, int), ConfigurationManagementMBean.setFineGrainedTracingEnabled(boolean)

setDebugLevel

void setDebugLevel(CompositionID id,
                   int debugLevel)
            throws NullPointerException,
                   UnrecognizedComponentException,
                   IllegalArgumentException,
                   ManagementException

Set the fine-grained tracing debug level for a composition. Fine-grained tracing debug levels are given in the package summary.

Parameters:

id - the identifier for the composition.

debugLevel - the debug level.

Throws:

NullPointerException - if id is null.

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

IllegalArgumentException - if debugLevel is not valid.

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

See Also:

getDebugLevel(com.opencloud.slee.resources.sis.components.CompositionID), ConfigurationManagementMBean.setFineGrainedTracingEnabled(boolean)

isAuditLoggingEnabled

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

Determine whether audit logging is enabled for a composition.

If enabled, and the SIS's audit logging level is set to AuditLevel.ALL or AuditLevel.COMPONENT, then an audit record will be logged for all calls that invoke the composition.

Parameters:

id - the identifier for the composition.

Returns:

true if audit logging is enabled

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:

ConfigurationManagementMBean.setAuditLevel(com.opencloud.slee.resources.sis.management.AuditLevel)

setAuditLoggingEnabled

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

Set the audit logging flag for a composition.

If enabled, and the SIS's audit logging level is set to AuditLevel.ALL or AuditLevel.COMPONENT, then an audit record will be logged for all calls that invoke the composition.

Parameters:

id - the identifier for the composition.

enabled - boolean value to specify if audit logging should be enabled

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:

ConfigurationManagementMBean.setAuditLevel(com.opencloud.slee.resources.sis.management.AuditLevel)