Index Changes

NOTE: These instructions assume Unix-style path and environment conventions. If you are running in a different environment (DOS for example), be sure to use '\' instead of '/'. I provide specific instructions below for commands that have slightly different syntax between between Windows and Unix environments.

STEP 1: Download the Open ESB for JBoss distribution

Open ESB for JBoss is available for download as a single zip or tar file from the Project Open ESB site. Here's a direct link: JBoss Open ESB Distro .

STEP 2: Install Open ESB for JBoss

NOTE: These instructions assume you already have JBoss installed. This was tested with JBoss 4.2.1.GA

You will need the extract the contents of the distribution to a directory, for this demonstration I will assume that the distribution has been downloaded to /java. To extract the contents perform one of the following commands depending on whether you downloaded the zip or the tar file.

$ cd /java
$ unzip


$ cd /java
$ tar -xvzf openesb-jboss-distribution-1.1.tar.gz

Note that I have chose to extract the distribution into the /java directory (e.g. /java). This means that my Open ESB install root is now /java. If you extract the distribution into a different directory, keep that in mind when performing the rest of the steps in this walk through. You will have to adjust the directory path used with certain commands accordingly.

STEP 3: Deploying Open ESB to JBoss

If you deploy WARs or EARs to JBoss we recommend installing OpenESB in it's own config (domain) to avoid classpath issues (see issue #153 ). Therefore create a new config under $JBOSS_HOME/server by copying /server/minimal and naming it openesb. In order to run other configurations, such as default, at the same time you will have to update some ports and make them unique. Open up the server/openesb/conf/jboss-service.xml and change the Port attribute from 1099 to 2099. Also change the RmiPort from 1098 to 0.

You will first want to edit your or run.bat file for JBoss to include a new system property designating you JBI install root. Navigate to $JBOSS_HOME/bin and open either your file or the run.bat file and add the following system property:


# Set install root for for jbi runtime
JAVA_OPTS="$JAVA_OPTS -Djbi.install.root=/java/jboss-jbi"


# Set install root for for jbi runtime
set JAVA_OPTS=%JAVA_OPTS% -Djbi.install.root=/java/jboss-jbi

NOTE: The jbi.install.root should be equal to where you extracted the distribution and point to the jboss-jbi directory.

Next you will need to start JBoss by issuing the following command:

$ cd $JBOSS_HOME/bin
$ cd sh -c openesb

Once JBoss has started you will need to deploy Open ESB. First you will need to navigate to where you extracted the distribution (e.g. /java) and copy the openesb-jboss.sar directory and copy that to the following location:


You should see Open ESB being deployed and the JBI Framework ready to accept requests. Once deployed you will see a new directory located under $JBOSS_HOME/server/openesb called jbi. This directory provides you the location to install Binding Components, Service Engines, and Shared Libraries as well as deploy your Composite Applications.

You are now up and running. You can install your components (e.g. shared libraries, binding components, and service engines) to the following directory:


Once you have your required components and shared libraries installed you can deploy your composite applications by copying them to the following directory:


NOTE: If you are going to use the HTTP BC you will need to do some extra work, don't worry it's not that bad, to get that component to install correctly. Documentation for installing the HTTP BC is available here , make sure you stop JBoss and restart after creating the ext directory and downloading all required artifacts.

NOTE: The Open ESB for JBoss distribution does not contain any components, shared libraries, or sample applications, so we are going to have to scavenge. The good news is that there are a ton of JBI components available for download from the Project Open JBI Components website.

STEP 4: Verification

Once these steps are complete you should have the following:

  • A modified or run.bat file containing the jbi.install.root property
  • The directory /java/jboss-jbi
  • The directory $JBOSS_HOME/server/openesb/jbi
  • The directory $JBOSS_HOME/server/openesb/deploy/openesb-jboss.sar

Coming Soon:

Configure and using the Ant client interface.

JSPWiki v2.4.100
« Home Index Changes Prefs
This page (revision-15) was last changed on 12-Dec-07 10:39 AM, -0800 by james Loreznen