com.sun.jbi.management.system

Class DeploymentService

java.lang.Object

com.sun.jbi.management.system.ModelSystemService

com.sun.jbi.management.system.DeploymentService

All Implemented Interfaces:

DeploymentServiceMBean, LifeCycleMBean, NotificationBroadcaster, NotificationEmitter

public class DeploymentService
extends ModelSystemService
implements DeploymentServiceMBean

This is the Deployment Service, which is responsible for the management and administration of Service Assemblies.

Author:

Sun Microsystems, Inc.

Field Summary

Fields inherited from class com.sun.jbi.management.system.ModelSystemService

mAdminServiceMBeanName, mConfigServiceMBeanName, mDeployServiceMBeanName, mDisplayName, mEnv, mInitialMBeans, mInstallServiceMBeanName, mLifeCycleMBeanName, mLogger, mLoggerImpl, mLoggerMBeanName, mLoggingServiceMBeanName, mMBeanNames, mMBeanServer, mMessageServiceMBeanName, mModelName, mStartMBeans, mStatisticsMBeanName

Fields inherited from interface javax.jbi.management.DeploymentServiceMBean

STARTED, STOPPED

Fields inherited from interface javax.jbi.management.LifeCycleMBean

STARTED, STOPPED, UNKNOWN

Constructor Summary

Constructors

Constructor and Description
DeploymentService(ManagementContext anEnv) Constructs a DeploymentService.

Method Summary

Methods

Modifier and Type	Method and Description
HashMap	activateConnections(String saName, boolean xmlMsg) Activate Service Connections defined in the specified Service Assembly.
boolean	canDeployToComponent(String componentName) Get the status to see if SU can be deployed based on component state.
String	deploy(String saZipURL) Deploy a Service Assembly (SA) to the JBI framework.
String	deployFromRepository(String serviceAssemblyName) Deploy a Service Assembly from the Repository.
void	disableStatistics() This method is used to disable statistics collection in deployment service
void	enableStatistics() This method is used to enable statistics collection in deployment service
ServiceUnitState	getActualServiceUnitState(String compName, String suName) Get the actual state of a service unit.
String[]	getComponentsForDeployedServiceAssembly(String saName) Returns a list of components(to which SUs are targeted for) in a Service Assembly.
ComponentState	getComponentState(String compName) Get the actual state of the component from the ComponentLifeCycleMBean.
Element	getConnectionsElement(String saName) Get the Connections Element from the Service Assembly Deployment descriptor
String[]	getDeployedServiceAssemblies() Returns a list of Service Assemblies deployed to the JBI enviroment.
String[]	getDeployedServiceAssembliesForComponent(String componentName) Returns a list of Service Assemblies that contain SUs for the given component.
String[]	getDeployedServiceUnitList(String componentName) Get list of deployed service units to the component.
ObjectName	getLifeCycleMBeanObjectName(String aCompName) returns the ObjectName for the lifecycle Mbean of this component.
Link	getLinkType(String fromEndpoint, String saName) Get the link-type for the Endpoint from the Service Units in the Service Assembly.
MBeanServerConnection	getMBeanServerConnection() Get the MBean Server
String	getServiceAssemblyDescriptor(String saName) Returns the descriptor of Service Assembly (SA) deployed.
String	getServiceAssemblyName(String serviceUnitName, String componentName) Get the Service Assembly name for a specific service unit deployed to a specific component.
ServiceAssemblyStatistics	getServiceAssemblyStatistics(String saName) This method is used to get statistics for the given SA
String	getServiceUnitDescriptor(String saName, String suName) Returns the descriptor of Service Unit(SU) deployed.
ServiceUnitInfo	getServiceUnitInfo(String compName, String suName) Get framework information on a service unit.
String	getServiceUnitState(String componentName, String serviceUnitName) Get the state of a service unit deployed to a component.
String	getState(String serviceAssemblyName)
protected void	initModelSystemService(EnvironmentContext anEnv) local model init - called by constructor - create custom mbeans.
boolean	isDeployedServiceUnit(String componentName, String serviceUnitName) Get the status of deployed service unit.
boolean	isStatisticsEnabled() This method is used to enable statistics collection in deployment service
Iterator	listServiceAssemblies(String compName)
String	registerServiceUnit(String compName, String saName, String suName, String suRootPath)
void	removeStatsObject(String saName) This method is used to remove the statistics object of the given SA.
void	shutDown() Shut down the DeploymentService.
String	shutDown(String serviceAssemblyName) Shutdown the service assembly and puts it in SHUTDOWN state.
String	shutDown(String serviceAssemblyName, boolean force) Shut down the service assembly.
String	start(String serviceAssemblyName) Starts the service assembly and puts it in STARTED state.
void	startAllServiceAssemblies() Bring all Service Assemblies to their desired states.
String	stop(String serviceAssemblyName) Stops the service assembly and puts it in STOPPED state.
String	undeploy(String saName) Undeploy a Service Assembly from the JBI framework.
String	undeploy(String serviceAssemblyName, boolean force) Undeploys the given Service Assembly from the JBI environment.
String	undeploy(String saName, boolean force, boolean keep) Undeploys the given Service Assembly from the JBI environment.
String	unregisterServiceUnit(String compName, String suName)
String	updateSAState(String saName) Determines the appropriate state for a service assembly.
void	updateServiceAssemblyConnections(String compName) Activate the Service Connections if SA state is Started, deactivate the connections if state is Stopped or Shutdown.

Methods inherited from class com.sun.jbi.management.system.ModelSystemService

addNotificationListener, bootstrap, getComponentQuery, getCurrentState, getNotificationBroadcaster, getNotificationInfo, getRegistry, initModelSystemService, initModelSystemService, removeNotificationListener, removeNotificationListener, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

DeploymentService

public DeploymentService(ManagementContext anEnv)
                  throws JBIException

Constructs a DeploymentService.

Parameters:

anEnv - ManagementContext.

Throws:

JBIException

Method Detail

initModelSystemService

protected void initModelSystemService(EnvironmentContext anEnv)

local model init - called by constructor - create custom mbeans.

deploy

public String deploy(String saZipURL)
              throws Exception

Deploy a Service Assembly (SA) to the JBI framework.

Specified by:

deploy in interface DeploymentServiceMBean

Parameters:

saZipURL - The URL of the Service Assembly.

Returns:

A string containing the status of Service Assembly deployment including messages from components.

Throws:

Exception - If failed to deploy an SA.

undeploy

public String undeploy(String saName)
                throws Exception

Undeploy a Service Assembly from the JBI framework.

Specified by:

undeploy in interface DeploymentServiceMBean

Parameters:

saName - - service assembly name

Returns:

A string containing the status of Service Assembly undeployment including messages from components.

Throws:

Exception - if undeploy fails.

getDeployedServiceUnitList

public String[] getDeployedServiceUnitList(String componentName)
                                    throws Exception

Get list of deployed service units to the component.

Specified by:

getDeployedServiceUnitList in interface DeploymentServiceMBean

Parameters:

componentName - The name of the component.

Returns:

A string array containing the list of service units deployed to the component.

Throws:

Exception - If component throws an exception

isDeployedServiceUnit

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

Get the status of deployed service unit.

Specified by:

isDeployedServiceUnit in interface DeploymentServiceMBean

Parameters:

componentName - The name of the component.

serviceUnitName - name of the service unit.

Returns:

A boolean value indicating whether the service unit is deployed or not.

Throws:

Exception - If component throws an exception

getServiceUnitInfo

public ServiceUnitInfo getServiceUnitInfo(String compName,
                                 String suName)

Get framework information on a service unit.

Parameters:

compName - The ID of the component.

suName - The ID of the service unit.

Returns:

ServiceUnitInfo service unit information.

canDeployToComponent

public boolean canDeployToComponent(String componentName)

Get the status to see if SU can be deployed based on component state.

Specified by:

canDeployToComponent in interface DeploymentServiceMBean

Parameters:

componentName - The name of the component.

Returns:

A boolean value indicating whether the service unit can be deployed or not.

getLifeCycleMBeanObjectName

public ObjectName getLifeCycleMBeanObjectName(String aCompName)
                                       throws Exception

returns the ObjectName for the lifecycle Mbean of this component.

Parameters:

aCompName - id of a binding or engine component

Returns:

the ObjectName for the lifecycle Mbean.

Throws:

Exception - If failed to lookup object name

getDeployedServiceAssemblies

public String[] getDeployedServiceAssemblies()
                                      throws Exception

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

Specified by:

getDeployedServiceAssemblies in interface DeploymentServiceMBean

Returns:

list of Service Assembly names

Throws:

Exception - If failed to retrieve SA Ids

getDeployedServiceAssembliesForComponent

public String[] getDeployedServiceAssembliesForComponent(String componentName)
                                                  throws Exception

Returns a list of Service Assemblies that contain SUs for the given component.

Specified by:

getDeployedServiceAssembliesForComponent in interface DeploymentServiceMBean

Parameters:

componentName - Name of the component

Returns:

list of Service Assembly names

Throws:

Exception - If fails to retrieve SA Ids

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 saName)
                                                 throws Exception

Returns a list of components(to which SUs are targeted for) in a Service Assembly.

Specified by:

getComponentsForDeployedServiceAssembly in interface DeploymentServiceMBean

Parameters:

saName - name of the Service Assembly

Returns:

list of component names

Throws:

Exception - If fails to retrieve component Ids

getServiceAssemblyDescriptor

public String getServiceAssemblyDescriptor(String saName)
                                    throws Exception

Returns the descriptor of Service Assembly (SA) deployed.

Specified by:

getServiceAssemblyDescriptor in interface DeploymentServiceMBean

Parameters:

saName - name of the service assembly

Returns:

descriptor of Service Assembly (SA)

Throws:

Exception - If fails to retrieve deployment descriptor

getServiceUnitDescriptor

public String getServiceUnitDescriptor(String saName,
                              String suName)
                                throws UnsupportedOperationException

Returns the descriptor of Service Unit(SU) deployed.

Parameters:

saName - name of the service assembly

saName - name of the service unit

Returns:

descriptor of Service Unit(SU)

Throws:

Exception - If fails to retrieve deployment descriptor

UnsupportedOperationException

getComponentState

public ComponentState getComponentState(String compName)

Get the actual state of the component from the ComponentLifeCycleMBean.

Parameters:

compName - The ID of the component.

Returns:

the component state, if the component is not installed a value of ComponentState.UNKNOWN is returned.

getActualServiceUnitState

public ServiceUnitState getActualServiceUnitState(String compName,
                                         String suName)

Get the actual state of a service unit.

Parameters:

compName - The ID of the component.

suName - The ID of the service unit.

Returns:

int value indicating the service unit state.

registerServiceUnit

public String registerServiceUnit(String compName,
                         String saName,
                         String suName,
                         String suRootPath)
                           throws Exception

Throws:

Exception

unregisterServiceUnit

public String unregisterServiceUnit(String compName,
                           String suName)
                             throws Exception

Parameters:

compName - - target component for service unit unregistration

suName - - name of service unit to unregister

Throws:

Exception

shutDown

public void shutDown()
              throws JBIException

Shut down the DeploymentService.

Specified by:

shutDown in interface LifeCycleMBean

Overrides:

shutDown in class ModelSystemService

Throws:

JBIException - if the item fails to shut down.

getMBeanServerConnection

public MBeanServerConnection getMBeanServerConnection()

Get the MBean Server

Returns:

thge MBean Server reference.

start

public String start(String serviceAssemblyName)
             throws Exception

Starts the service assembly and puts it in STARTED state.

Specified by:

start in interface DeploymentServiceMBean

Parameters:

serviceAssemblyName - - name of the service assembly.

Returns:

Result/Status of this operation.

Throws:

Exception - if operation fails.

stop

public String stop(String serviceAssemblyName)
            throws Exception

Stops the service assembly and puts it in STOPPED state.

Specified by:

stop in interface DeploymentServiceMBean

Parameters:

serviceAssemblyName - - name of the service assembly.

Returns:

Result/Status of this operation.

Throws:

Exception - if operation fails.

shutDown

public String shutDown(String serviceAssemblyName)
                throws Exception

Shutdown the service assembly and puts it in SHUTDOWN state.

Specified by:

shutDown in interface DeploymentServiceMBean

Parameters:

serviceAssemblyName - - name of the service assembly.

Returns:

Result/Status of this operation.

Throws:

Exception - if operation fails.

getState

public String getState(String serviceAssemblyName)
                throws Exception

Specified by:

getState in interface DeploymentServiceMBean

Throws:

Exception

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.
This is a NOP.

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 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

public String undeploy(String saName,
              boolean force,
              boolean keep)
                throws Exception

Undeploys the given Service Assembly from the JBI environment.

Parameters:

saName - 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. This flag is ignored on the instance.

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

activateConnections

public HashMap activateConnections(String saName,
                          boolean xmlMsg)
                            throws Exception

Activate Service Connections defined in the specified Service Assembly.

Parameters:

saName - The name of the Service Assembly.

xmlMsg - When set to true, requests that error messages returned in the HashMap be in XML management message format. When set to false, error messages are in text format.

Returns:

a HashMap of result messages with the endpoint or interface names as the keys.

Throws:

Exception - if an unrecoverable error occurs.

listServiceAssemblies

public Iterator listServiceAssemblies(String compName)

updateServiceAssemblyConnections

public void updateServiceAssemblyConnections(String compName)

Activate the Service Connections if SA state is Started, deactivate the connections if state is Stopped or Shutdown.

updateSAState

public String updateSAState(String saName)

Determines the appropriate state for a service assembly. This code is necessary because the component autostart information may only be part of the picture for a given SA (which can include multiple SUs, targeted at multiple components).

getConnectionsElement

public Element getConnectionsElement(String saName)
                              throws Exception

Get the Connections Element from the Service Assembly Deployment descriptor

Throws:

Exception

getLinkType

public Link getLinkType(String fromEndpoint,
               String saName)
                 throws Exception

Get the link-type for the Endpoint from the Service Units in the Service Assembly. The DOM processing should be replaced by using JAXB.

Parameters:

fromEndpoint - - the connection consumer service endpoint

saName - - the service assembly name

Throws:

Exception

disableStatistics

public void disableStatistics()

This method is used to disable statistics collection in deployment service

enableStatistics

public void enableStatistics()

This method is used to enable statistics collection in deployment service

isStatisticsEnabled

public boolean isStatisticsEnabled()

This method is used to enable statistics collection in deployment service

getServiceAssemblyStatistics

public ServiceAssemblyStatistics getServiceAssemblyStatistics(String saName)
                                                       throws RuntimeException

This method is used to get statistics for the given SA

Parameters:

saName - the servie assembly name

Returns:

ServiceAssemblyStatistics sa Stats

Throws:

RuntimeException - is statistics for this SA are not available

removeStatsObject

public void removeStatsObject(String saName)

This method is used to remove the statistics object of the given SA. This object is removed after a SA is undeployed.

Parameters:

saName - the service assembly name

startAllServiceAssemblies

public void startAllServiceAssemblies()

Bring all Service Assemblies to their desired states. This is done only during startup of the runtime, after all components have been brought to their desired states. Any failures that occur here are logged. Note: There is a requirement in the JSR208 specification that all Service Units must be initialized during startup of the runtime to eliminate the need for components to persist SU information. This means that for any SUs whose containing SA has a desired state of "Shutdown", the SU must be shut down after it is initialized. Here is the text from the JSR208 specification: JBI implementations MUST retain the running state of all service unit deployments, such that the schemaorg_apache_xmlbeans.system can be restarted from a shutdown or crash, and all deployments will be restored to their previous running state. During component restart, the implementation MUST perform the following to restore a service unit to its previous state:

• Started. The implementation MUST call init(), followed by start().
• Stopped. The implementation MUST call init() to restore a service unit to the stopped state.
• Shutdown. The implementation MUST call init() followed by shutDown() to restore a service unit to the shutdown state.
In all cases of state restoration, the implementation MUST call init() for all service units in the group being restored before any other life cycle methods for service units in the group are called In support of the above requirement, this method first initializes ALL deployed Service Assemblies. After that, all deployed SAs are brought to their desired states, either "Shutdown", "Stopped", or "Started".