Red Hat JBoss Fuse

Tooling Installation Guide

Installing Red Hat JBoss Fuse ToolingRed Hat Fuse IDE

Red Hat

Version 6.1

Legal Notice

Trademark Disclaimer

The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, MetaMatrix, Fedora, the Infinity Logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Apache, ServiceMix, Camel, CXF, and ActiveMQ are trademarks of Apache Software Foundation. Any other names contained herein may be trademarks of their respective owners.

Legal Notice

Third Party Acknowledgements

One or more products in the Red Hat JBoss Fuse Tooling for Eclipse release includes third party components covered by licenses that require that the following documentation notices be provided:
  • JLine (http://jline.sourceforge.net) jline:jline:jar:1.0
    License: BSD (LICENSE.txt) - Copyright (c) 2002-2006, Marc Prud'hommeaux
    All rights reserved.
    Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
    • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
    • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
    • Neither the name of JLine nor the names of its contributors may be used to endorse or promote products derived from this software without 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 COPYRIGHT OWNER OR 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 AND 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.
  • Stax2 API (http://woodstox.codehaus.org/StAX2) org.codehaus.woodstox:stax2-api:jar:3.1.1
    Copyright (c) <YEAR>, <OWNER> All rights reserved.
    Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
    • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
    • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
    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 COPYRIGHT HOLDER OR 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 AND 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.
  • jibx-run - JiBX runtime (http://www.jibx.org/main-reactor/jibx-run) org.jibx:jibx-run:bundle:1.2.3
    License: BSD (http://jibx.sourceforge.net/jibx-license.html) Copyright (c) 2003-2010, Dennis M. Sosnoski.
    All rights reserved.
    Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
    • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
    • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
    • Neither the name of JiBX nor the names of its contributors may be used to endorse or promote products derived from this software without 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 COPYRIGHT OWNER OR 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 AND 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.
  • JavaAssist (http://www.jboss.org/javassist) org.jboss.javassist:com.springsource.javassist:jar:3.9.0.GA:compile
  • HAPI-OSGI-Base Module (http://hl7api.sourceforge.net/hapi-osgi-base/) ca.uhn.hapi:hapi-osgi-base:bundle:1.2
    License: Mozilla Public License 1.1 (http://www.mozilla.org/MPL/MPL-1.1.txt)
01 Dec 2014

Abstract

Details of how to install Red Hat JBoss Fuse ToolingRed Hat JBoss Fuse IDE

Chapter 1. Installation Requirements

Abstract

Before attempting to install and use Red Hat JBoss Fuse Tooling, make sure your system meets the minimum requirements.

System Requirements

For Red Hat JBoss Developer Studio to function optimally, it must be installed on a tested and supported platform that is equipped with enough memory and hard disk space and running a compatible Java Developer Kit (JDK).
Please see the JBoss Developer Studio Installation Guide for detailed information on the system requirements.

Installing Red Hat JBoss Developer Studio

If you haven't already done so, you need to install Red Hat JBoss Developer Studio 7.x.
  • To install the JBoss Developer Studio all-in-one distribution:
    1. Download and install one of the JBoss Developer Studio 7.x Universal Binary distributions from the Red Hat Customer Portal. These distributions come bundled and configured with everything you need, including Eclipse, to get started right away. The installer guides you through the installation process.

      Important

      Do not install JBoss Developer Studio or the Java runtime you plan to use in a directory path that contains white space; for example, C:\Program Files\Java\jre1.7\.... Doing so can result in unpredictable errors in the Red Hat JBoss Fuse Tooling at runtime.
    2. Start up JBoss Developer Studio.
  • To install JBoss Developer Studio into an existing Eclipse installation:
    1. Use the Eclipse HelpMarket Place... mechanism to install JBoss Developer Studio.
    2. Select the Red Hat JBoss Developer Studio (Kepler) option, and click Install.
    3. Restart Eclipse once the installation has finished.

Important

If you want to deploy your JBoss Fuse Tooling applications to Red Hat JBoss Fuse, you must download and install jboss-fuse-6.1.0.redhat-<build#> from the Red Hat Customer Portal. For installation instructions, see the Red Hat JBoss Fuse Installation Guide, version 6.1, at Red Hat JBoss Fuse documentation.

Chapter 2. Installing the Red Hat JBoss Fuse Tooling

Abstract

You can install the JBoss Fuse Tooling through either JBoss Central or the standard Eclipse Install New Software mechanism.
JBoss Fuse Tooling consists of three feature plugins that you can install individually, allowing you to install only the features you need.
  • JBoss Fuse Camel Editor Feature—base building block for the other feature plugins; provides the tools for creating a Fuse project, including the route editor, the Enterprise Integration Patterns, and the logic for running camel contexts inside the editor.
  • JBoss Fuse Runtimes Feature—adds functionality to debug and monitor routes and to deploy routes to both JMX-connected containers and Fabric containers.
  • JBoss Fuse Server Extension Feature—adds functionality to configure, run, and interact with any of the supported servers from the Karaf command line inside the JBoss Fuse Tooling.

2.1. JBoss Central Install Method

With JBoss Developer Studio running JBoss perspective:
  1. Click the Software/Update tab at the bottom of JBoss Central.
  2. Find JBoss Developer Studio Integration Stack in the list of available features. It consists of four components listed directly beneath it.
    list of available JBDSIS software
  3. Click the checkbox next to JBoss Integration and SOA Development. It contains the three feature plugins that make up the JBoss Fuse Tooling.
  4. Click Install.
  5. Select the Fuse Tooling—JBoss Fuse Camel Editor Feature, JBoss Fuse Runtimes Feature, JBoss Fuse Server Extension Feature— and other integration and SOA development options you want to install.
    selecting the JBoss Fuse Tooling features to install
  6. Click Next.
    Wait while the installer checks for dependencies and hardware requirements.
  7. In the Install Details window, review the items to be installed, and then click Next, if you are satisfied with your selection.
  8. Accept the terms of the license agreement, and then click Finish.
  9. If a Security Warning regarding unsigned content appears, disregard it and click OK.
  10. When prompted to restart JBoss Developer Studio, click Yes.
    When JBoss Developer Studio restarts, the Red Hat JBoss Fuse Tooling will be available.

2.2. Eclipse Install New Software Method

With Eclipse running JBoss Developer Studio:
  1. On the menu bar, click HelpInstall New Software ... to open the Install wizard.
  2. Click the Add... button next to the Work with: field to open the Add Repository window.
  3. In Name:, enter a name for the repository; for example, Red Hat JBoss Fuse Tooling.
  4. In Location: enter https://devstudio.jboss.com/updates/7.0/integration-stack/
    The name and location you entered are combined and displayed in the Work with: field in the Available Software window:
    list of available software
  5. In the list of available software, expand JBoss Integration and SOA Development.
  6. Select the JBoss Fuse Tooling features you want to install (JBoss Fuse Camel Editor Feature, JBoss Fuse Runtimes Feature, JBoss Fuse Server Extension Feature) by clicking the checkbox next to each.
  7. Click Next.
    Wait while the installer checks for dependencies and hardware requirements.
  8. In the Install Details window, review the items to be installed, and then click Next, if you are satisfied with your selection.
  9. Accept the terms of the license agreement, and then click Finish.
  10. If a Security Warning regarding unsigned content appears, disregard it and click OK.
  11. When prompted to restart Eclipse, click Yes.
    When Eclipse restarts, the new version of the Red Hat JBoss Fuse Tooling will be available.

Chapter 3. Upgrading Red Hat JBoss Fuse Tooling

Abstract

You can upgrade the JBoss Fuse Tooling through either JBoss Central or the standard Eclipse Check for Updates mechanism.

3.1. JBoss Central Upgrade Method

JBoss Central notifies you when it discovers that updates for installed software are available.
  1. Click in the center of the Updates Available notification window.
    available software updates notification
  2. Select the Fuse Tooling features (and other listed software, if any) you want to update.
    list of available software updates
  3. Click Next.
    Wait while the installer checks for dependencies and hardware requirements.
  4. In the Install Details window, review the items to be updated, and then click Next, if you are satisfied with your selection.
  5. Accept the terms of the license agreement, and then click Finish.
  6. If a Security Warning regarding unsigned content appears, disregard it and click OK.
  7. When prompted to restart JBoss Developer Studio, click Yes.
    When JBoss Developer Studio restarts, the new version of the Red Hat JBoss Fuse Tooling will be available.

3.2. Eclipse Upgrade Method

Important

Eclipse searches for software updates only in the repositories that are included in its list of Available Software Sites. If you haven't already done so, you need to add the https://devstudio.jboss.com/updates/7.0/integration-stack/ repository to the list.
With Eclipse running JBoss Developer Studio:
  1. On the menu bar, click HelpCheck for Updates.
    You are notified when no updates are available:
    no available software updates notification
    When software updates are available, the Available Updates window opens showing all of the software for which there are updates.
  2. Select the JBoss Fuse Tooling features (and other listed software, if any) you want to update.
    list of available software updates
  3. Click Next.
    Wait while the installer checks for dependencies and hardware requirements.
  4. In the Install Details window, review the items to be updated, and then click Next, if you are satisfied with your selection.
  5. Accept the terms of the license agreement, and then click Finish.
  6. If a Security Warning regarding unsigned content appears, disregard it and click OK.
  7. When prompted to restart Eclipse, click Yes.
    When Eclipse restarts, the new version of the Red Hat JBoss Fuse Tooling will be available.

Chapter 4. Uninstalling Red Hat JBoss Fuse Tooling

Abstract

Red Hat JBoss Fuse Tooling is easy to uninstall. Just use the Eclipse uninstall mechanism accessed through Help (Linux and Windows) or Red Hat JBoss Developer Studio (Mac OSX) on the menu bar.

Important

Uninstalling Red Hat JBoss Fuse Tooling does not remove your Fuse projects. To remove your Fuse projects, you must manually delete them. If you set up your Fuse projects to use a unique workspace folder, you can simply delete that folder. Otherwise, you need to delete each project individually.
To uninstall Red Hat JBoss Fuse Tooling:
  1. On the menu bar, click
    • HelpAbout JBoss Developer StudioInstallation DetailsInstalled Software— on Linux and Windows platforms
    • Red Hat JBoss Developer StudioAbout JBoss Developer StudioInstallation DetailsInstalled Software—on Mac OSX platforms
  2. On the Installed Software tab, highlight the Fuse Tooling features—JBoss Fuse Camel Editor Feature, JBoss Fuse Runtimes Feature, JBoss Fuse Server Extension Feature—you want to uninstall, and then click Uninstall.
  3. On the Uninstall window, review your selections and, if satisfied, click Finish. Otherwise click Back to revise your selection, or click Cancel to abort the uninstall.
  4. When prompted, click Yes to restart Eclipse/Red Hat JBoss Developer Studio.

Red Hat JBoss Fuse Maven Repositories

Abstract

Red Hat JBoss Fuse strongly supports Maven, an open source build system available from Apache Maven. To use Maven to build your projects, you need to specify, in a Maven settings.xml file, where required artifacts are located.
For details on setting up Maven to work with Red Hat JBoss Fuse, see Building with Maven in Red Hat JBoss Fuse Deploying into the Container on the Red Hat Customer Portal.
The following repositories contain artifacts your projects may need:
  • JBoss Fuse repository
    Provides access to the artifacts in the Red Hat JBoss Fuse Maven repository. This repository is required.
    https://repo.fusesource.com/nexus/content/groups/public/
  • JBoss Fuse Snapshots repository
    Provides access to the artifacts in the Red Hat JBoss Fuse snapshot kit. This repository is not required, but it is useful if you want to experiment with building your project using different versions of the supplied archetypes.
    https://repo.fusesource.com/nexus/content/groups/public-snapshots/
  • Apache Public repository
    Provides access to the artifacts in the Apache Maven repository. This repository is not required, but it is useful to include as Red Hat JBoss Fuse depends on various Apache artifacts.
    https://repository.apache.org/content/groups/public/