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

Interface MacroManagementMBean

public interface MacroManagementMBean

The MacroManagementMBean provides management operations for installing, uninstalling and viewing SIS macro 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
Object[]	getDependencies(MacroID id)	Get the set of components that a given macro component depends on.
String	getMacro(MacroID id)	Retrieves the XML form of a macro component
MacroID[]	getMacros()	Get the identifiers of all macro components installed in the SIS.
SISComponent[]	getReferringComponents(MacroID id)	Get the set of components that depend on a given macro component.
MacroID	install(byte[] content)	Installs a macro component into the SIS.
MacroID	install(String url)	Installs a macro component into the SIS.
boolean	isInstalled(MacroID id)	Determine whether a macro is installed in the SIS.
MacroID	replace(byte[] content)	Replaces a macro component in the SIS.
MacroID	replace(String url)	Replaces a macro component in the SIS.
void	uninstall(MacroID id)	Uninstall a macro component from the SIS.

Field Detail

SIS_MANAGEMENT_TYPE

static final String SIS_MANAGEMENT_TYPE

See Also:

Constant Field Values

Method Detail

install

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

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

Parameters:

url - the URL of the macro XML file to install

Returns:

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

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

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

Parameters:

content - the macro XML content to be installed

Returns:

the MacroID that identifies the installed component.

Throws:

NullPointerException - if content is null

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

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

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

Parameters:

url - the URL of the macro XML file to install

Returns:

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

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

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

Parameters:

content - the macro XML content to be installed

Returns:

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

Uninstall a macro 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(MacroID id)
             throws NullPointerException,
                    ManagementException

Determine whether a macro is installed in the SIS.

Parameters:

id - the identifier of the component.

Returns:

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

getMacros

MacroID[] getMacros()
             throws ManagementException

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

Returns:

an array of MacroIDs

Throws:

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

getMacro

String getMacro(MacroID id)
         throws NullPointerException,
                UnrecognizedComponentException,
                ManagementException

Retrieves the XML form of a macro component

Parameters:

id - the identifier of the component

Returns:

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

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

• other macros

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

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

• other macros
• triggers
• compositions

Parameters:

id - the identifier of the macro 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.