JBoss.orgCommunity Documentation

Chapter 1. Installation

1.1. Overview
1.2. Prerequisites
1.3. Installation Instructions
1.3.1. Available databases and how to configure them
1.3.2. Upgrade web service for JBoss AS

1.1.  Overview

This chapter provides details of the pre-requisites for using the RiftSaw BPEL project, and how to install the engine into a JBossAS environment.

The examples distributed with RiftSaw are split into two categories, quickstarts that are pure BPEL that can run directly in the JBossAS server, and ESB based examples that require JBossESB. If you only want to use the pure BPEL examples, then JBossESB will not be required.

1.2. Prerequisites

  1. JBossAS (version 5.1.0.GA or higher) jdk6 version, available from http://www.jboss.org/jbossas.
  2. If wishing to use jbossws-cxf, then please upgrade the web service stack to version 3.4.0.GA, as described in the following 'Upgrade web service for JBoss AS' section. If using jbossws-native, then you can use the default version installed with the application server, or upgrade to a more recent version to benefit from more recent features and bug fixes (e.g. version 3.4.0.SP1).
  3. JBossESB (version 4.10 or higher), should download the jbossesb-4.10.zip, available from http://www.jboss.org/jbossesb. This is optional, only required to run the 'samples/esb' folder's examples.
  4. RiftSaw, available from http://www.jboss.org/riftsaw
  5. Ant, available from http://ant.apache.org

1.3. Installation Instructions

Note

If you have previously installed RiftSaw-2.0.0.Final, then you will need to drop the database schema due to changes in the ODE db schema for version 1.3.4. This can be achieved using the scripts in the ${riftsaw}/conf/sql folder, or configure the jdbc properties file in ${riftsaw}/conf/jdbc and running:

ant -D{database} drop.riftsaw.schema

from the ${riftsaw}/conf folder.

  1. Install JBossAS

    Unpack the JBossAS installation into the required location.

  2. Install JBossESB

    This is only required if you want to run the 'samples/esb' folder's examples.

    Unpack the JBossESB installation into a location alongside the JBossAS installation. Then follow the instructions in the JBossESB installation (install/readme.txt), to deploy JBossESB into the JBossAS environment.

    Warning

    If you intend to install the jbossesb, it must be deployed to the application server before riftsaw.

  3. Install the RiftSaw distribution

    Unpack the RiftSaw distribution into a location alongside the JBossAS installation.

    • Edit the install/deployment.properties file to update the JBossAS location, JBoss AS instance, database and JBossESB location.

    • From the install folder, run:

      ant deploy -Ddatabase=... -Dws.stack=... -Dws.version=...

      to deploy RiftSaw to JBossAS, specifying a database and mandating the upgrade of the web service stack for JBossAS. The list of available databases, and how they should be configured, is explained in the next sub-section; the list of options for update of the web service stack is discussed in the one following it.

      Note

      Please note that RiftSaw should not be deployed while JBoss AS is running.

    Tip

    The above installation steps are meant to be for riftsaw single server deployment, if you want to deploy riftsaw that supports clustering, you either need to specify the JBoss AS instance as 'all' config, or add '-Dclustering.support=true' in the command line. For detail, please refer to the User Guide's RiftSaw Clustering Support chapter.

To de-install the RiftSaw distribution,

  1. Uninstall the RiftSaw distribution

    • From the install folder, run:

      ant undeploy -Ddatabase=....

      to remove RiftSaw from JBossAS. The database option should specify the same value used during installation of RiftSaw.

Tip

When deploying riftsaw with the hsql database option, the installation script will copy the h2 library into JBoss AS server. However, when riftsaw is undeployed, this library will not be removed. This is because JBoss ESB and jBPM also use the h2 database, and therefore removing the library may inadvertantly impact those projects. If you wish to remove the h2 library, then please go to the $JBossAS/server/${config}/lib folder and remove it manually.

The following "in-memory" databases are available. If just evaluating the capabilities of RiftSaw, it is recommended that one of these options is used to reduce the time taken to get RiftSaw up and running.

  1. hsql

Other databases available, that require further configuration details, include:

  1. mysql
  2. postgres
  3. oracle
  4. sqlserver
  5. db2

The configuration properties for these database options can be found in the ${RiftSaw}/conf/jdbc folder. These properties need to be specified before executing the ant deploy -Ddatabase=... command.

Upgrading the web service stack for JBoss AS is now required. The following command: ant deploy -Ddatabase=... -Dws.stack=... -Dws.version=... -Dorg.jboss.as.config=... will help you download the web service stack, and then upgrade it for JBoss AS, while deploying RiftSaw.

OR you could go to the jbossws download page http://jboss.org/jbossws/downloads.html to get the specific distro that you want, and doing the upgrade according to $jbossws/docs/Install.txt

Tip

If you want to upgrade JBoss WS other than 'all', 'default' and 'standard' domain config, you can refer to this jira (https://jira.jboss.org/browse/RIFTSAW-265) for more detail information.