com.sun.jbi.framework

Interface DeployerMBean

public interface DeployerMBean

This is the framework-provided version of the DeployerMBean for use with the ServiceUnitManager SPI of a component.

Author:

Sun Microsystems, Inc.

Method Summary

Methods

Modifier and Type	Method and Description
String	deploy(String serviceUnitName, String serviceUnitRootPath) Deploy a Service Unit to the component.
String[]	getDeployments() Return a list of all Service Units currently deployed to the component.
ServiceUnitState	getServiceUnitState(String serviceUnitName) Get the current state of a Service Unit.
void	init(String serviceUnitName, String serviceUnitRootPath) Initialize a Service Unit.
boolean	isDeployed(String serviceUnitName) Return a boolean value indicating whether the Service Unit is currently deployed.
void	shutDown(String serviceUnitName) Shut down a Service Unit.
void	shutDown(String serviceUnitName, boolean force) Shut down a Service Unit.
void	start(String serviceUnitName) Start a Service Unit.
void	stop(String serviceUnitName) Stop a Service Unit.
String	undeploy(String serviceUnitName, String serviceAssemblyName) Undeploy a Service Unit from the component.
String	undeploy(String serviceUnitName, String serviceAssemblyName, boolean force) Undeploy a Service Unit from the component.

Method Detail

deploy

String deploy(String serviceUnitName,
            String serviceUnitRootPath)
              throws DeploymentException

Deploy a Service Unit to the component. This is called to deploy the specified artifact to the component.

Parameters:

serviceUnitName - the name of the Service Unit being deployed.

serviceUnitRootPath - the full path to the Service Unit artifact root directory.

Returns:

a deployment status message.

Throws:

DeploymentException - if the deployment operation is unsuccessful.

getDeployments

String[] getDeployments()

Return a list of all Service Units currently deployed to the component.

Returns:

array of Service Unit name strings.

getServiceUnitState

ServiceUnitState getServiceUnitState(String serviceUnitName)

Get the current state of a Service Unit.

Parameters:

serviceUnitName - The unique name of the Service Unit.

Returns:

The service unit state.

isDeployed

boolean isDeployed(String serviceUnitName)

Return a boolean value indicating whether the Service Unit is currently deployed.

Parameters:

serviceUnitName - the name of the Service Unit.

Returns:

true if the Service Unit is deployed, false if not.

undeploy

String undeploy(String serviceUnitName,
              String serviceAssemblyName)
                throws DeploymentException

Undeploy a Service Unit from the component. The Service Unit must be shut down before it can be undeployed.

Parameters:

serviceUnitName - the name of the Service Unit being undeployed.

serviceAssemblyName - the name of the parent Service Assembly of the Service Unit.

Returns:

A status message.

Throws:

DeploymentException - if the undeploy operation is unsuccessful.

undeploy

String undeploy(String serviceUnitName,
              String serviceAssemblyName,
              boolean force)
                throws DeploymentException

Undeploy a Service Unit from the component. The Service Unit must be shut down before it can be undeployed, unless the force options is set, in which case all state checks are skipped.

Parameters:

serviceUnitName - the name of the Service Unit being undeployed.

serviceAssemblyName - the name of the parent Service Assembly of the Service Unit.

force - when set to true, indicates a forced undeploy, which causes undeployment to be completed regardless of any errors which may occur in the component's Service Unit Manager.

Returns:

A status message.

Throws:

DeploymentException - if the undeploy operation is unsuccessful.

init

void init(String serviceUnitName,
        String serviceUnitRootPath)
          throws DeploymentException

Initialize a Service Unit. This is the first phase of a two-phase start, where the component must prepare to receive service requests related to the Service Unit (if any).

Parameters:

serviceUnitName - the name of the Service Unit being initialized.

serviceUnitRootPath - the absolute path to the directory, which has the extracted service unit contents.

Throws:

DeploymentException - if the Service Unit is not deployed, or is in an incorrect state.

shutDown

void shutDown(String serviceUnitName)
              throws DeploymentException

Shut down a Service Unit. This causes the Service Unit to return to the state it was in after deploy() and before init().

Parameters:

serviceUnitName - the name of the Service Unit being shut down.

Throws:

DeploymentException - if the Service Unit is not deployed, or is in an incorrect state.

shutDown

void shutDown(String serviceUnitName,
            boolean force)
              throws DeploymentException

Shut down a Service Unit. This causes the Service Unit to return to the state it was in after deploy() and before init(). If the force option is set, then the operation proceeds regardless of of any errors in state or in the component's Service Unit Manager.

Parameters:

serviceUnitName - the name of the Service Unit being shut down.

force - when set to true, indicates a forced shutdown, which causes the shutdown to be completed regardless of any errors which may occur in the component's Service Unit Manager.

Throws:

DeploymentException - if the Service Unit is not deployed, or is in an incorrect state.

start

void start(String serviceUnitName)
           throws DeploymentException

Start a Service Unit. This is the second phase of a two-phase start, where the component can now initiate service requests related to the Service Unit.

Parameters:

serviceUnitName - the name of the Service Unit being started.

Throws:

DeploymentException - if the Service Unit is not deployed, or is in an incorrect state.

stop

void stop(String serviceUnitName)
          throws DeploymentException

Stop a Service Unit. This causes the component to cease generating service requests related to the Service Unit. This returns the Service Unit to a state equivalent to after init() was called.

Parameters:

serviceUnitName - the name of the Service Unit being stopped.

Throws:

DeploymentException - if the Service Unit is not deployed, or is in an incorrect state.