com.sun.jbi.management.facade

Class DeploymentService

java.lang.Object

com.sun.jbi.management.facade.Facade

com.sun.jbi.management.facade.DeploymentService

All Implemented Interfaces:

DeploymentServiceMBean

public class DeploymentService
extends Facade
implements DeploymentServiceMBean

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 schemaorg_apache_xmlbeans.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.
• Query the deployment unit for a particular service unit.

Author:

Sun Microsystems, Inc.

Field Summary

Fields inherited from class com.sun.jbi.management.facade.Facade

CONFIG_SCHEMA_PATH, DOMAIN, MASKED_FIELD_VALUE, mComponentConfigSchema, mEnvCtx, mLog, mMBeanNames, mMBeanSvr, mMgtCtx, mMsgBuilder, mPlatform, mTarget, mTranslator, PASSWORD, SERVER, sTypeMap, WORKSPACE_ROOT

Fields inherited from interface javax.jbi.management.DeploymentServiceMBean

SHUTDOWN, STARTED, STOPPED

Constructor Summary

Constructors

Constructor and Description
DeploymentService(EnvironmentContext ctx, String target)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canDeployToComponent(String componentName) Returns true if the the given component accepts the deployment of service units.
String	deploy(String serviceAssemblyZipUrl) Deploys the given Service Assembly to the JBI environment.
String	deployFromRepository(String serviceAssemblyName) Deploy a Service Assembly from the Repository.
String[]	getComponentsForDeployedServiceAssembly(String serviceAssemblyName) Returns an array of component names, where for each the given assembly contains a service unit for the component.
String[]	getDeployedServiceAssemblies() Returns a list of Service Assemblies deployed to the JBI environment.
String[]	getDeployedServiceAssembliesForComponent(String componentName) Returns an array of Service Assembly names, each service assembly in the returned list has a service unit deployed to the component
String[]	getDeployedServiceUnitList(String componentName) Returns an array of service unit names that are currently deployed to the named component.
String	getServiceAssemblyDescriptor(String serviceAssemblyName) Returns the deployment descriptor of the Service Assembly that was deployed to the JBI enviroment, serialized to a String.
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	getState(String serviceAssemblyName) Get the running state of a service assembly.
boolean	isDeployedServiceUnit(String componentName, String serviceUnitName) Queries if the named Service Unit is currently deployed to the named component.
boolean	isServiceAssemblyDeployedInInstance(String saName, String instanceName) This method is used to find out if a SA is deployed in the given instance.
String	shutDown(String serviceAssemblyName) Shut down the service assembly.
String	shutDown(String serviceAssemblyName, boolean force) Shut down the service assembly.
String	start(String serviceAssemblyName) Start the service assembly.
String	stop(String serviceAssemblyName) Stop the service assembly.
String	undeploy(String serviceAssemblyName) Undeploys the given Service Assembly from the JBI environment.
String	undeploy(String serviceAssemblyName, boolean force) Undeploys the given Service Assembly from the target.
String	undeploy(String serviceAssemblyName, boolean force, boolean keep) Undeploys the given Service Assembly from the JBI environment.

Methods inherited from class com.sun.jbi.management.facade.Facade

archiveEqualityCheck, areAllInstancesUp, componentInstallationCheck, convertToString, fromFileURL, getAllTargets, getComponentConfigurationData, getComponentConfigurationNS, getComponentConfigurationSchema, getComponentLifeCycleMBeanName, getComponentQuery, getComponentQuery, getComponentState, getComponentStateOnInstance, getComponentType, getFacadeInstallerMBeanName, getFacadeInstallerMBeanName, getGenericQuery, getMBeanServerConnection, getRegistry, getRemoteAdminServiceObjectName, getRemoteAttribute, getRemoteAttributes, getServiceAssemblyQuery, getUpdater, handleClusteredInstanceFailures, initPrimitiveTypeMap, instanceRunningCheck, invokeLocalOperation, invokeRemoteOperation, invokeRemoteVoidOperation, isComponentInstalled, isInstanceRunning, isMBeanRegisteredOnInstance, isSharedLibraryInstalled, isTargetUp, mbeanRegistrationCheck, setRemoteAttribute, setRemoteAttributes, sharedLibraryInstallationCheck, throwNotSupportedManagementException, toFileURL, unregisterComponentConfigurationMBean, unregisterComponentConfigurationMBean, unregisterComponentExtensionMBean, unregisterComponentExtensionMBean, unregisterComponentLifeCycleMBean, unregisterComponentLifeCycleMBean, uploadFile, validateArchive

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeploymentService

public DeploymentService(EnvironmentContext ctx,
                 String target)
                  throws ManagementException

Throws:

ManagementException

Method Detail

deploy

public String deploy(String serviceAssemblyZipUrl)
              throws Exception

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 start(String) method to be invoked by the administrative tool.
For the domain target, deploy only validates the service assembly and then adds it to the Registry / Repository.

Specified by:

deploy in interface DeploymentServiceMBean

Parameters:

serviceAssemblyZipUrl - String containing the location URL of the Service Assembly ZIP file; must be non-null, non-empty, and a legal URL

Returns:

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

Throws:

Exception - if complete deployment fails

undeploy

public String undeploy(String serviceAssemblyName)
                throws Exception

Undeploys the given Service Assembly from the JBI environment.
For the domain target, undeploy removes the service assembly from the registry / repository only if the service assembly is not deployed on any servers / clusters.
For target other than the domain, the Service Assembly is undeployed first. If the service assembly is not deployed on any server / cluster after this action, then the service assembly is removed.

Specified by:

undeploy in interface DeploymentServiceMBean

Parameters:

serviceAssemblyName - name of the Service Assembly that is to be undeployed; must be non-null and non-empty

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

start

public String start(String serviceAssemblyName)
             throws Exception

Start the service assembly. This puts the assembly into the DeploymentServiceMBean.STARTED state.

Specified by:

start in interface DeploymentServiceMBean

Parameters:

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

Returns:

result / status string giving the results of starting (and possibly initializing) 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 start

stop

public String stop(String serviceAssemblyName)
            throws Exception

Stop the service assembly. This puts the assembly into the DeploymentServiceMBean.STOPPED state.

Specified by:

stop in interface DeploymentServiceMBean

Parameters:

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

Returns:

result / status string giving the results of stopping 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 stop

shutDown

public String shutDown(String serviceAssemblyName)
                throws Exception

Shut down the service assembly. This puts the assembly back into the DeploymentServiceMBean.SHUTDOWN state.

Specified by:

shutDown in interface DeploymentServiceMBean

Parameters:

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

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

canDeployToComponent

public boolean canDeployToComponent(String componentName)

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.

Specified by:

canDeployToComponent in interface DeploymentServiceMBean

Parameters:

componentName - name of the component; must be non-null and non-empty

Returns:

true if the named component accepts deployments; false if the named component does not accept deployments or it does not exist

getDeployedServiceUnitList

public String[] getDeployedServiceUnitList(String componentName)
                                    throws Exception

Returns an array of service unit names that are currently deployed to the named component.

Specified by:

getDeployedServiceUnitList in interface DeploymentServiceMBean

Parameters:

componentName - the name of the component to query; must be non-null and non-empty

Returns:

array of service unit names deployed in the named component; must be non-null; may be empty

Throws:

Exception - if a processing error occurs

getDeployedServiceAssemblies

public String[] getDeployedServiceAssemblies()
                                      throws Exception

Returns a list of Service Assemblies deployed to the JBI environment.

Specified by:

getDeployedServiceAssemblies in interface DeploymentServiceMBean

Returns:

list of Service Assembly names; must be non-null; may be empty

Throws:

Exception - if a processing error occurs

getServiceAssemblyDescriptor

public String getServiceAssemblyDescriptor(String serviceAssemblyName)
                                    throws Exception

Returns the deployment descriptor of the Service Assembly that was deployed to the JBI enviroment, serialized to a String.

Specified by:

getServiceAssemblyDescriptor in interface DeploymentServiceMBean

Parameters:

serviceAssemblyName - name of the service assembly to be queried; must be non-null and non-empty

Returns:

descriptor of the Assembly Unit; must be non-null

Throws:

Exception - if a processing error occurs

getServiceUnitDescriptor

public 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

getDeployedServiceAssembliesForComponent

public String[] getDeployedServiceAssembliesForComponent(String componentName)
                                                  throws Exception

Returns an array of Service Assembly names, each service assembly in the returned list has a service unit deployed to the component

Specified by:

getDeployedServiceAssembliesForComponent in interface DeploymentServiceMBean

Parameters:

componentName - name of the component to query; must be non-null and non-empty

Returns:

array of of Service Assembly names, where each assembly contains a Service Unit for the named component; must be non-null; may be empty

Throws:

Exception - if a processing error occurs

getServiceAssemblyName

public 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

Returns:

the parent service assembly name for the specified service unit deployed to the specific component. If the service unit is not deployed a null value is returned.

Throws:

Exception

getComponentsForDeployedServiceAssembly

public String[] getComponentsForDeployedServiceAssembly(String serviceAssemblyName)
                                                 throws Exception

Returns an array of component names, where for each the given assembly contains a service unit for the component.

Specified by:

getComponentsForDeployedServiceAssembly in interface DeploymentServiceMBean

Parameters:

serviceAssemblyName - the service assembly to be queried; must be non-null and non-empty

Returns:

array of component names, where for each name the given assembly contains a service unit from the given service assembly; must be non-null; may be empty

Throws:

Exception - if a processing error occurs

isDeployedServiceUnit

public boolean isDeployedServiceUnit(String componentName,
                            String serviceUnitName)
                              throws Exception

Queries if the named Service Unit is currently deployed to the named component.

Specified by:

isDeployedServiceUnit in interface DeploymentServiceMBean

Parameters:

componentName - name of the component to query; must be non-null and non-empty

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

Returns:

true if the named service unit is currently deployed to the named component

Throws:

Exception

getState

public String getState(String serviceAssemblyName)
                throws Exception

Get the running state of a service assembly. The possible result values of this query are enumerated by the following set of constants: DeploymentServiceMBean.SHUTDOWN, DeploymentServiceMBean.STOPPED, DeploymentServiceMBean.STARTED.

Specified by:

getState in interface DeploymentServiceMBean

Parameters:

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

Returns:

the state of the service assembly, as a string value; must be one of the enumerated string values provided by this interface: DeploymentServiceMBean.SHUTDOWN, DeploymentServiceMBean.STOPPED, or DeploymentServiceMBean.STARTED

Throws:

Exception - if there is no such assembly

getServiceUnitState

public 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

deployFromRepository

public 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

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

Undeploys the given Service Assembly from the target. If the service assembly is not deployed on any targets after undeploying from this target the service assembly is removed from the domain.

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

public 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

public 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

isServiceAssemblyDeployedInInstance

public boolean isServiceAssemblyDeployedInInstance(String saName,
                                          String instanceName)
                                            throws ManagementException

This method is used to find out if a SA is deployed in the given instance.

Parameters:

saName - - the SA name

instaneName - - the instance name

Returns:

boolean - true if the given SA is deployed

Throws:

Exception

ManagementException