com.sun.jbi.management

Interface DeploymentServiceMBean

All Superinterfaces:

DeploymentServiceMBean

public interface DeploymentServiceMBean
extends DeploymentServiceMBean

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.

Field Summary

Fields inherited from interface javax.jbi.management.DeploymentServiceMBean

SHUTDOWN, STARTED, STOPPED

Method Summary

Methods

Modifier and Type	Method and Description
String	deployFromRepository(String serviceAssemblyName) Deploy a Service Assembly from the Repository.
String	getServiceAssemblyName(String serviceUnitName, String componentName) Get the Service Assembly name for a specific service unit deployed to a specific component.
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.
String	undeploy(String serviceAssemblyName, boolean force, boolean keep) Undeploys the given Service Assembly from the JBI environment.

Methods inherited from interface javax.jbi.management.DeploymentServiceMBean

canDeployToComponent, deploy, getComponentsForDeployedServiceAssembly, getDeployedServiceAssemblies, getDeployedServiceAssembliesForComponent, getDeployedServiceUnitList, getServiceAssemblyDescriptor, getState, isDeployedServiceUnit, shutDown, start, stop, undeploy

Method Detail

getServiceUnitState

String getServiceUnitState(String componentName,
                         String serviceUnitName)
                           throws JBIException

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.

Parameters:

componentName - - the component name

serviceUnitName - - name of the service unit

Returns:

the actual state of the deployed service unit or "Unknown".

Throws:

JBIException - if the component is not installed or if the service unit is not deployed to the component.

See Also:

DeploymentServiceMBean

getServiceUnitDescriptor

String getServiceUnitDescriptor(String serviceAssemblyName,
                              String serviceUnitName)
                                throws Exception

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

serviceUnitName - name of the service unit to be queried; must be non-null and non-empty

Returns:

descriptor of the Service Unit; must be non-null

Throws:

Exception - if a processing error occurs

deployFromRepository

String deployFromRepository(String serviceAssemblyName)
                            throws JBIException

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.

Returns:

a status management message with details on the service assembly deployment.

Throws:

JBIException - if the service assembly is not registered or deploy fails.

undeploy

String undeploy(String serviceAssemblyName,
              boolean force)
                throws Exception

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

force - if this flag is set to true any undeployment errors thrown from the component will be ignored as the service assembly is forcefully undeployed.

Returns:

Result/Status of the current undeployment; must conform to JBI management result/status XML schema; must be non-null and non-empty

Throws:

Exception - if compelete undeployment fails

undeploy

String undeploy(String serviceAssemblyName,
              boolean force,
              boolean keep)
                throws Exception

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

force - if this flag is set to true any undeployment errors thrown from the component will be ignored as the service assembly is forcefully undeployed.

keep - if true the service assembly archive should not be removed from the domain. If false the archive is removed if the service assembly is not deployed on any instances.

Returns:

Result/Status of the current undeployment; must conform to JBI management result/status XML schema; must be non-null and non-empty

Throws:

Exception - if compelete undeployment fails

shutDown

String shutDown(String serviceAssemblyName,
              boolean force)
                throws Exception

Shut down the service assembly.

Parameters:

serviceAssemblyName - name of the assembly to be shut down; must be non-null and non-empty

force - if this flag is true, the service assembly is shutdown forcefully. Any exceptions thrown by the component for service unit shutdown are ignored.

Returns:

result / status string giving the results of shutting down each service unit in the assembly; must be non-null and non-empty

Throws:

Exception - if there is no such assembly

Exception - if the assembly fails to shut down

getServiceAssemblyName

String getServiceAssemblyName(String serviceUnitName,
                            String componentName)
                              throws Exception

Get the Service Assembly name for a specific service unit deployed to a specific component.

Parameters:

serviceUnitName - - service unit identifier

componentName - - component identifier

Throws:

Exception