| com.sun.jbi.framework.DeployerMBean
All known Subclasses: com.sun.jbi.framework.Deployer,
| DeployerMBean | | public interface DeployerMBean (Code) | | This is the framework-provided version of the DeployerMBean for use with
the ServiceUnitManager SPI of a component.
author:
Sun Microsystems, Inc. |
| Method Summary | |
| 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.
Parameters:
serviceUnitName - The unique name of the 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.
Parameters:
serviceUnitName - the name of the Service Unit. | | 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. |
| deploy | | String deploy(String serviceUnitName, String serviceUnitRootPath) throws javax.jbi.management.DeploymentException(Code) | | 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.
Parameters:
serviceUnitRootPath - the full path to the Service Unit artifactroot directory.
throws:
javax.jbi.management.DeploymentException - if the deploymentoperation is unsuccessful. a deployment status message. |
| getDeployments | | String[] getDeployments()(Code) | | Return a list of all Service Units currently deployed to the component.
array of Service Unit name strings. |
| getServiceUnitState | | ServiceUnitState getServiceUnitState(String serviceUnitName)(Code) | | Get the current state of a Service Unit.
Parameters:
serviceUnitName - The unique name of the Service Unit. The service unit state. |
| init | | void init(String serviceUnitName, String serviceUnitRootPath) throws javax.jbi.management.DeploymentException(Code) | | 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.
Parameters:
serviceUnitRootPath - the absolute path to the directory, whichhas the extracted service unit contents.
throws:
javax.jbi.management.DeploymentException - if the Service Unit isnot deployed, or is in an incorrect state. |
| isDeployed | | boolean isDeployed(String serviceUnitName)(Code) | | Return a boolean value indicating whether the Service Unit is currently
deployed.
Parameters:
serviceUnitName - the name of the Service Unit. true if the Service Unit is deployed, false if not. |
| shutDown | | void shutDown(String serviceUnitName, boolean force) throws javax.jbi.management.DeploymentException(Code) | | 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.
Parameters:
force - when set to true, indicates a forced shutdown, whichcauses the shutdown to be completed regardless of any errors whichmay occur in the component's Service Unit Manager.
throws:
javax.jbi.management.DeploymentException - if the Service Unitis not deployed, or is in an incorrect state. |
| stop | | void stop(String serviceUnitName) throws javax.jbi.management.DeploymentException(Code) | | 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:
javax.jbi.management.DeploymentException - if the Service Unitis not deployed, or is in an incorrect state. |
| undeploy | | String undeploy(String serviceUnitName, String serviceAssemblyName, boolean force) throws javax.jbi.management.DeploymentException(Code) | | 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.
Parameters:
serviceAssemblyName - the name of the parent Service Assembly of the Service Unit.
Parameters:
force - when set to true, indicates a forced undeploy, whichcauses undeployment to be completed regardless of any errors whichmay occur in the component's Service Unit Manager.
throws:
javax.jbi.management.DeploymentException - if the undeployoperation is unsuccessful. A status message. |
|
|