PEtALS

Chapter 2. Service Deployment
Prev PEtALS Components User Guide Next

Table of Contents

2.1. Package the Configuration
2.1.1. Service Assembly descriptor
2.1.2. Service Assembly packaging
2.2. ANT Task
2.2.1. Deployment
2.2.2. Start, Stop, Shutdown
2.2.3. Undeployment
2.3. Hot Deployment
2.3.1. Deployment and Start
2.3.2. Stop and Undeployment
2.4. JMX
2.4.1. Deployment
2.4.2. Start, Stop, Shutdown
2.4.3. Undeployment

A Service Unit is the way to configure component to provide or consume a service in the environment.

For instance, a ServiceUnit can be deployed on a SOAP Binding Component either

A ServiceUnit is a package that contains all the artefacts that need a component to provide or consume a service.

This package is a zip archive, and is opaque to the PEtALS container. The content of the package is component-specific.

All the PEtALS components are based on the same framework, and the structure of their SeviceUnit packages are the same one :

service-unit.zip
  + META-INF
       - jbi.xml (mandatory, specific to each component)
       - service.wsdl (optional)
  - ... extra artefacts (optional, depending on the component)

To deploy a Service Unit, it has to be package itself in another archive, called a ServiceAssembly.

A Service Assembly is a set of Service Unit, and optionnaly defines JBI connections. It also contains a jbi.xml descriptor.

The Service Assembly descriptor file (jbi.xml) looks like this :

<jbi version="1.0" xmlns='http://java.sun.com/xml/ns/jbi'
  xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>

  <service-assembly>
    <identification>
      <name>petals-service-assembly-name</name>
      <description>Service Assembly</description>
    </identification>

  <service-unit>
    <identification>
      <name>service-unit-for-a-component</name>
      <description>Service Unit description</description>
    </identification>

    <target>
      <artifacts-zip>service-unit.zip</artifacts-zip>
      <component-name>component-name</component-name>
    </target>
  </service-unit>

  ... if there is other service units to deploy, add other 'service-unit' elements

</service-assembly>
</jbi>

Service Assembly elements :

Table 2.1. service-assembly attributes

AttributeDescriptionRequired
service-assembly/identification/nameName of the service assembly, must be unique in the container.Yes
service-unit/identification/nameName of the service unit, must be unique for the component it is addressedYes
service-unit/target/artifacts-zipName of the service-unit archive, that must be contained in the service-assembly archive.Yes
service-unit/target/component-nameName of the Component on which to deploy the service unit to.Yes

The Service Assembly archive has to contain the following elements, packaged in an archive :

service-assembly.zip
  + META-INF
       - jbi.xml (as defined above)
  - service-unit1.zip
  - service-unit2.zip
  - ...

The Service Assembly can be deployed using specific JBI tasks.

Include the following code into your build.xml file to reference them :

<path id="jbitask.classpath">
  <pathelement location="petals-ant.jar" />
</path>

<!-- import taskdef of Petals ant tasks into this ant file-->
<taskdef file="taskdef.properties">
  <classpath refid="jbitask.classpath"/>
</taskdef>

To deploy your ServiceAssembly (that contains one or more Service Units for components), use the following task in a target of a build.xml file to deploy the Service Assembly :

<jbi-deploy-service-assembly file = "file:///home/.../service-assembly.zip"/>

Table 2.2. ANT service-assembly deployment attributes

AttributeDescriptionDefaultRequired
hostTarget server on which JBI Environment is running."localhost"No
portJMX Remote port on the target server."7700"No
usernameJMX User name for security.""No
passwordJMX Password for security.""No
fileFully qualified URL of the service-assembly archive location. Valid URL for Unix-like is file:///home/.... Valid URL for Windows is file:///C:/directory/.... The archive contains a service-assembly package, as described in the JBI1.0 specification. Yes
failOnErrorSignal task failure to Ant. true or false."true"No

To start, stop or shutdown your Service Assembly, add the following task in a target of your build.xml file to start the Service Assembly :

<jbi-start-service-assembly name = "service-assembly-name"/>
<jbi-stop-service-assembly name = "service-assembly-name"/>
<jbi-shut-down-service-assembly name = "service-assembly-name"/>

Table 2.3. ANT service-assembly start, stop or shutdown attributes

AttributeDescriptionDefaultRequired
hostTarget server on which JBI Environment is running."localhost"No
portJMX Remote port on the target server."7700"No
usernameJMX User name for security.""No
passwordJMX Password for security.""No
nameName of the service-assembly, as defined in the META-INF/jbi.xml service-assembly descriptor. Yes
failOnErrorSignal task failure to Ant. true or false."true"No

To undeloy a Service Assembly, add the following task in a target of your build.xml file to start the Service Assembly :

<jbi-undeploy-service-assembly name = "service-assembly-name"/>

Table 2.4. ANT service-assembly undeployment attributes

AttributeDescriptionDefaultRequired
hostTarget server on which JBI Environment is running."localhost"No
portJMX Remote port on the target server."7700"No
usernameJMX User name for security.""No
passwordJMX Password for security.""No
nameName of the service-assembly, as defined in the META-INF/jbi.xml service-assembly descriptor. Yes
failOnErrorSignal task failure to Ant. true or false."true"No

The Service Assembly containing your Service Unit can be automatically deployed and started by copying the archive file into the $PETALS_HOME/install repository.

[]Caution

The deployment phase and the start phase are performed. Be sure that the deployment of a service for a component do not need some extra processing between those 2 phases.

The component can be automatically stopped, sutdown and uninstalled by deleting the archive file into the $PETALS_HOME/installed directory.

The Service Assembly can be managed using the JMX administration of PEtALS.

To connect to a PEtALS JMX server with RMI, use the following URI :

service:jmx:rmi:///jndi/rmi://<host>:<port>/management/rmi-jmx-connector

Table 2.5. JMX connection attributes

AttributeDescriptionDefaultRequired
hostTarget server on which JBI Environment is running. Ytes
portJMX Remote port on the target server. Yes
usernameJMX User name for security.""No
passwordJMX Password for security.""No

To deploy the ServiceAssembly, use the DeploymentServiceMBean.

The name of the DeploymentService MBean is :

The method to call is :

The serviceAssemblyArchiveURI is the fully qualified URI of the service assembly archive location. Valid URLI for Unix-like is file:///home/.... Valid URL for Windows is file:///C:/directory/.... The archive contains a service assembly package, as described in the JBI1.0 specification.

The lifecycle of the service assembly is managed thanks to the DeploymentServiceMBean.

Use the DeploymentServiceMBean :

The methods to start, stop or shutdown the service assembly are

The undeployment of the service assembly is done with the DeploymentService MBean.

Use the DeploymentService of the component:

The method to uninstall the component is

[]Caution

The service assembly must be in the shutdown state to be uninstalled.

Prev Up Next
Chapter 1. Component management Home PEtALS-BC-Filetransfer