Chapter 1. Component management
	PEtALS Components User Guide

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

You need to copy in the same directory than your build.xml file the following resources :

PETALS_HOME/ant/petals-ant.jar
PETALS_HOME/ant/taskdef.properties

1.1.1. Installation

To install your component on PEtALS, add the following task in a target of your build.xml file :

<jbi-install-component file = "file:///home/.../component.zip">

Table 1.1. ANT component installation attributes

Attribute	Description	Default	Required
host	Target server on which JBI Environment is running.	"localhost"	No
port	JMX Remote port on the target server.	"7700"	No
username	JMX User name for security.	""	No
password	JMX Password for security.	""	No
file	Fully qualified URL of the component archive location. Valid URL for Unix-like is `file:///home/...`. Valid URL for Windows is `file:///C:/directory/...`. The archive contains a component installation package, as described in the JBI1.0 specification.		Yes
failOnError	Signal task failure to Ant. true or false.	"true"	No
params	Location of a text file (e.g. configuration.properties) that contains name/value pairs corresponding to the configuration properties of the component.		No

1.1.2. Configuration

The component can be configured during the installation phase. Each component has its own installation parameters. See the various components guide for specific configuration.

Use the params element of the jbi-install-component ANT task to configure your component :

<jbi-install-component file = "file:///home/.../component.zip"/>
 <param name="attributeName1" value="attributeValue1"/>
  <param name="attributeName2" value="attributeValue2"/>
</jbi-install-component>

Or using a separate property file :

<jbi-install-component file = "file:///home/.../component.zip" params="dir/params.properties"/>

where params.properties contains:
  attributeName1=attributeValue1
  attributeName2=attributeValue2

1.1.3. Start, Stop, Shutdown

To start, stop or shurdown your component, add the following task in a target of your build.xml file :

<jbi-start-component name="component-name"/>

<jbi-stop-component name="component-name"/>

<jbi-shut-down-component name="component-name"/>

Table 1.2. ANT component start, stop or shutdown attributes

Attribute	Description	Default	Required
host	Target server on which JBI Environment is running.	"localhost"	No
port	JMX Remote port on the target server.	"7700"	No
username	JMX User name for security.	""	No
password	JMX Password for security.	""	No
name	Name of the JBI component in the JBI Environment to start.		Yes
failOnError	Signal task failure to Ant. true or false.	"true"	No

1.1.4. Uninstallation

To uninstall your component from PEtALS, add the following task in a target of your build.xml file :

<jbi-uninstall-component name="component-name">

Table 1.3. ANT component uninstallation

Attribute	Description	Default	Required
host	Target server on which JBI Environment is running.	"localhost"	No
port	JMX Remote port on the target server.	"7700"	No
username	JMX User name for security.	""	No
password	JMX Password for security.	""	No
name	Name of the JBI component in the JBI Environment to start.		Yes
failOnError	Signal task failure to Ant. true or false.	"true"	No

1.2. Hot Deployment

1.2.1. Installation and Start

The component can be automatically installed and started by copying the archive file into the $PETALS_HOME/install directory.

	Caution
	The installation and the start of the component are sequentially performed. So you can not configure the component in this mode. To change the default configuration of the component, you need to edit and change the META-INF/jbi.xml file contained in the component archive, before installing it.

1.2.2. Stop and Uninstall

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

1.3. JMX

The component 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 1.4. JMX connection attributes

Attribute	Description	Default	Required
host	Target server on which JBI Environment is running.		Ytes
port	JMX Remote port on the target server.		Yes
username	JMX User name for security.	""	No
password	JMX Password for security.	""	No