|
| |
|
| javax.jbi.management.DeploymentServiceMBean
| DeploymentServiceMBean | | public interface DeploymentServiceMBean (Code) | | 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 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 |
| SHUTDOWN | | final static String SHUTDOWN(Code) | | The service assembly has been deployed, or shutdown
|
| STARTED | | final static String STARTED(Code) | | 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.
|
| STOPPED | | final static String STOPPED(Code) | | The service assembly is stopped. This means that the assembly's offered
services can accept message exchanges, but it will not send any.
|
| canDeployToComponent | | boolean canDeployToComponent(String componentName)(Code) | | 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 true if the named component accepts deployments;false if the named component does not acceptdeployments or it does not exist |
| deploy | | public String deploy(String serviceAssemblyZipUrl) throws Exception(Code) | | 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
DeploymentServiceMBean.start(String) method to be invoked by the administrative tool.
Parameters:
serviceAssemblyZipUrl - String containing the location URL of theService Assembly ZIP file; must be non-null, non-empty, and alegal URL Result/Status of the current deployment; must conform to JBI management result/status XML schema; must be non-null andnon-empty
exception:
Exception - if complete deployment fails |
| getComponentsForDeployedServiceAssembly | | String[] getComponentsForDeployedServiceAssembly(String serviceAssemblyName) throws Exception(Code) | | 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 benon-null and non-empty array of component names, where for each name the given assemblycontains a service unit from the given service assembly; mustbe non-null; may be empty
exception:
Exception - if a processing error occurs |
| getDeployedServiceAssemblies | | String[] getDeployedServiceAssemblies() throws Exception(Code) | | Returns a list of Service Assemblies deployed to the JBI environment.
list of Service Assembly names; must be non-null; may beempty
exception:
Exception - if a processing error occurs |
| getDeployedServiceAssembliesForComponent | | String[] getDeployedServiceAssembliesForComponent(String componentName) throws Exception(Code) | | 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-nulland non-empty array of of Service Assembly names, where each assembly containsa Service Unit for the named component; must be non-null; maybe empty
exception:
Exception - if a processing error occurs |
| getDeployedServiceUnitList | | String[] getDeployedServiceUnitList(String componentName) throws Exception(Code) | | 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 array of service unit names deployed in the named component;must be non-null; may be empty
exception:
Exception - if a processing error occurs |
| getServiceAssemblyDescriptor | | String getServiceAssemblyDescriptor(String serviceAssemblyName) throws Exception(Code) | | 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 descriptor of the Assembly Unit; must be non-null
exception:
Exception - if a processing error occurs |
| isDeployedServiceUnit | | boolean isDeployedServiceUnit(String componentName, String serviceUnitName) throws Exception(Code) | | Queries if the named Service Unit is currently deployed to the named
component.
Parameters:
componentName - name of the component to query; must be non-nulland non-empty
Parameters:
serviceUnitName - name of the subject service unit; must be non-nulland non-empty true if the named service unit is currently deployedto the named component |
| shutDown | | String shutDown(String serviceAssemblyName) throws Exception(Code) | | Shut down the service assembly. This puts the assembly back into the
DeploymentServiceMBean.SHUTDOWN state.
Parameters:
serviceAssemblyName - name of the assembly to be shut down; must benon-null and non-empty result / status string giving the results of shutting down each service unit in the assembly; must be non-null and non-empty
exception:
Exception - if there is no such assembly
exception:
Exception - if the assembly fails to shut down |
| start | | String start(String serviceAssemblyName) throws Exception(Code) | | Start the service assembly. This puts the assembly into the
DeploymentServiceMBean.STARTED state.
Parameters:
serviceAssemblyName - name of the assembly to be started; must benon-null and non-empty result / status string giving the results of starting (and possibly initializing) each service unit in the assembly; mustbe non-null and non-empty
exception:
Exception - if there is no such assembly
exception:
Exception - if the assembly fails to start |
| stop | | String stop(String serviceAssemblyName) throws Exception(Code) | | Stop the service assembly. This puts the assembly into the
DeploymentServiceMBean.STOPPED state.
Parameters:
serviceAssemblyName - name of the assembly to be stopped; must be non-null and non-empty result / status string giving the results of stopping each service unit in the assembly; must be non-null and non-empty
exception:
Exception - if there is no such assembly
exception:
Exception - if the assembly fails to stop |
| undeploy | | String undeploy(String serviceAssemblyName) throws Exception(Code) | | 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 Result/Status of the current undeployment; must conform to JBI management result/status XML schema; must be non-null andnon-empty
exception:
Exception - if compelete undeployment fails |
|
|
|