Concrete developments steps

compared with
Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (15)

View Page History

The development of Petals ESB components is based on the use of three tools :
* Apache Maven 2 and its plugins for Petals ESB.
* aAn Integrated Development Environment (IDE) for Java development.
* tThe Petals ESB Component Development Toolkit (CDK), a Petals library which simplifies the work.

This section explains how to use them to create, compile, deploy and test a Petals component.

The first thing to do when starting working on a new component is to download and install Apache Maven 2, and a good IDE (e.g. NetBeans, Eclipse or IntelliJ).
In this document, it is assumed that you use Eclipse or NetBeans. You should be able to find out equivalent actions for other IDEs.

The first thing to do is to download Apache Maven and an IDE (e.g. Eclipse, NetBeans or IntelliJ).
In the rest of this document, it is assumed you use Eclipse as your IDE. When this document references Eclipse actions, you should be able to find equivalents with other IDEs.

{warning}For the moment, Maven 3 does not work for Petals ESB and its components. It would require some changes in the POM files.{warning}

h2. Installing and configuring Apache Maven 2
# Go into the Maven 2 local repository (typically {{C:/Documents and settings/username/.m2}} on Windows or {{/home/username/.m2}} on most Unix(es)).
# Open (or create if not present) the {{settings.xml}} file and make sure to include the repositories listed in the sample below.

{code:lang=xml}
<settings>
</settings>
{code}
Download link : [^settings.xml].
# That's it for Apache Maven 2 :-)

That's it for Apache Maven 2.

\\
{info:title=Info}
{info}

\\
{info:title=Releases vs. Snapshots}
Petals' released Maven artifacts are hosted by OW2. The Maven repository is the one given above.
However, snapshot versions are now hosted by Petals Link on its own Maven repositories. Those can be found at this address: http://maven.petalslink.com
{info}

h2. Configuring your IDE

Since modern days java developers doesn't use text editors such _vi_ or _emacs_, and since we are modern days java developers, we use Integrated Development Environment such Eclipse or NetBeans. In order to use them correctly, we must configure them.

h3. Configuring Eclipse

This section has to be completed.

h3. Configuring IntelliJ

This section has to be completed.

h1. Creating a component

First, decide whether you want to create a Binding Component (BC) or a Service Engine (SE) :
* Binding components host services that will act as entry points and exit points for communication protocols. They are intermediaries between what is inside the bus and what is outside.
* Service engines host configured services, such as a XSLT transformation, or a BPEL application.

In both cases, these services service-units instantiate the features offered by the component, by providing a configuration and artifacts.

Once this is done, you should pick up a name for your component, following the Petals ESB component naming conventions :
* _petals-bc-componentName_ for binding components.
* _petals-se-componentName_ for service engines.
This secction has to be completed.

h3. Using IntelliJ

This secction has to be completed.

h2. Testing a component