install guide fuse source 4.1

Fuse ESBInstallation Guide

Version 4.4.1Sept. 2011

The experts in open source integration and messaging

Installation GuideVersion 4.4.1

Updated: 30 Nov 2011Copyright © 2011 FuseSource Corporation, a Progress Software company. All rights reserved.

Legal Notices

These materials and all Progress® software products are copyrighted and all rights are reserved by Progress Software Corporation.The information in these materials is subject to change without notice, and Progress Software Corporation assumes no responsibilityfor any errors that may appear therein. The references in these materials to specific platforms supported are subject to change.

Actional, Apama, Apama (and Design), Artix, Business Empowerment, DataDirect (and design), DataDirect Connect, DataDirectConnect64, DataDirect Technologies, DataDirect XML Converters, DataDirect XQuery, DataXtend, Dynamic Routing Architecture,EdgeXtend, Empowerment Center, Fathom, FUSE Mediation Router, FUSE Message Broker, FUSE Services Framework,IntelliStream, IONA, Making Software Work Together, Mindreef, ObjectStore, OpenEdge, Orbix, PeerDirect, POSSENET, Poweredby Progress, PowerTier, Progress, Progress DataXtend, Progress Dynamics, Progress Business Empowerment, ProgressEmpowerment Center, Progress Empowerment Program, Progress OpenEdge, Progress Profiles, Progress Results, ProgressSoftware Developers Network, Progress Sonic, ProVision, PS Select, Savvion, SequeLink, Shadow, SOAPscope, SOAPStation,Sonic, Sonic ESB, SonicMQ, Sonic Orchestration Server, SonicSynergy, SpeedScript, Stylus Studio, Technical Empowerment,WebSpeed, Xcalia (and design), and Your Software, Our Technology–Experience the Connection are registered trademarks ofProgress Software Corporation or one of its affiliates or subsidiaries in the U.S. and/or other countries. AccelEvent, ApamaDashboard Studio, Apama Event Manager, Apama Event Modeler, Apama Event Store, Apama Risk Firewall, AppsAlive, AppServer,ASPen, ASP-in-a-Box, BusinessEdge, Business Making Progress, Cache-Forward, DataDirect Spy, DataDirect SupportLink, FUSE,FuseSource, Future Proof, GVAC, High Performance Integration, ObjectStore Inspector, ObjectStore Performance Expert, OpenAccess,Orbacus, Pantero, POSSE, ProDataSet, Progress Control Tower, Progress ESP Event Manager, Progress ESP Event Modeler,Progress Event Engine, Progress RFID, Progress RPM, Progress Software Business Making Progress, PSE Pro, SectorAlliance,SeeThinkAct, Shadow z/Services, Shadow z/Direct, Shadow z/Events, Shadow z/Presentation, Shadow Studio, SmartBrowser,SmartComponent, SmartDataBrowser, SmartDataObjects, SmartDataView, SmartDialog, SmartFolder, SmartFrame, SmartObjects,SmartPanel, SmartQuery, SmartViewer, SmartWindow, Sonic Business Integration Suite, Sonic Process Manager, Sonic CollaborationServer, Sonic Continuous Availability Architecture, Sonic Database Service, Sonic Workbench, Sonic XML Server, The BrainsBehind BAM, WebClient, and Who Makes Progress are trademarks or service marks of Progress Software Corporation and/or itssubsidiaries or affiliates in the U.S. and other countries. Java and all Java-based marks are trademarks or registered trademarksof Sun Microsystems, Inc. in the U.S. and other countries. Any other trademarks contained herein are the property of theirrespective owners.

Third Party Acknowledgments

Fuse ESB v4.3.1 incorporates ASM v3.1 from INRIA, France Telecom. Such technology is subject to the following terms andconditions: ASM: a very small and fast Java bytecode manipulation framework Copyright (c) 2000-2005 INRIA, France TelecomAll rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided thatthe following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditionsand the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditionsand the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name ofthe copyright holders nor the names of its contributors may be used to endorse or promote products derived from this softwarewithout specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF

MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHTOWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, ORCONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAYOUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Fuse ESB v4.3.1 incorporates HSQL Database Engine v1.7.3.3 from Hypersonic SQL Group. Such technology is subject to thefollowing terms and conditions: Hypersonic SQL License Copyright Copyright (c) 1995-2000 by the Hypersonic SQL Group. Allrights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that thefollowing conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions andthe following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and thefollowing disclaimer in the documentation and/or other materials provided with the distribution. All advertising materials mentioningfeatures or use of this software must display the following acknowledgment: "This product includes Hypersonic SQL." Productsderived from this software may not be called "Hypersonic SQL" nor may "Hypersonic SQL" appear in their names without priorwritten permission of the Hypersonic SQL Group. Redistributions of any form whatsoever must retain the following acknowledgment:"This product includes Hypersonic SQL." This software is provided "as is" and any expressed or implied warranties, including, butnot limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall theHypersonic SQL Group or its contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages(including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption).However caused any on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise)arising in any way out of the use of this software, even if advised of the possibility of such damage. This software consists ofvoluntary contributions made by many individuals on behalf of the Hypersonic SQL Group.

Fuse ESB v4.3.1 incorporates JBoss.org – Javassist v3.9.0.GA, The contents of these files are subject to the Mozilla PublicLicense Version 1.1 (the "License") provided below; you may not use this file except in compliance with the License. You mayalso obtain a copy of the License at http://www.mozilla.org/MPL/. Software distributed under the License is distributed on an"AS IS" basis, WITHOUTWARRANTY OF ANY KIND, either express or implied. See the License for the specific language governingrights and limitations under the License. For Javassist v3.9.0.GA, The Original Code is Javassist. The Initial Developer of theOriginal Code is Shigeru Chiba. Portions created by the Initial Developer are Copyright (C) 1999-2008 Shigeru Chiba. All RightsReserved.

Fuse ESB v4.3.1 incorporates ANTLR, Another Tool for Language Recognition v2.7.7 from Terrence Parr. Such technology issubject to the following terms and conditions: SOFTWARE RIGHTS ANTLR 1989-2006 Developed by Terence Parr Partiallysupported by University of San Francisco & jGuru.com. We reserve no legal rights to the ANTLR--it is fully in the public domain.An individual or company may do whatever they wish with source code distributed with ANTLR or the code generated by ANTLR,including the incorporation of ANTLR, or its output, into commercial software. We encourage users to develop software withANTLR. However, we do ask that credit is given to us for developing ANTLR. By "credit", we mean that if you use ANTLR orincorporate any source code into one of your programs (commercial product, research project, or otherwise) that you acknowledgethis fact somewhere in the documentation, research report, etc... If you like ANTLR and have developed a nice tool with theoutput, please mention that you developed it using ANTLR. In addition, we ask that the headers remain intact in our source code.As long as these guidelines are kept, we expect to continue enhancing this system and expect to make other tools available asthey are completed. The primary ANTLR guy: Terence Parr <[email protected]> <[email protected]>.

http://www.mozilla.org/MPL/

Table of Contents1. Installation Prerequisites ....................................................................................................... 9

Supported Platforms ....................................................................................................... 10Java and Compiler Requirements ....................................................................................... 11Other Suggested Prerequisites ........................................................................................... 12Disk Space Requirements ................................................................................................ 13

2. Installing Fuse ESB ............................................................................................................ 153. Installing from Source Code ................................................................................................. 17

Source Installation Requirements ....................................................................................... 18Unpacking the Distribution ............................................................................................... 20Building the Source ........................................................................................................ 21Distribution Files Built ..................................................................................................... 22

4. Uninstalling Fuse ESB ........................................................................................................ 23

5Fuse ESB Installation Guide Version 4.4.1

List of Tables1.1. Disk Space Requirements ................................................................................................... 132.1. Installer Files ................................................................................................................... 15

Fuse ESB Installation Guide Version 4.4.16

List of Examples1.1. Windows Environment Script ............................................................................................... 121.2. UNIX and Linux Environment Script ...................................................................................... 123.1. Windows Environment Script ............................................................................................... 193.2. UNIX and Linux Environment Script ...................................................................................... 19


Chapter 1. Installation PrerequisitesBefore attempting to install and use Fuse ESB, make sure your system meets the minimum requirements.

Supported Platforms ............................................................................................................... 10Java and Compiler Requirements ............................................................................................... 11Other Suggested Prerequisites ................................................................................................... 12Disk Space Requirements ........................................................................................................ 13


Supported PlatformsProgress tests and supports ESB products on the platforms listed at http://fusesource.com/downloads/platforms-supported/.

Support for additional operating systems and versions is considered on acase-by-case basis.


Chapter 1. Installation Prerequisites

http://fusesource.com/downloads/platforms-supported/

http://fusesource.com/downloads/platforms-supported/

Java and Compiler Requirements

Java Runtime To run applications developed with Fuse ESB, we require Java 61, JRE1.6.0_18 or later.

ImportantJava 5 is not supported.

Java Development To develop applications for Fuse ESB, we require Java 6, JDK 1.6.0_18 orlater.

ImportantJava 5 is not supported.

NoteOnly JREs and JDKs distributed or OEMed from Oracle Microsystemsare supported. (That is, Fuse ESB is not guaranteed to run with gcj.)On Red Hat-derived Linux systems, gcj is the default Javadistribution. In these cases, you must download and install a OracleJRE/JDK and set the JAVA_HOME environment variable. You can alsointegrate the Oracle JRE/JDK into the alternatives(1) system.See the alternatives(1) man page for details.

1 http://www.oracle.com/technetwork/java/javase/downloads/index.html


Java and Compiler Requirements

http://www.oracle.com/technetwork/java/javase/downloads/index.html


Other Suggested PrerequisitesThese programs are not required to work with Fuse Message Broker. However,they are useful for a variety of build tasks.

Apache Maven Apache Maven is a popular build management tool. To build the sourcedistribution of Fuse ESB, you need Apache Maven 3; you can downloadApache Maven from http://maven.apache.org/download.html.

Once you have installed Apache Maven, you must:

1. Set the M2_HOME environment variable to point to the top-level directory

that contains your Maven installation.

2. Add Maven's bin directory to the PATH.

3. Set the MAVEN_OPTS environment variable to -Xmx512M to give the Maven

build more memory in which to run.

Environment Scripts You can create scripts like the one shown here to make all settings for therequired programs. You must adjust the paths in these examples to reflectyour actual installed locations of Ant, Maven, and the JDK.

Example 1.1. Windows Environment Script

set JAVA_HOME=C:\Progra~1\Java\jdk1.6.0_18set M2_HOME=C:\mavenset PATH=%JAVA_HOME%\bin;%PATH%set PATH=%M2_HOME%\bin;%PATH%set MAVEN_OPTS=-Xmx512M

Example 1.2. UNIX and Linux Environment Script

export JAVA_HOME=/usr/lib/jvm/java-1.6.0-oracleexport M2_HOME=/opt/mavenexport PATH=$JAVA_HOME/bin:$PATHexport PATH=$M2_HOME/bin:$PATHexport MAVEN_OPTS=-Xmx512M


Chapter 1. Installation Prerequisites

http://maven.apache.org/download.html

Disk Space RequirementsTable 1.1 on page 13 shows the amount of disk space you will need to installFuse ESB.

Table 1.1. Disk Space Requirements

LinuxWindowsInstallation Type

90 MB89 MBBinary installation

3.6 MB3 MBSource installation, as installed

329 MB a328 MB aSource installation, after buildingaplus up to 600 MB placed in the Maven $HOME/.m2 and .maven directories.


Disk Space Requirements

Chapter 2. Installing Fuse ESBInstaller Files Table 2.1 on page 15 lists the available installation files for Fuse ESB.

Table 2.1. Installer Files

DescriptionFile

Binary installation package for Windows platforms.apache-servicemix-4.4.1-fuse-00-08.zip

Binary installation package for Linux, OS X, and all UNIXplatforms.

apache-servicemix-4.4.1-fuse-00-08.tar.gz

Source code installation package for all platforms. If youprefer to build Fuse ESB from source, see "Installing fromSource Code" on page 17.

apache-servicemix-4.4.1-fuse-00-08-src.zip

Unpacking the Distribution The binary distribution is packaged either as a .zip file (Windows) or a.tar.gz file (*NIX). Using a suitable archive tool, such as Zip or Gunzip,unpack the distribution into a directory to which you have full access.

WarningDo not unpack the archive file into a folder that has spaces in itspath name. For example, do not unpack into C:\Documents andSettings\Greco Roman\Desktop\fusesrc.

After unpacking the distribution and checking the prerequisites, you are nowready to use the product. See Product Introduction for more details.

(Optional) Remove the JBIcontainer

The JBI container is installed as a sub-container of the OSGi container in FuseESB. If you do not intend to use the JBI container, however, you might preferto remove it from the OSGi container altogether. To remove the JBI container,perform the following steps:

1. You need to perform a cold start of the OSGi container. That is, you mustcompletely wipe the data stored by the current instance of the container.While the container is shut down, delete the entire EsbInstallDir/data

directory (the data directory might not exist, if you have not yet run the

OSGi container).


http://fusesource.com/docs/esb/4.4.1/esb_prod_intro/esb_prod_intro.pdf#ESBGetStarted

2. Edit the etc/org.apache.karaf.features.cfg file to customize the

list of features installed during a cold start. In the featuresBoot setting,

delete all of the entries in the comma-separated list that match thepatterns jbi-* or servicemix-*. For example, after deleting the relevant

entries from the default list, the featuresBoot setting would look as

follows:

## Comma separated list of features to install at startup#featuresBoot=config,activemq-broker,camel,war

3. The next time you start up the OSGi container, it initializes itself withoutthe JBI features.


Chapter 2. Installing Fuse ESB

Chapter 3. Installing from Source CodeThe Fuse ESB source distribution includes the source code and tools for building a number of the componentsincluded in Fuse ESB. Once built, you can use them to create an installation of Fuse ESB.

Source Installation Requirements ............................................................................................... 18Unpacking the Distribution ....................................................................................................... 20Building the Source ................................................................................................................ 21Distribution Files Built ............................................................................................................. 22


Source Installation RequirementsYou must have the following in order to build a Fuse ESB product from itssource distribution:

• An active connection to the Internet.

The build system uses the Maven build engine, which connects to one ormore Maven repositories on the Internet to download JAR files that aredetermined to be dependencies of the current build.

• A Java 6 JDK

• Apache Maven 3

Java JDK You need the Java Development Kit (JDK), version 6 Update 18 or later.

You can download the JDK from http://www.oracle.com/technetwork/java/javase/downloads/index.html.

Once you have installed the JDK you must:

1. Set the JAVA_HOME environment variable to point to the top-level directory

containing your JDK.

2. Add the JDK's bin directory to the PATH.

TipOn Windows, the Oracle JDK installs by default into C:\ProgramFiles\Java\jdk1.6.0_version. When specifying this path in yourJAVA_HOME environment variable, you can use Progra~1 instead ofProgram Files, as shown in the example scripts below.

Apache Maven Apache Maven is a popular build management tool. ESB source builds requireApache Maven 3; you can download Apache Maven from http://maven.apache.org/download.html.

Once you have installed Apache Maven, you must:


Chapter 3. Installing from Source Code





1. Set the M2_HOME environment variable to point to the top-level directory

containing your Maven installation.

2. Add Maven's bin directory to the PATH.

3. Set the MAVEN_OPTS environment variable to -Xmx512M to give the Maven

build more memory in which to run.

Example Scripts You can make all settings for the required programs with a script like thefollowing examples. Adjust the paths in these examples to reflect your actualinstalled locations of Ant, Maven, and the JDK.

Example 3.1. Windows Environment Script

set JAVA_HOME=C:\Progra~1\Java\jdk1.6.0_18set ANT_HOME=C:\Antset M2_HOME=C:\Mavenset PATH=%JAVA_HOME%\bin;%PATH%set PATH=%ANT_HOME%\bin;%PATH%set PATH=%M2_HOME%\bin;%PATH%set MAVEN_OPTS=-Xmx512M

Example 3.2. UNIX and Linux Environment Script

export JAVA_HOME=/usr/lib/jvm/java-1.6.0-oracleexport ANT_HOME=/opt/antexport M2_HOME=/opt/mavenexport PATH=$JAVA_HOME/bin:$PATHexport PATH=$ANT_HOME/bin:$PATHexport PATH=$M2_HOME/bin:$PATHexport MAVEN_OPTS=-Xmx512M


Source Installation Requirements

Unpacking the DistributionThe source distribution is packaged as a .zip file that must be unpackedbefore you can build the Fuse ESB installation. Unpack the distribution intoa directory to which you have full access.

WarningDo not unpack the archive file into a folder that has spaces in itspath name. For example, do not unpack into C:\Documents andSettings\Greco Roman\Desktop\fusesrc.



Building the SourceBuild the Fuse ESB distribution using the instructions in this section.

Build Commands Follow these steps to build the entire distribution.

1. Change to the src subdirectory of the folder into which you unpacked

the source distribution.

2. Run the following command:

mvn -Pfastinstall

TipIf you want to run the tests, omit the -Pfastinstall option.

TipIf you have errors building the source distribution, try removing yourprivate Maven repository ($HOME/.m2/repository/*), then runningmvn -U install.


Building the Source

Distribution Files BuiltWhen the build runs successfully, Fuse ESB distribution .zip and .tar.gzfiles are found in the src/assembly/target folder of the source installationdirectory.

To install Fuse ESB from the newly built distribution file, unzip its contentsinto the directory of your choice.



Chapter 4. Uninstalling Fuse ESBThis chapter describes how to uninstall Fuse ESB.

To remove Fuse ESB from a system:

1. Locate the folder into which Fuse ESB was expanded.

2. Delete that folder.
