Extending BPELUnit

BPELUnit contains various extension points and API. This section contains instructions for setting up an environment for working with the BPELUnit source code, developing extensions and clients.

Contents

Installing the source

Developing extensions

Using the API

Installing the source

The BPELUnit source is available via anonymous CVS in the form of Eclipse plugins. To download the plugins in Eclipse, do the following:

Select File > Import...
Select CVS > Projects from CVS
Create a new repository location with the following data:
- Host: bpelunit.cvs.sourceforge.net
- Path: /cvsroot/bpelunit
- User: anonymous
- Connection: pserver
Select Use an Existing Module
Select all "org.bpelunit.XXX" modules

After the checkout completes, you will have the following new plugins in your Eclipse workspace:

Project Name	Contents
org.bpelunit.framework	The core BPELUnit framework.

org.bpelunit.framework.client.command	The command line client
org.bpelunit.framework.client.ant	The Ant client
org.bpelunit.framework.client.eclipse	The Eclipse client

org.bpelunit.toolsupport	The BPELUnit Eclipse Tool Support

org.bpelunit.oracleUnDeployer	The Oracle UnDeployer

org.bpelunit.howtobuild	Information on the build process
org.bpelunit.build.eclipse	The Eclipse feature
org.bpelunit.build.standalone	Standalone build scripts

When making changes to this source code, or adding new clients in the form of additional Eclipse plugins, the complete source may be tested by using the Eclipse runtime workbench mechanism, or the included Java/Ant runners.

There are two things to keep in mind:

Firstly, the framework plugin uses Apache XBeans, which comes with its own compile mechanism. This is achieved by executing the buildXMLModel.xml Ant script. You need to execute this script if the projects' output folder was cleared (for example, the project cleaned). The runtime will fail to find some classes if this is not done.
Secondly, please note that the Oracle UnDeployer project requires the Oracle libraries to be compiled cleanly. You need to change the CLASSPATH of this project to your local Oracle installation, if it deviates from the standard location.

Developing extensions

As laid out in the thesis, extensions like new SOAP Encoders, Deployers, or Header Processors are developed against the framework core, but registered in a client-specific way. To add and test an extension with all three clients, you should take the following approach:

Create a new Eclipse plugin project inside the same Eclipse workspace which also carries the BPELUnit projects.
Extend the CLASSPATH of this project to include the BPELUnit core project.
Develop your extension by subclassing ISOAPEncoder, IDeployer, or IHeaderProcessor, as described in the thesis.
Add the new project to the CLASSPATH of both the command line client and the Ant task projects.
Add the new extension to the extensions.xml inside the core package.
Add the new extension to the plugin.xml of your new project.

You may then run the Eclipse client in a runtime workbench, and the command line and ant clients from within Eclipse, to test the new extension.

Using the API

To create a new client, first have a look at the three existing clients and the way they use the BPELUnit API described in the thesis. To create new client, follow these steps:

Create a new Java (or plugin) project within Eclipse.
Extend the CLASSPATH of this project to include the BPELUnit core project.
Develop your client by using the API as described in the thesis.