com.opencloud.slee.resources.sis.management

Interface InterceptorManagementMBean

public interface InterceptorManagementMBean

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

Since:

SIS 2.5.0.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SIS_MANAGEMENT_TYPE

Method Summary

Modifier and Type	Method and Description
void	createInterceptorRef(String name, InterceptorID interceptorID) Create an interceptor reference in the SIS.
Object[]	getDependencies(InterceptorID id) Get the set of components that a given interceptor component depends on.
CompositeData	getDescriptor(InterceptorRefID interceptorRefID) Get information about an interceptor reference in the SIS.
String	getInterceptor(InterceptorID id) Retrieves the XML form of the interceptor component
InterceptorRefID[]	getInterceptorRefs() Get the component identifiers of all interceptor references in the SIS.
InterceptorID[]	getInterceptors() Get the identifiers of all interceptor components installed in the SIS.
SISComponent[]	getReferringComponents(InterceptorID id) Get the set of components that depend on a given interceptor component.
SISComponent[]	getReferringComponents(InterceptorRefID interceptorRefID) Get the set of components that depend on a given interceptor reference component.
InterceptorID	install(byte[] content) Installs an interceptor component into the SIS.
InterceptorID	install(String url) Installs an interceptor component into the SIS.
boolean	isInstalled(InterceptorID id) Determine whether an interceptor component is installed in the SIS.
void	removeInterceptorRef(InterceptorRefID interceptorRefID) Remove an interceptor reference from the SIS.
InterceptorID	replace(byte[] content) Replaces an interceptor component in the SIS.
InterceptorID	replace(String url) Replaces an interceptor component in the SIS.
void	replaceInterceptorRef(InterceptorRefID interceptorRefID, InterceptorID interceptorID) Replace an interceptor reference in the SIS with a new reference.
void	uninstall(InterceptorID id) Uninstall an interceptor component from the SIS.

Field Detail

SIS_MANAGEMENT_TYPE

static final String SIS_MANAGEMENT_TYPE

See Also:

Constant Field Values

Method Detail

install

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

Installs an interceptor component into the SIS. The interceptor XML file is retrieved using the specified URL.

Parameters:

url - the URL of the interceptor XML file to install

Returns:

the InterceptorID 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 InterceptorID 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.

Since:

SIS 2.5.0.

install

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

Installs an interceptor component into the SIS. The interceptor XML data is read from the specified byte array.

Parameters:

content - the interceptor XML content to be installed

Returns:

the InterceptorID that identifies the installed component.

Throws:

NullPointerException - if content is null

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

Since:

SIS 2.5.0.

replace

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

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

Parameters:

url - the URL of the interceptor XML file to install

Returns:

the InterceptorID 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.

Since:

SIS 2.5.0.

replace

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

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

Parameters:

content - the interceptor XML content to be installed

Returns:

the InterceptorID 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.

Since:

SIS 2.5.0.

uninstall

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

Uninstall an interceptor 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.

Since:

SIS 2.5.0.

isInstalled

boolean isInstalled(InterceptorID id)
             throws NullPointerException,
                    ManagementException

Determine whether an interceptor component is installed in the SIS.

Parameters:

id - the identifier of the component.

Returns:

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

Since:

SIS 2.5.0.

getInterceptors

InterceptorID[] getInterceptors()
                         throws ManagementException

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

Returns:

an array of InterceptorIDs

Throws:

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

Since:

SIS 2.5.0.

getInterceptor

String getInterceptor(InterceptorID id)
               throws NullPointerException,
                      UnrecognizedComponentException,
                      ManagementException

Retrieves the XML form of the interceptor component

Parameters:

id - the identifier of the component

Returns:

a string containing the interceptor 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.

Since:

SIS 2.5.0.

getDependencies

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

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

• extension 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.

Since:

SIS 2.5.0.

getReferringComponents

SISComponent[] getReferringComponents(InterceptorID id)
                               throws NullPointerException,
                                      UnrecognizedComponentException,
                                      ManagementException

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

• interceptor references

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.

Since:

SIS 2.5.0.

createInterceptorRef

void createInterceptorRef(String name,
                          InterceptorID interceptorID)
                   throws NullPointerException,
                          AlreadyDeployedException,
                          DeploymentException,
                          ManagementException

Create an interceptor reference in the SIS.

Parameters:

name - the name for the new interceptor reference. The name can be used in compositions to identify the interceptor to be invoked.

interceptorID - the id of the interceptor component.

Throws:

NullPointerException - if either argument is null.

AlreadyDeployedException - if an interceptor reference with the specified name is already in use in the SIS RA entity.

DeploymentException - if the interceptor reference cannot be created due to a missing dependency.

ManagementException - if the interceptor reference could not be created due to a system-level-failure.

Since:

SIS 2.5.0.

replaceInterceptorRef

void replaceInterceptorRef(InterceptorRefID interceptorRefID,
                           InterceptorID interceptorID)
                    throws NullPointerException,
                           UnrecognizedComponentException,
                           DeploymentException,
                           ManagementException

Replace an interceptor reference in the SIS with a new reference.

Parameters:

interceptorRefID - the component identifier of the interceptor reference to replace.

interceptorID - the id of the interceptor component.

Throws:

NullPointerException - if either argument is null.

UnrecognizedComponentException - if interceptorRefID does not match a current interceptor reference.

DeploymentException - if the extension reference cannot be created due to a missing dependency.

ManagementException - if the interceptor reference could not be created due to a system-level-failure.

Since:

SIS 2.5.0.

removeInterceptorRef

void removeInterceptorRef(InterceptorRefID interceptorRefID)
                   throws NullPointerException,
                          UnrecognizedComponentException,
                          DependencyException,
                          ManagementException

Remove an interceptor reference from the SIS.

Parameters:

interceptorRefID - the component identifier of the interceptor reference to remove.

Throws:

NullPointerException - if interceptorRefID is null.

UnrecognizedComponentException - if interceptorRefID does not match a current interceptor reference.

DependencyException - if another installed SIS component depends on this component.

ManagementException - if the interceptor reference could not be removed due to a system-level failure.

Since:

SIS 2.5.0.

getInterceptorRefs

InterceptorRefID[] getInterceptorRefs()
                               throws ManagementException

Get the component identifiers of all interceptor references in the SIS.

Returns:

the identifiers of all interceptor references in the SIS.

Throws:

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

Since:

SIS 2.5.0.

getDescriptor

CompositeData getDescriptor(InterceptorRefID interceptorRefID)
                     throws NullPointerException,
                            UnrecognizedComponentException,
                            ManagementException

Get information about an interceptor reference in the SIS.

This method returns a CompositeData type with the following fields:

Field	Open Type	Description
name	String	The name of the interceptor reference.
interceptorName	String	The name component of the referenced interceptor component identifier.
interceptorVendor	String	The vendor component of the referenced interceptor service component identifier.
interceptorVersion	String	The version component of the referenced interceptor service component identifier.

Parameters:

interceptorRefID - the component identifier of the interceptor reference.

Returns:

a CompositeData object as described above.

Throws:

NullPointerException - if interceptorRefID is null.

UnrecognizedComponentException - if interceptorRefID does not match a current interceptor reference.

ManagementException - if the interceptor reference descriptor could not be obtained due to a system-level failure.

Since:

SIS 2.5.0.

getReferringComponents

SISComponent[] getReferringComponents(InterceptorRefID interceptorRefID)
                               throws NullPointerException,
                                      UnrecognizedComponentException,
                                      ManagementException

Get the set of components that depend on a given interceptor reference component. An interceptor reference component may be referred to by:

• compositions

Parameters:

interceptorRefID - the component identifier of the interceptor reference.

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.

Since:

SIS 2.5.0.