| javax.jbi.component.ServiceUnitManager
All known Subclasses: com.sun.jbi.management.binding.ModelBindingComponent, deploytest.ConsolidatedSchemaComponent, deploytest.BadInstallBindingComponent, com.sun.jbi.ui.ant.test.statistics.SimpleTestEngine, com.sun.jbi.ui.ant.test.binding2.rt.Binding2Deployer, com.sun.jbi.management.engine.ModelEngineComponent, com.sun.jbi.ui.cli.test.engine2.rt.Engine2Deployer, com.sun.jbi.ui.cli.test.engine4.rt.Engine4Deployer, com.sun.jbi.ui.ant.test.engine3.rt.Engine3Deployer, deploytest.BadUninstallBindingComponent, com.sun.jbi.internal.security.test.binding1.rt.ServiceUnitMgrImpl, deploytest.UpgradableComponent, com.sun.jbi.ui.ant.test.engine2.rt.Engine2Deployer, deploytest.BindingComponent, deploytest.ExtensionBindingComponent, com.sun.jbi.ui.ant.test.engine4.rt.Engine4Deployer, com.sun.jbi.ui.cli.test.binding2.rt.Binding2Deployer, com.sun.jbi.ui.cli.test.statistics.SimpleTestEngine, com.sun.jbi.binding.jms.deploy.JMSBindingSUManager, com.sun.jbi.binding.file.FileBindingSUManager, com.sun.jbi.framework.AbstractComponent, testcomponent.BindingComponent, deploytest.DeployOnceBindingComponent, java4ant.BindingComponent, com.sun.jbi.ui.ant.test.engine1.rt.Engine1Deployer, com.sun.jbi.engine.sequencing.SequencingEngineSUManager, com.sun.jbi.engine.xslt.TransformationEngineSUManager, deploytest.StartOneDeploymentComponent, test.SimpleTestEngine, deploytest.FileLockingComponent, test.BindingComponent, deploytest.DeployBinding, com.sun.jbi.ui.cli.test.engine1.rt.Engine1Deployer, com.sun.jbi.ui.cli.test.engine3.rt.Engine3Deployer, testcomponent1.BindingComponent1, com.sun.jbi.ui.cli.test.binding1.rt.Binding1Deployer, com.sun.jbi.ui.ant.test.binding1.rt.Binding1Deployer,
| ServiceUnitManager | | public interface ServiceUnitManager (Code) | | This interface defines component-supplied methods for managing service
unit deployments, and is implemented by the component. The JBI implementation
queries the component for the implementation of this interface using the
Component.getServiceUnitManager method.
author:
JSR208 Expert Group |
| Method Summary | |
| String | deploy(String serviceUnitName, String serviceUnitRootPath)
Deploy a Service Unit to the component. | | void | init(String serviceUnitName, String serviceUnitRootPath)
Initialize the given deployed service unit. | | void | shutDown(String serviceUnitName)
Shut down the deployment. | | void | start(String serviceUnitName)
Start the deployed service unit. | | void | stop(String serviceUnitName)
Stop the deployed service unit. | | String | undeploy(String serviceUnitName, String serviceUnitRootPath)
Undeploy a service unit from the component. |
| deploy | | String deploy(String serviceUnitName, String serviceUnitRootPath) throws DeploymentException(Code) | | Deploy a Service Unit to the component. This is called by the JBI
implementation in order to deploy the given artifact to the implementing
component.
Upon successful deployment, a non-empty result string must be returned,
that starts with the JBI-defined component-task-result element.
For example:
<component-task-result>
<component-name>BC1</component-name>
<component-task-result-details
xmlns="http://java.sun.com/xml/ns/jbi/management-message">
<task-result-details>
<task-id>deploy</task-id>
<task-result>SUCCESS</task-result>
</task-result-details>
</component-task-result-details>
</component-task-result>
A failed deployment of the service unit must be reported using the
component-task-result element as well; the
task-result must be set to FAILED.
Parameters:
serviceUnitName - name of the service unit being deployed; must benon-null and non-empty and unique among service units alreadydeployed to the component.
Parameters:
serviceUnitRootPath - path of the service unit artifact root, inplatform specific format; must be non-null and non-empty. a deployment status message, which is an XML string that conformsto the schema given in the MBean Status and Result Stringssection of the Management chapter of the JBIspecification; must be non-null and non-empty.
exception:
DeploymentException - if the deployment operation isunsuccessful. |
| init | | void init(String serviceUnitName, String serviceUnitRootPath) throws DeploymentException(Code) | | Initialize the given deployed service unit. This is the first phase of
a two-phase start, where the component must prepare to receive service
requests related to the deployment (if any).
The serviceUnitRootPath parameter is provided to facilitate restart of
the component. This allows simple components to rely entirely on JBI's
ability to persist deployment information, avoiding the need for the
component to provide its own persistence mechanism.
Parameters:
serviceUnitName - name of the service unit being initialized; mustbe non-null, non-empty, and match the name of a previouslydeployed (but not yet undeployed) service unit.
Parameters:
serviceUnitRootPath - path of the service unit artifact root, inplatform specific format; must be non-null and non-empty.
exception:
DeploymentException - if the service unit is not deployed, orif it is in an incorrect state. |
| start | | void start(String serviceUnitName) throws DeploymentException(Code) | | Start the deployed service unit. This is the second phase of a two-phase
start, where the component can now initiate service requests related to
the deployment.
Parameters:
serviceUnitName - the name of the service unit being started; mustbe non-null, non-empty, and match the name of a previouslydeployed (but not yet undeployed) service unit.
exception:
DeploymentException - if the service unit is not deployed, orif it is in an incorrect state. |
| stop | | void stop(String serviceUnitName) throws DeploymentException(Code) | | Stop the deployed service unit. This causes the component to cease
generating service requests related to the given service unit. This
returns the service unit to a state equivalent to after
ServiceUnitManager.init(String,String) was called.
Parameters:
serviceUnitName - name of the service unit being stopped; mustbe non-null, non-empty, and match the name of a previouslydeployed (but not yet undeployed) service unit.
exception:
DeploymentException - if the service unit is not deployed, orif it is in an incorrect state. |
| undeploy | | String undeploy(String serviceUnitName, String serviceUnitRootPath) throws DeploymentException(Code) | | Undeploy a service unit from the component. The service unit must be
shut down to undeploy it.
Parameters:
serviceUnitName - name of the service unit being undeployed; mustbe non-null, non-empty, and match the name of a previouslydeployed (but not yet undeployed) service unit.
Parameters:
serviceUnitRootPath - path of the service unit artifact root, inplatform specific format; must be non-null and non-empty. deployment status message, which is an XML string that conformsto the component-task-result type fromthe schema given in the MBean Status and Result Stringssection of the Management chapter of the JBIspecification; must be non-null and non-empty.
exception:
DeploymentException - if undeployment operation is unsuccessful,or if the service unit is in an incorrect state. |
|
|