com.opencloud.slee.resources.sis.management

Interface TriggerManagementMBean

public interface TriggerManagementMBean

The TriggerManagementMBean provides management operations for installing, uninstalling and viewing SIS trigger components installed in a SIS RA entity.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SIS_MANAGEMENT_TYPE

Method Summary

Modifier and Type	Method and Description
void	activate(TriggerID id) Activate a trigger component in the SIS.
void	deactivate(TriggerID id) Deactivate a trigger component in the SIS.
TriggerID[]	getActiveTriggers() Get the identifiers of all activated trigger components installed in the SIS, in order of priority (highest to lowest).
Object[]	getDependencies(TriggerID id) Get the set of components that a given trigger component depends on.
String	getTrigger(TriggerID id) Retrieves the XML form of a trigger component
TriggerID[]	getTriggers() Get the identifiers of all trigger components installed in the SIS.
TriggerID	install(byte[] content) Installs a trigger component into the SIS.
TriggerID	install(String url) Installs a trigger component into the SIS.
boolean	isActivated(TriggerID id) Determine if the specified trigger component has been activated
boolean	isInstalled(TriggerID id) Determine whether a trigger is installed in the SIS.
TriggerID	replace(byte[] content) Replaces a trigger component in the SIS.
TriggerID	replace(String url) Replaces a trigger component in the SIS.
void	uninstall(TriggerID id) Uninstall a trigger component from the SIS.

Field Detail

SIS_MANAGEMENT_TYPE

static final String SIS_MANAGEMENT_TYPE

See Also:

Constant Field Values

Method Detail

install

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

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

Parameters:

url - the URL of the trigger XML file to install

Returns:

the TriggerID 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 TriggerID 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

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

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

Parameters:

content - the trigger XML content to be installed

Returns:

the TriggerID that identifies the installed component.

Throws:

NullPointerException - if content is null

AlreadyDeployedException - if a component with the same TriggerID 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

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

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

Parameters:

url - the URL of the trigger XML file to install

Returns:

the TriggerID 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

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

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

Parameters:

content - the trigger XML content to be installed

Returns:

the TriggerID 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(TriggerID id)
        throws NullPointerException,
               UnrecognizedComponentException,
               DependencyException,
               InvalidStateException,
               ManagementException

Uninstall a trigger component from the SIS. The trigger must first be deactivated.

Parameters:

id - the identifier of the component to uninstall

Throws:

NullPointerException - if id is null

UnrecognizedComponentException - if id does not match an installed component

InvalidStateException - if the trigger is active

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

Determine whether a trigger is installed in the SIS.

Parameters:

id - the identifier of the component.

Returns:

true if the specified trigger 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.

activate

void activate(TriggerID id)
       throws NullPointerException,
              UnrecognizedComponentException,
              InvalidStateException,
              ManagementException

Activate a trigger component in the SIS.

Parameters:

id - the identifier of the trigger to activate

Throws:

NullPointerException - if id is null

UnrecognizedComponentException - if id does not match an installed component

InvalidStateException - if the trigger is already active

ManagementException - if the trigger could not be activated due to a system-level failure.

deactivate

void deactivate(TriggerID id)
         throws NullPointerException,
                UnrecognizedComponentException,
                InvalidStateException,
                ManagementException

Deactivate a trigger component in the SIS.

Parameters:

id - the identifier of the trigger to deactivate

Throws:

NullPointerException - if id is null

UnrecognizedComponentException - if id does not match an installed component

InvalidStateException - if the trigger is already deactivated

ManagementException - if the trigger could not be deactivated due to a system-level failure.

isActivated

boolean isActivated(TriggerID id)
             throws NullPointerException,
                    UnrecognizedComponentException,
                    ManagementException

Determine if the specified trigger component has been activated

Parameters:

id - the identifier of the trigger

Returns:

true if the trigger is activated, otherwise false.

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.

getTriggers

TriggerID[] getTriggers()
                 throws ManagementException

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

Returns:

an array of TriggerIDs

Throws:

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

getActiveTriggers

TriggerID[] getActiveTriggers()
                       throws ManagementException

Get the identifiers of all activated trigger components installed in the SIS, in order of priority (highest to lowest).

Returns:

an array of TriggerIDs

Throws:

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

getTrigger

String getTrigger(TriggerID id)
           throws NullPointerException,
                  UnrecognizedComponentException,
                  ManagementException

Retrieves the XML form of a trigger component

Parameters:

id - the identifier of the component

Returns:

a string containing the trigger 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(TriggerID id)
                  throws NullPointerException,
                         UnrecognizedComponentException,
                         ManagementException

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

• macros
• compositions
• 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.