javax.jbi.management

Interface DeploymentServiceMBean

public interface DeploymentServiceMBean

The deployment service MBean allows administrative tools to manage service assembly deployments. The tasks supported are:

• Deploying a service assembly.
• Undeploying a previously deployed service assembly.
• Querying deployed service assemblies:
  • For all components in the schemaorg_apache_xmlbeans.system.
  • For a particular component.
• Control the state of deployed service assemblies:
  • Start the service units that contained in the SA.
  • Stop the service units that contained in the SA.
  • Shut down the service units that contained in the SA.
• Query the service units deployed to a particular component.
• Check if a service unit is deployed to a particular component.
• Query the deployment descriptor for a particular service assembly.

Author:

JSR208 Expert Group

Field Summary

Fields

Modifier and Type	Field and Description
static String	SHUTDOWN The service assembly has been deployed, or shutdown
static String	STARTED The service assembly is started.
static String	STOPPED The service assembly is stopped.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canDeployToComponent(String componentName) Returns true if the the given component accepts the deployment of service units.
String	deploy(String serviceAssemblyZipUrl) Deploys the given Service Assembly to the JBI environment.
String[]	getComponentsForDeployedServiceAssembly(String serviceAssemblyName) Returns an array of component names, where for each the given assembly contains a service unit for the component.
String[]	getDeployedServiceAssemblies() Returns a list of Service Assemblies deployed to the JBI environment.
String[]	getDeployedServiceAssembliesForComponent(String componentName) Returns an array of Service Assembly names, where each assembly contains Service Units for the given component.
String[]	getDeployedServiceUnitList(String componentName) Returns an array of service unit names that are currently deployed to the named component.
String	getServiceAssemblyDescriptor(String serviceAssemblyName) Returns the deployment descriptor of the Service Assembly that was deployed to the JBI enviroment, serialized to a String.
String	getState(String serviceAssemblyName) Get the running state of a service assembly.
boolean	isDeployedServiceUnit(String componentName, String serviceUnitName) Queries if the named Service Unit is currently deployed to the named component.
String	shutDown(String serviceAssemblyName) Shut down the service assembly.
String	start(String serviceAssemblyName) Start the service assembly.
String	stop(String serviceAssemblyName) Stop the service assembly.
String	undeploy(String serviceAssemblyName) Undeploys the given Service Assembly from the JBI environment.

Field Detail

SHUTDOWN

static final String SHUTDOWN

The service assembly has been deployed, or shutdown

See Also:

Constant Field Values

STOPPED

static final String STOPPED

The service assembly is stopped. This means that the assembly's offered services can accept message exchanges, but it will not send any.

See Also:

Constant Field Values

STARTED

static final String STARTED

The service assembly is started. This means that the assembly's offered services can accept message exchanges, and it can send exchanges to consume services.

See Also:

Constant Field Values

Method Detail

canDeployToComponent

boolean canDeployToComponent(String componentName)

Returns true if the the given component accepts the deployment of service units. This is used by admin tools to determine which components can be named in service assembly deployment descriptors.

Parameters:

componentName - name of the component; must be non-null and non-empty

Returns:

true if the named component accepts deployments; false if the named component does not accept deployments or it does not exist

deploy

String deploy(String serviceAssemblyZipUrl)
              throws Exception

Deploys the given Service Assembly to the JBI environment.

Note that the implementation must not automatically start the service assembly after deployment; it must wait for the start(String) method to be invoked by the administrative tool.

Parameters:

serviceAssemblyZipUrl - String containing the location URL of the Service Assembly ZIP file; must be non-null, non-empty, and a legal URL

Returns:

Result/Status of the current deployment; must conform to JBI management result/status XML schema; must be non-null and non-empty

Throws:

Exception - if complete deployment fails

undeploy

String undeploy(String serviceAssemblyName)
                throws Exception

Undeploys the given Service Assembly from the JBI environment.

Parameters:

serviceAssemblyName - name of the Service Assembly that is to be undeployed; must be non-null and non-empty

Returns:

Result/Status of the current undeployment; must conform to JBI management result/status XML schema; must be non-null and non-empty

Throws:

Exception - if compelete undeployment fails

getDeployedServiceUnitList

String[] getDeployedServiceUnitList(String componentName)
                                    throws Exception

Returns an array of service unit names that are currently deployed to the named component.

Parameters:

componentName - the name of the component to query; must be non-null and non-empty

Returns:

array of service unit names deployed in the named component; must be non-null; may be empty

Throws:

Exception - if a processing error occurs

getDeployedServiceAssemblies

String[] getDeployedServiceAssemblies()
                                      throws Exception

Returns a list of Service Assemblies deployed to the JBI environment.

Returns:

list of Service Assembly names; must be non-null; may be empty

Throws:

Exception - if a processing error occurs

getServiceAssemblyDescriptor

String getServiceAssemblyDescriptor(String serviceAssemblyName)
                                    throws Exception

Returns the deployment descriptor of the Service Assembly that was deployed to the JBI enviroment, serialized to a String.

Parameters:

serviceAssemblyName - name of the service assembly to be queried; must be non-null and non-empty

Returns:

descriptor of the Assembly Unit; must be non-null

Throws:

Exception - if a processing error occurs

getDeployedServiceAssembliesForComponent

String[] getDeployedServiceAssembliesForComponent(String componentName)
                                                  throws Exception

Returns an array of Service Assembly names, where each assembly contains Service Units for the given component.

Parameters:

componentName - name of the component to query; must be non-null and non-empty

Returns:

array of of Service Assembly names, where each assembly contains a Service Unit for the named component; must be non-null; may be empty

Throws:

Exception - if a processing error occurs

getComponentsForDeployedServiceAssembly

String[] getComponentsForDeployedServiceAssembly(String serviceAssemblyName)
                                                 throws Exception

Returns an array of component names, where for each the given assembly contains a service unit for the component.

Parameters:

serviceAssemblyName - the service assembly to be queried; must be non-null and non-empty

Returns:

array of component names, where for each name the given assembly contains a service unit from the given service assembly; must be non-null; may be empty

Throws:

Exception - if a processing error occurs

isDeployedServiceUnit

boolean isDeployedServiceUnit(String componentName,
                            String serviceUnitName)
                              throws Exception

Queries if the named Service Unit is currently deployed to the named component.

Parameters:

componentName - name of the component to query; must be non-null and non-empty

serviceUnitName - name of the subject service unit; must be non-null and non-empty

Returns:

true if the named service unit is currently deployed to the named component

Throws:

Exception

start

String start(String serviceAssemblyName)
             throws Exception

Start the service assembly. This puts the assembly into the STARTED state.

Parameters:

serviceAssemblyName - name of the assembly to be started; must be non-null and non-empty

Returns:

result / status string giving the results of starting (and possibly initializing) each service unit in the assembly; must be non-null and non-empty

Throws:

Exception - if there is no such assembly

Exception - if the assembly fails to start

stop

String stop(String serviceAssemblyName)
            throws Exception

Stop the service assembly. This puts the assembly into the STOPPED state.

Parameters:

serviceAssemblyName - name of the assembly to be stopped; must be non-null and non-empty

Returns:

result / status string giving the results of stopping each service unit in the assembly; must be non-null and non-empty

Throws:

Exception - if there is no such assembly

Exception - if the assembly fails to stop

shutDown

String shutDown(String serviceAssemblyName)
                throws Exception

Shut down the service assembly. This puts the assembly back into the SHUTDOWN state.

Parameters:

serviceAssemblyName - name of the assembly to be shut down; must be non-null and non-empty

Returns:

result / status string giving the results of shutting down each service unit in the assembly; must be non-null and non-empty

Throws:

Exception - if there is no such assembly

Exception - if the assembly fails to shut down

getState

String getState(String serviceAssemblyName)
                throws Exception

Get the running state of a service assembly. The possible result values of this query are enumerated by the following set of constants: SHUTDOWN, STOPPED, STARTED.

Parameters:

serviceAssemblyName - name of the assembly to query; must be non-null and non-empty

Returns:

the state of the service assembly, as a string value; must be one of the enumerated string values provided by this interface: SHUTDOWN, STOPPED, or STARTED

Throws:

Exception - if there is no such assembly