| com.sun.jbi.management.DeploymentServiceMBean
All known Subclasses: com.sun.jbi.management.system.DeploymentService,
| DeploymentServiceMBean | | public interface DeploymentServiceMBean extends javax.jbi.management.DeploymentServiceMBean(Code) | | This DeploymentServiceMBean extends the public interface. This has additional
operations to :
- Get the state of a particular service unit
- Deploy a service assembly from the repository
- allow forceful shutdown and undeploy of service assemblies
author:
Sun Microsystems, Inc. |
| Method Summary | |
| String | deployFromRepository(String serviceAssemblyName)
Deploy a Service Assembly from the Repository. | | public String | getServiceUnitDescriptor(String serviceAssemblyName, String serviceUnitName)
Returns the deployment descriptor of the Service Unit that was
deployed to the JBI enviroment, serialized to a String. | | String | getServiceUnitState(String componentName, String serviceUnitName)
Get the state of a service unit deployed to a component. | | String | shutDown(String serviceAssemblyName, boolean force)
Shut down the service assembly. | | String | undeploy(String serviceAssemblyName, boolean force)
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
Parameters:
force - if this flag is set to true any undeployment errors thrown from the component will be ignored as the service assembly is forcefullyundeployed. | | String | undeploy(String serviceAssemblyName, boolean force, boolean keep)
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
Parameters:
force - if this flag is set to true any undeployment errors thrown from the component will be ignored as the service assembly is forcefullyundeployed.
Parameters:
keep - if true the service assembly archive should not be removedfrom the domain. |
| deployFromRepository | | String deployFromRepository(String serviceAssemblyName) throws javax.jbi.JBIException(Code) | | Deploy a Service Assembly from the Repository.
If the service assembly is not there in the DAS repository a exception will
be thrown.
Parameters:
serviceAssemblyName - - name of the registered service assembly. a status management message with details on the service assembly deployment.
exception:
javax.jbi.JBIException - if the service assembly is not registered ordeploy fails. |
| getServiceUnitDescriptor | | public String getServiceUnitDescriptor(String serviceAssemblyName, String serviceUnitName) throws Exception(Code) | | Returns the deployment descriptor of the Service Unit 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
Parameters:
serviceUnitName - name of the service unit to be queried;must be non-null and non-empty descriptor of the Service Unit; must be non-null
exception:
Exception - if a processing error occurs |
| getServiceUnitState | | String getServiceUnitState(String componentName, String serviceUnitName) throws javax.jbi.JBIException(Code) | | Get the state of a service unit deployed to a component.
If the service unit is deployed to the component then one of the states :
"Started", "Stopped" or "Shutdown" is returned.
the actual state of the deployed service unit or "Unknown".
Parameters:
componentName - - the component name
Parameters:
serviceUnitName - - name of the service unit
exception:
javax.jbi.JBIException - if the component is not installed or if the service unit is not deployed to the component.
See Also: javax.jbi.management.DeploymentServiceMBean |
| shutDown | | String shutDown(String serviceAssemblyName, boolean force) throws Exception(Code) | | Shut down the service assembly.
Parameters:
serviceAssemblyName - name of the assembly to be shut down; must benon-null and non-empty
Parameters:
force - if this flag is true, the service assembly is shutdown forcefully.Any exceptions thrown by the component for service unit shutdown are ignored. 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 |
| undeploy | | String undeploy(String serviceAssemblyName, boolean force) 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
Parameters:
force - if this flag is set to true any undeployment errors thrown from the component will be ignored as the service assembly is forcefullyundeployed. 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 |
| undeploy | | String undeploy(String serviceAssemblyName, boolean force, boolean keep) 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
Parameters:
force - if this flag is set to true any undeployment errors thrown from the component will be ignored as the service assembly is forcefullyundeployed.
Parameters:
keep - if true the service assembly archive should not be removedfrom the domain. If false the archive is removed if the service assembly is not deployed on any instances. 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 |
|
|