Installation Guide
Use this guide to install Red Hat JBoss Fuse Service Works, and perform initial configuration.
Abstract
Chapter 1. Red Hat JBoss Fuse Service Works
1.1. What is Red Hat JBoss Fuse Service Works?
1.2. Core Functionality
- Enterprise Integration Pattern (EIP) Based Development
- The versatile EIP framework is implemented in routing and transformation processes for faster and more efficient integration solutions.
- High Performance Messaging
- A high performance messaging broker supports messaging patterns such as publish-subscribe, point-to-point, and store-forward, and multiple cross language clients.
- Service Development
- The web services framework exposes integration assets as services and calls external services, supporting all major web services standards. It also supports RESTful calls.
- Structured Service Development
- A lightweight service development framework provides full life-cycle support for developing, deploying, and managing service-based applications.
- Automatable Registry with Workflow
- Manage the life-cycle of services from design, development, and deployment by defining, exposing, and enforcing rules or policies.
- Business Transaction Monitoring
- Capture service activity information, define and collect metrics, and define alerts and SLAs.
1.3. System Integration
1.4. Core and Components
1.5. Components of Red Hat JBoss Fuse Service Works
Table 1.1. Red Hat JBoss Fuse Service Works Components
| Component | Function |
|---|---|
|
SwitchYard
|
Service delivery framework
|
|
JBoss Rules
|
Business rules engine with complex event processing
|
|
Design Time Governance
|
A service registry/repository
|
|
Runtime Governance
|
Service activity monitoring
|
|
JBoss Operations Network
|
Operations, administration, and management tools
|
|
JBoss EAP
|
A full JavaEE application server
|
|
Apache Camel
|
Rules Based Router
|
|
Smooks
|
Framework for processing XML and non-XML data using Java
|
|
ModeShape
|
Data Store
|
|
HornetQ
|
Messaging and Integration Patterns Server
|
|
Apache CXF
|
Services Framework
|
- Bean Services with CDI
- SwitchYard leverages the power of Java EE6 and CDI to allow Java objects become services by adding an @Service annotation to your bean. Beans are automatically registered at runtime and references to other services can be injected as CDI beans using the @Inject annotation. Use CDI in your JSP and JSF applications to inject enterprise services into the web tier.
- Declarative Transformation
- With declarative transformation in SwitchYard, you can define the transformation and types to which it applies. SwitchYard automatically registers and executes the transformation. Choose from Smooks, Java, XSLT, JSON, and more.
- Decision Services with JBoss Rules
- Encapsulate business rules as decision services using the JBoss Rules component in SwitchYard. Each service has a well-defined contract with protocol binding details and marshaling details abstracted away by SwitchYard.
- Smooks
- This transformation engine can be used in conjunction with Red Hat JBoss Fuse Service Works to process messages.
- Business Process Execution Language (BPEL)
- You can use web services to orchestrate business rules using this language. It is included with Red Hat JBoss Fuse Service Works for the execution of business process instructions.
- JBoss Rules
- This is the rules engine that is packaged with Red Hat JBoss Fuse Service Works. It can infer data from the messages it receives to determine which actions need to be performed.
- Testing
- Comprehensive unit test support is provided to allow you to test services as you develop them.
1.6. Red Hat JBoss Fuse Service Works Features
- SwitchYard
- SwitchYard is a lightweight service delivery framework providing full life-cycle support for developing, deploying, and managing service-oriented applications.
- Business Process Execution Language (BPEL)
- You can use web services to orchestrate business rules using this language. It is included with Red Hat JBoss Fuse Service Works for the execution of business process instructions.
- Smooks
- This transformation engine can be used in conjunction with Red Hat JBoss Fuse Service Works to process messages. It can also be used to split messages and send them to the correct destination.
- JBoss Rules
- This is the rules engine that is packaged with Red Hat JBoss Fuse Service Works. It can infer data from the messages it receives to determine which actions need to be performed.
1.7. Integration Use Case
Chapter 2. Read Me
2.1. Back Up Your Data
Warning
2.2. Red Hat Documentation Site
2.3. EAP_HOME
EAP_HOME refers to the root directory of the Red Hat JBoss Enterprise Application Platform installation on which JBoss Fuse Service Works is deployed.
2.4. MODE
Note
MODE will either be standalone or domain depending on whether your instance of JBoss Enterprise Application Platform is running in standalone or domain mode. Substitute one of these whenever you see MODE in a file path in this documentation.
Chapter 3. Downloading Red Hat JBoss Fuse Service Works
3.1. About the Red Hat Customer Portal
- Manage and maintain Red Hat entitlements and support contracts;
- Download officially-supported software;
- Access product documentation and the Red Hat Knowledgebase;
- Contact Global Support Services; and
- File bugs against Red Hat products.
3.2. JBoss Fuse Service Works 6.0.0 Packages for Download
Table 3.1.
| Package | Description |
|---|---|
| Red Hat JBoss Fuse Service Works 6.0.0 Javadocs for Runtime Governance | Javadocs for Runtime Governance. |
| Red Hat JBoss Fuse Service Works 6.0.0 Javadocs for S-RAMP | Javadocs for S-RAMP. |
| Red Hat JBoss Fuse Service Works 6.0.0 Javadocs for SwitchYard | Javadocs for SwitchYard. |
| Red Hat JBoss Fuse Service Works 6.0.0 Maven Repository | Red Hat provides a Maven repository containing artifacts required to build applications for Red Hat JBoss Fuse Service Works. This package enables users to setup the repository offline. |
| Red Hat JBoss Fuse Service Works 6.0.0 Source Code | The source code package contains the complete source code for the Red Hat JBoss Fuse Service Works product. |
| Red Hat JBoss Fuse Service Works 6.0.0 Installer | Red Hat provides this tool to simplify product installation. The installer can be run with a graphical interface or from a script on the command line. |
3.3. Download Files from the Red Hat Customer Portal
Prerequisites
- Before you begin this task, you need a Customer Portal account. Browse to https://access.redhat.com and click the Register link in the upper right corner to create an account.
Procedure 3.1. Log in and Download Files from the Red Hat Customer Portal
- Browse to https://access.redhat.com and click the Log in link in the top right corner. Enter your credentials and click Log In.Result
You are logged into RHN and you are returned to the main web page at https://access.redhat.com.
Navigate to the Downloads page.
Use one of the following options to navigate to the Downloads page.- Click the Downloads link in the top navigation bar.
- Navigate directly to https://access.redhat.com/downloads/.
Select the product and version to download.
Use one of the following ways to choose the correct product and version to download.- Step through the navigation one level at a time.
- Search for your product using the search area at the top right-hand side of the screen.
Download the appropriate file for your operating system and installation method of choice.
Depending on the product you choose, you may have the choice of a Zip archive, RPM, or native installer for a specific operating system and architecture. Click either the file name or the Download link to the right of the file you want to download.
The file is downloaded to your computer.
3.4. Checksum Validation
3.5. Verify Downloaded Files
Procedure 3.2. Verify File Checksums on Red Hat Enterprise Linux
Obtain checksum values for the downloaded file
- Navigate to https://access.redhat.com/jbossnetwork/. Login if required.
- Select your Product and Version.
- Select the package you want to verify to navigate to the Software Details page.
- Take note of the MD5 and SHA-256 checksum values.
Run a checksum tool on the file
- Navigate to the directory containing the downloaded file in a terminal window.
- Run
md5sum downloaded_file. - Run
sha256sum downloaded_file.
Example output:[localhost]$ md5sum downloaded_file 4564d1a5190110dbe8170e50d7353a97 downloaded_file [localhost]$ sha256sum downloaded_file 25b6bd3c5f47b316639b014d041cdb6a515e3a4a32d30a479141cd8ceecb853e downloaded_file
Compare the checksum values
- Compare the checksum values returned by the
md5sumandsha256sumcommands with the corresponding values displayed on the Software Details page. - Download the file again if the two checksum values are not identical. A difference between the checksum values indicates that the file has either been corrupted during download or has been modified since it was uploaded to the server. Contact Red Hat Support for assistance if after several downloads the checksum does not successfully validate.
- The downloaded file is safe to use if the two checksum values are identical.
The integrity of the downloaded file is verified.
Note
Chapter 4. Installing Red Hat JBoss Fuse Service Works
jboss-fsw-installer-6.0.0.GA-redhat-4.jar, which can be used to initiate either a graphical or script-based installation.
- JBoss EAP (mandatory)
- including HornetQ
- SwitchYard - selecting this component also installs the following components:
- jBPM
- Drools
- RiftSaw (BPEL)
- Smooks
- Apache Camel
- Apache CXF
- Runtime Governance Client (must be accompanied by SwitchYard)
- Runtime Governance Server and Client
- Design Time Governance (must be accompanied by S-RAMP Repository)
- S-RAMP Repository
- Red Hat JBoss Fuse Service Works quickstarts
4.1. Installing JBoss Fuse Service Works by GUI
Prerequisites
- You must have already downloaded the Red Hat JBoss Fuse Service Works installer file from Red Hat Customer Portal.
- You must have a supported JDK installed. See Red Hat JBoss Fuse Service Works Supported Configurations.
- If you would like to configure use of the online Maven repository during this installation, you must have Maven already installed.
Important
Note
- Set
JAVA_HOMEto the version of Java. For example,/usr/lib/jvm/java-1.7.0-openjdk-1.7.0.VERSION/. - Set
PATHto include the same version of Java. - Set
JBOSS_HOMEto yourjboss-eap-6.1directory.
Procedure 4.1. Install JBoss Fuse Service Works
- Open a new terminal and navigate to the folder where you have downloaded the JBoss Fuse Service Works installer file.
- Run the following command, replacing 6.0.0.GA-redhat-4 for the version you downloaded if required:
java -jar jboss-fsw-installer-6.0.0.GA-redhat-4.jar
- You are presented with the End User License Agreement. If you agree with the terms, select I accept the terms of this license agreement and then select to continue.
- You are prompted for the location in which you want to install JBoss Fuse Service Works. Specify a location and select . You will be notified that an instance of JBoss EAP will be placed in the chosen location. Select to proceed.
Warning
A warning message is displayed if the directory already exists. Red Hat does not recommend installing over the top of an existing installation. However, if you wish to proceed, select to continue. - You are prompted for the installation packs to install. Select to continue with the default options.
Note
Depending on your deployment, you can select packs other than the default options. For example, if you do not wish to install every pack, you could select SwitchYard and Runtime Governance Client only, for a basic installation. - You are prompted to create an administrative user. Once created, this user will be added to the ManagementRealm and can be used to access the Management Console and other applications secured using ManagementRealm. Enter the new username and password in the appropriate fields and select .
- You are prompted to create a governance user. It will give you access to S-RAMP, DTGov and RTGov consoles along with the S-RAMP Command Line Interface. Enter a username and password and select .
- You are then prompted to setup your Maven repository. This will enable you to build the quickstarts provided. Specify the location of an existing or new location for your Maven settings file (typically
~/.m2/settings.xml). If you do not currently have a settings file, a newsettings.xmlfile will be created for you in the location you provide. Select .Note
If you choose to skip the maven repository setup, you will be asked to confirm this decision. Select to continue. - You are prompted to configure the SAML keystore. It is used by a Java KeyStore to sign authentication tokens. Enter the SAML keystore password and select .
- You are then prompted to enable the Java Security Manager. It enforces access rules at the JVM runtime based on one or more security polices. Select when you are ready to proceed.
Important
Enabling the Java Security Manager may reduce server performance. - At this point you are asked to choose between the default or advanced configuration. Select the default configuration for a basic configuration, and select to continue.
- You are prompted to configure the password vault. Enter the Vault keystore password in the appropriate fields and select .
- You are presented with a screen specifying default database settings. The installer creates a database that is used to hold data for various components of JBoss Fuse Service Works, including BPEL, jBPM and S-RAMP.Change the username and password to something secure and select to continue.
Warning
The default database is an H2 database. Red Hat recommends configuring an alternative database for production systems, using the advanced configuration options. - You are presented with a list of packages that will be installed. Select to proceed.
- The installation will commence. A status bar for each component will display its progress. Once this is complete, select .
- Additional processing of tasks will commence. When the status bar indicates this has been completed, select .
- The console displays a message to let you know that the application has been successfully installed. Also, it offers you a list of URLs for accessing the Administration and BPEL Consoles, S-RAMP and DTGov User Interfaces and Gadget Server.If you want to repeat the same installation on other machines, select and choose a location and filename for the script.
- Select .
The basic installation is complete.
Note
izpack.mode=privileged option to the installation command:
java -Dizpack.mode=privileged -jar jboss-fsw-installer-6.0.0.GA-redhat-4.jar
4.1.1. Configure Advanced Settings
Procedure 4.2. Task
- After choosing , select the items you want to configure and select .
- If you chose the option, the screen appears. This mechanism encrypts sensitive strings and stores them in an encrypted keystore.Enter your keystore information in the required fields and select .
- If you chose the option,the screen appears. Enter the location and password of a keystore under the respective fields. Confirm the password and select .
- If you chose the option, the screen appears. You can use the LDAP server as an authentication and authorization authority, both for applications and the management interface.Enter the required information to suit your system requirements and select .
- A screen displaying the new security realm configurations appears. Select to continue.
- If you chose the option, the screen appears. You can setup your database connection using this screen.Type the Database Username and Password under the respective fields. Confirm the password and select .
Note
JBoss Fuse Service Works requires a database to hold data for various components, including BPEL, jBPM and S-RAMP. It is used to hold state information that must be persisted from action to action so that recovery is possible in case of a server crash.Clustering does not rely upon this database in the default configuration. Instead, Infinispan is used as a memory grid.
4.2. Installing JBoss Fuse Service Works by Script
In order to install JBoss Fuse Service Works by script, you must have already run the installer in graphical mode, and saved the installation script when prompted at the end of the installation. The script will have been saved in EAP_HOME, along with an associated .variables file; for example, InstallConfigRecord.xml and InstallConfigRecord.xml.variables.
Procedure 4.3.
- You can change the installation directory by editing the script and modifying the value specified within the
<installpath>element.Note
You can specify either a full directory path or a path relative to the directory in which you run the script.Warning
Red Hat does not support installing over an existing instance of Fuse Service Works. Therefore be sure to select a new or empty directory. - Run the script using the following command, replacing 6.0.0.GA-redhat-4 for the version you downloaded if required:
java -jar jboss-fsw-installer-6.0.0.GA-redhat-4.jar InstallConfigRecord.xml
The script runs and prompts you to provide Governance, SAML keystore, and Vault keystore passwords, as shown below:[ Starting automated installation ] Read pack list from xml definition. Try to add to selection [Name: Red Hat JBoss Enterprise Application Platform and Index: 0] Try to add to selection [Name: Red Hat JBoss Fuse Service Works and Index: 1] Try to add to selection [Name: Switchyard quickstarts and Index: 2] Try to remove from selection [Name: RT-Gov Client-only and Index: 3] Try to add to selection [Name: RT-Gov Server+Client and Index: 4] Try to add to selection [Name: RTGov Server quickstarts and Index: 5] Try to add to selection [Name: DT-Gov run-time and Index: 6] Try to add to selection [Name: DT-Gov quickstarts and Index: 7] Try to add to selection [Name: S-RAMP run-time and Index: 8] Try to add to selection [Name: S-RAMP quickstarts and Index: 9] Try to add to selection [Name: Red Hat JBoss Fuse Service Works quickstarts and Index: 10] Modify pack selection. Pack [Name: RT-Gov Client-only and Index: 3] removed from selection. Governance password: Confirm Governance password: SAML keystore password: Re-enter SAML keystore password: Vault keystore password: Re-enter vault keystore password:
4.2.1. Supplying Passwords to the Installation Script
.variables file and run the installer with the -variablefile option. For example, assuming the script is named InstallConfigRecord.xml:
java -jar jboss-fsw-installer-6.0.0.GA-redhat-4.jar InstallConfigRecord.xml -variablefile InstallConfigRecord.xml.variables
-variables option:
java -jar jboss-fsw-installer-6.0.0.GA-redhat-4.jar InstallConfigRecord.xml -variables KEY_1=VALUE_1 KEY_2=VALUE_2 ...
Warning
.variables file after installation to avoid compromise.
Chapter 5. Starting and Stopping the Application Server
Note
- For more information about starting and stopping JBoss Enterprise Application Platform using alternative and more advanced methods, see the Red Hat JBoss Enterprise Application Platform Administration and Configuration Guide.
- Note that JBoss Fuse Service Works 6.0 does not support JBoss Enterprise Application Platform in domain mode.
5.1. Start JBoss EAP 6 as a Standalone Server
This topic covers the steps to start JBoss EAP 6 as a Standalone Server.
Procedure 5.1. Start the Platform Service as a Standalone Server
For Red Hat Enterprise Linux.
Run the command:EAP_HOME/bin/standalone.shFor Microsoft Windows Server.
Run the command:EAP_HOME\bin\standalone.batOptional: Specify additional parameters.
To print a list of additional parameters to pass to the start-up scripts, use the-hparameter.
The JBoss EAP 6 Standalone Server instance starts.
5.2. Stop JBoss EAP 6 as a Standalone Server
Stopping JBoss Enterprise Application Platform using the Management CLI.
- Run the
EAP_HOME/bin/jboss-cli.shcommand to launch the Management CLI.$ EAP_HOME/bin/jboss-cli.sh
- Run the
connectcommand to connect to the server.[disconnected /] connect
- Run the
shutdowncommand to stop the server.[standalone@localhost:9999 /] shutdown
- Run the
quitcommand to close the Management CLI.[standalone@localhost:9999 /] quit
Stopping JBoss Enterprise Application Platform by pressing CTRL+C.
Press Ctrl+C in the server window (the terminal window where JBoss Enterprise Application Platform was started).ResultEach of these alternatives stops JBoss Enterprise Application Platform.
Chapter 6. Maven Repositories
6.1. About Maven
http:// when located on an HTTP server, or file:// when located on a file server. The default repository is the public remote Maven 2 Central Repository.
settings.xml file. You can either configure global Maven settings in the M2_HOME/conf/settings.xml file, or user-level settings in the USER_HOME/.m2/settings.xml file.
Note
6.2. About The Provided Maven Repositories
settings.xml file during installation, Maven is already configured to use the online repositories. If you did not provide the location during installation, you need to configure Maven manually by following the procedure in Section 6.4, “Configuring Maven to Use the Online Repositories” or Section 6.3, “Configuring Maven to Use the File System Repositories”.
Important
6.3. Configuring Maven to Use the File System Repositories
In situations where you cannot use the online repositories, you will have to download and configure the required repositories locally.
Procedure 6.1.
- Download the following ZIP archives containing the required repositories:
Note
Alternatively, the ZIP archives can be downloaded from http://access.redhat.com/jbossnetwork/. - Unzip the downloaded ZIP files into an arbitrary location in a local file system.
- Add entries for the unzipped repositories to Maven's
settings.xmlfile. The following code sample contains a profile with the repositories and an activation entry for the profile:<?xml version="1.0" encoding="UTF-8" standalone="no"?> <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/xsd/settings-1.0.0.xsd"> <localRepository/> <profiles> <!-- Profile with local repositories required by Fuse Service Works --> <profile> <id>fsw-local-repos</id> <repositories> <repository> <id>fsw-6.0.0.GA-redhat-2-repository</id> <name>FSW 6.0.0.GA Repository</name> <url>file://<!-- path to the repository -->/fsw-6.0.0.GA-redhat-2-repository</url> <layout>default</layout> <releases> <enabled>true</enabled> <updatePolicy>never</updatePolicy> </releases> <snapshots> <enabled>false</enabled> <updatePolicy>never</updatePolicy> </snapshots> </repository> <repository> <id>jboss-eap-6.1.1.GA-maven-repository</id> <name>EAP 6.1.1.GA Repository</name> <url>file://<!-- path to the repository -->/jboss-eap-6.1.1.GA-maven-repository</url> <layout>default</layout> <releases> <enabled>true</enabled> <updatePolicy>never</updatePolicy> </releases> <snapshots> <enabled>false</enabled> <updatePolicy>never</updatePolicy> </snapshots> </repository> </repositories> <pluginRepositories> <pluginRepository> <id>fsw-6.0.0.GA-redhat-2-repository</id> <name>FSW 6.0.0.GA Repository</name> <url>file://<!-- path to the repository -->/fsw-6.0.0.GA-redhat-2-repository</url> <layout>default</layout> <releases> <enabled>true</enabled> <updatePolicy>never</updatePolicy> </releases> <snapshots> <enabled>false</enabled> <updatePolicy>never</updatePolicy> </snapshots> </pluginRepository> <pluginRepository> <id>jboss-eap-6.1.1.GA-maven-repository</id> <name>EAP 6.1.1 GA Repository</name> <url>file://<!-- path to the repository -->/jboss-eap-6.1.1.GA-maven-repository</url> <layout>default</layout> <releases> <enabled>true</enabled> <updatePolicy>never</updatePolicy> </releases> <snapshots> <enabled>false</enabled> <updatePolicy>never</updatePolicy> </snapshots> </pluginRepository> </pluginRepositories> </profile> </profiles> <activeProfiles> <!-- Activation of the Fuse Service Works profile --> <activeProfile>fsw-local-repos</activeProfile> </activeProfiles> </settings>
Important
bpm-service quickstart application will not build without two additional repositories. If you want to build this application, download the following repositories and add them to your setting.xml file in the same way as that shown above.
The Maven repositories are downloaded, unzipped in a local file system, registered in Maven's settings.xml file, and ready to be used when performing Maven builds.
- Q: Why does the bpm-service quickstart application fail on build?
- Q: Why do I still get errors when building or deploying my applications?
- Q: Why is JBoss Developer Studio using my old Maven configuration?
bpm-service quickstart application fail on build?
When you build or deploy the bpm-service quickstart application, it fails with the following error:
[ERROR] Failed to execute goal on project switchyard-quickstart-bpm-service: Could not resolve dependencies for project org.switchyard.quickstarts:switchyard-quickstart-bpm-service:jar:1.1.1-p5-redhat-1: The following artifacts could not be resolved: org.jboss.netty:netty:jar:3.2.6.Final-redhat-2, org.apache.lucene:lucene-queryparser:jar:3.6.2-redhat-4: Could not find artifact org.jboss.netty:netty:jar:3.2.6.Final-redhat-2 in fsw-6.0.0.GA-redhat-2-repository (file:///home/belong/maven_repos/fsw-6.0.0.GA-redhat-2-repository) -> [Help 1]
The bpm-service quickstart application requires an additional two dependencies, provided by the JBoss EAP 6.0.1 and JBoss Web Framework Kit 2.5.0 Maven repositories.
- Download the following ZIP archives, and unzip them into a location of your choice:
- Add entries for the unzipped repositories to your Maven
settings.xmlfile:<?xml version="1.0" encoding="UTF-8" standalone="no"?> <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/xsd/settings-1.0.0.xsd"> <localRepository/> <profiles> <!-- Profile with local repositories required by Fuse Service Works --> <profile> <id>fsw-local-repos</id> <repositories> <repository> <id>fsw-6.0.0.GA-redhat-2-repository</id> <name>FSW 6.0.0.GA Repository</name> <url>file://<!-- path to the repository -->/fsw-6.0.0.GA-redhat-2-repository</url> <layout>default</layout> <releases> <enabled>true</enabled> <updatePolicy>never</updatePolicy> </releases> <snapshots> <enabled>false</enabled> <updatePolicy>never</updatePolicy> </snapshots> </repository> <repository> <id>jboss-eap-6.1.1.GA-maven-repository</id> <name>EAP 6.1.1.GA Repository</name> <url>file://<!-- path to the repository -->/jboss-eap-6.1.1.GA-maven-repository</url> <layout>default</layout> <releases> <enabled>true</enabled> <updatePolicy>never</updatePolicy> </releases> <snapshots> <enabled>false</enabled> <updatePolicy>never</updatePolicy> </snapshots> </repository> <repository> <id>jboss-wfk-2.5.0-maven-repository</id> <name>JBoss WFK 2.5.0 Repository</name> <url>file://<!-- path to the repository -->/jboss-wfk-2.5.0-maven-repository</url> <layout>default</layout> <releases> <enabled>true</enabled> <updatePolicy>never</updatePolicy> </releases> <snapshots> <enabled>false</enabled> <updatePolicy>never</updatePolicy> </snapshots> </repository> <repository> <id>jboss-eap-6.0.1-maven-repository</id> <name>EAP 6.0.1 Repository</name> <url>file://<!-- path to the repository -->/jboss-eap-6.0.1-maven-repository</url> <layout>default</layout> <releases> <enabled>true</enabled> <updatePolicy>never</updatePolicy> </releases> <snapshots> <enabled>false</enabled> <updatePolicy>never</updatePolicy> </snapshots> </repository> </repositories> <pluginRepositories> <pluginRepository> <id>fsw-6.0.0.GA-redhat-2-repository</id> <name>FSW 6.0.0.GA Repository</name> <url>file://<!-- path to the repository -->/fsw-6.0.0.GA-redhat-2-repository</url> <layout>default</layout> <releases> <enabled>true</enabled> <updatePolicy>never</updatePolicy> </releases> <snapshots> <enabled>false</enabled> <updatePolicy>never</updatePolicy> </snapshots> </pluginRepository> <pluginRepository> <id>jboss-eap-6.1.1.GA-maven-repository</id> <name>EAP 6.1.1 GA Repository</name> <url>file://<!-- path to the repository -->/jboss-eap-6.1.1.GA-maven-repository</url> <layout>default</layout> <releases> <enabled>true</enabled> <updatePolicy>never</updatePolicy> </releases> <snapshots> <enabled>false</enabled> <updatePolicy>never</updatePolicy> </snapshots> </pluginRepository> <pluginRepository> <id>jboss-wfk-2.5.0-maven-repository</id> <name>JBoss WFK 2.5.0 Repository</name> <url>file://<!-- path to the repository -->/jboss-wfk-2.5.0-maven-repository</url> <layout>default</layout> <releases> <enabled>true</enabled> <updatePolicy>never</updatePolicy> </releases> <snapshots> <enabled>false</enabled> <updatePolicy>never</updatePolicy> </snapshots> </pluginRepository> <pluginRepository> <id>jboss-eap-6.0.1-maven-repository</id> <name>EAP 6.0.1 Repository</name> <url>file://<!-- path to the repository -->/jboss-eap-6.0.1-maven-repository</url> <layout>default</layout> <releases> <enabled>true</enabled> <updatePolicy>never</updatePolicy> </releases> <snapshots> <enabled>false</enabled> <updatePolicy>never</updatePolicy> </snapshots> </pluginRepository> </pluginRepositories> </profile> </profiles> <activeProfiles> <!-- Activation of the Fuse Service Works profile --> <activeProfile>fsw-local-repos</activeProfile> </activeProfiles> </settings>
When you build or deploy a project, it fails with one or both of the following errors:
[ERROR] Failed to execute goal on project PROJECT_NAMECould not find artifact ARTIFACT_NAME
Your cached local Maven repository might contain outdated artifacts.
To resolve the issue, delete the cached local repository – the ~/.m2/repository/ directory on Linux or the %SystemDrive%\Users\USERNAME\.m2\repository\ directory on Windows – and run mvn clean install -U. This will force Maven to download correct versions of required artifacts when performing the next build.
You have updated your Maven configuration, but this configuration is not reflected in JBoss Developer Studio.
If JBoss Developer Studio is running when you modify your Maven settings.xml file, this configuration will not be reflected in JBoss Developer Studio.

Figure 6.1. Update Maven User Settings
6.4. Configuring Maven to Use the Online Repositories
settings.xml file during installation, Maven is already configured to use the online repositories. If you did not provide the location during installation, you need to configure Maven manually by following the procedure in Section 6.4, “Configuring Maven to Use the Online Repositories” or Section 6.3, “Configuring Maven to Use the File System Repositories”.
Procedure 6.2. Configuring Maven to Use the Online Repositories
- Add entries for the online repositories to Maven's
settings.xmlfile as in the code sample below:<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd"> <profiles> <!-- Profile with online repositories required by Fuse Service Works --> <profile> <id>fsw-online-repos</id> <repositories> <repository> <id>jboss-ga-repository</id> <url>http://maven.repository.redhat.com/techpreview/all</url> <releases> <enabled>true</enabled> </releases> <snapshots> <enabled>false</enabled> </snapshots> </repository> <repository> <id>jboss-public-repository</id> <url>http://repository.jboss.org/nexus/content/repositories/public/</url> <releases> <enabled>true</enabled> </releases> <snapshots> <enabled>false</enabled> </snapshots> </repository> </repositories> <pluginRepositories> <pluginRepository> <id>jboss-ga-plugin-repository</id> <url>http://maven.repository.redhat.com/techpreview/all</url> <releases> <enabled>true</enabled> </releases> <snapshots> <enabled>false</enabled> </snapshots> </pluginRepository> <pluginRepository> <id>jboss-public-plugin-repository</id> <url>http://repository.jboss.org/nexus/content/repositories/public/</url> <releases> <enabled>true</enabled> </releases> <snapshots> <enabled>false</enabled> </snapshots> </pluginRepository> </pluginRepositories> </profile> </profiles> <activeProfiles> <!-- Activation of the Fuse Service Works profile --> <activeProfile>fsw-online-repos</activeProfile> </activeProfiles> </settings> - If you modified the
settings.xmlfile while JBoss Developer Studio was running, you must refresh Maven settings in the IDE. From the menu, choose → . In the Preferences Window, expand Maven and choose User Settings. Click the button to refresh the Maven user settings in JBoss Developer Studio.
Figure 6.2. Update Maven User Settings
Maven has been configured to use the online repositories provided for Red Hat JBoss Fuse Service Works.
Important
- Missing artifact ARTIFACT_NAME
- [ERROR] Failed to execute goal on project PROJECT_NAME; Could not resolve dependencies for PROJECT_NAME
~/.m2/repository/ directory on Linux or the %SystemDrive%\Users\USERNAME\.m2\repository\ directory on Windows. This will force Maven to download correct versions of required artifacts during the next build.
6.5. Dependency Management
pom.xml file. Adding the BOM and parent will ensure that correct versions of plug-ins and transitive dependencies from the provided Maven repositories are included in the project.
pom.xml file:
org.jboss.ip.component.management:ip-parent:1.1-redhat-5
dependencyManagement section:
org.jboss.ip.component.management:ip-dependency-management-all:1.1-redhat-5org.jboss.component.management:jboss-dependency-management-all:6.1.2.Final-redhat-5
<parent>
<groupId>org.jboss.ip.component.management</groupId>
<artifactId>ip-parent</artifactId>
<version>1.1-redhat-5</version>
</parent>
...
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.jboss.ip.component.management</groupId>
<artifactId>ip-dependency-management-all</artifactId>
<type>pom</type>
<version>1.1-redhat-5</version>
<scope>import</scope>
</dependency>
<dependency>
<groupId>org.jboss.component.management</groupId>
<artifactId>jboss-dependency-management-all</artifactId>
<type>pom</type>
<version>6.1.2.Final-redhat-5</version>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>Chapter 7. Installing JBoss Developer Studio
7.1. Install JBoss Developer Studio
Procedure 7.1. Install with the Universal Installer
- Log into the Customer Portal at https://access.redhat.com.
- From the menu bar click .
- Under , click .

Figure 7.1. Download Red Hat JBoss Middleware Software on the Customer Portal
- Under Software Downloads, select the following options:
- From the Product list, select JBoss Developer Studio.
- From the Version list, select 7.1.x.
- For the JBoss Developer Studio universal installer, click for the
Red Hat JBoss Developer Studio 7.1.x Stand Alone Universal Binarydownload file. - For the JBoss Developer Studio and JBoss EAP universal installer, click for the
Red Hat JBoss Developer Studio 7.1.x Universal Binary with JBoss EAPdownload file.
This downloads a universal installer.jarfile.- On the command line, navigate to
path/to/.jarand enterjava -jar jbdevstudio-product-universal-version.jar
where version is substituted to match the name of the.jarfile.Note
Alternatively, to start the installer you may be able to double-click the.jarfile. - When the Installer window opens, click .
- After reading and agreeing to the terms of the End User License Agreement, click I accept the terms of this license agreement and click .
- In the Select the installation path field, type the path where you want JBoss Developer Studio to be installed or click to navigate to the location. When the Select the installation path field shows the correct path, click . When you are prompted about the specified location being created or overwritten, review the message and, if satisfied, click or as appropriate.

Figure 7.2. Installation Step 3: Select Target Folder
- In the Select Java VM step, Default Java VM is automatically selected. Ensure that the disabled text field contains the path of the Java developer kit you want to use. This is based on the default Java developer kit of your system. To change the specified Java developer kit, click Specific Java VM and type the path of the Java developer kit in the text field or use the button to locate the Java developer kit. When the text field shows the correct Java developer kit path, click .
Important
You must specify a Java developer kit with a 32-bit JRE to install a 32-bit version of JBoss Developer Studio and a 64-bit JRE to install a 64-bit version of JBoss Developer Studio. To change the bit version of the Java developer kit to be used for installing JBoss Developer Studio, complete the appropriate step for your operating system:- On OS X operating systems, from the Installation type list click the appropriate bit version.
- On Linux distributions and Microsoft Windows operating systems, in the text field type the path to the appropriate bit version of the Java developer kit.

Figure 7.3. Installation Step 4: Select Java VM
- Review the details in the Summary Information window and, if they are correct, click . Installation commences.
- When the Pack installation progress bar shows Finished, click . The installation process is now complete.

Figure 7.4. Installation Step 7: Installation Progress in Finished State
- To create shortcuts for starting JBoss Developer Studio, select the Create shortcuts in the Start-Menu and Create additional shortcut on the desktop check boxes and click .
- To automatically start JBoss Developer Studio when the Installer window closes, select the Run JBoss Developer Studio after installation check box. Click to close the Installer window.
Important
/etc/security/limits.conf file and ensure that the soft nofile and hard nofile variables have values of 9216 at a minimum. If the variables have smaller values, the values must be increased to 9216. If the variables are not specified, the following lines must be added to the file:
* soft nofile 9216 * hard nofile 9216
7.2. Installing JBoss Developer Studio Integration Stack
Procedure 7.2. Install JBoss Developer Studio Integration Stack
- Start JBoss Developer Studio.
- In JBoss Central, select the Software/Update tab. Scroll through the list to locate JBoss Developer Studio Integration Stack. Select the check box next to JBoss Integration and SOA Development and click .

Figure 7.5. Find JBoss Developer Studio Integration Stack in JBoss Central Software/Update Tab
- In the Install wizard, ensure the check boxes are selected for the software you want to install and click . It is recommended that you install all of the selected components.
- Review the details of the items listed for install and click . After reading and agreeing to the license(s), click I accept the terms of the license agreement(s) and click . The Installing Software window opens and reports the progress of the installation.
- During the installation process you may receive warnings about installing unsigned content. If this is the case, check the details of the content and if satisfied click to continue with the installation.

Figure 7.6. Warning Prompt for Installing Unsigned Content
- Once installing is complete, you are prompted to restart the IDE. Click to restart now and if you need to save any unsaved changes to open projects. Note that changes do not take effect until the IDE is restarted.
Important
Appendix A. Prerequisite Software
A.1. Install Open JDK on Red Hat Linux
- Subscribe to the Base Channel Obtain the OpenJDK from the RHN base channel. (Your installation of Red Hat Enterprise Linux is subscribed to this channel by default.)
- Install the Package. Use the yum utility to install OpenJDK:
yum install java-1.7.0-openjdk-devel - Verify that Open JDK is now your system default. You can ensure the correct JDK is set as the system default by following the steps below.
- As a root user, run the alternatives command for java:
/usr/sbin/alternatives --config java - Select
/usr/lib/jvm /jre-1.7.0-openjdk/bin/java. - Apply the same for javac:
/usr/sbin/alternatives --config javac - Select
/usr/lib/jvm /java-1.7.0-openjdk/bin/java.
Open JDK is installed successfully on your machine.
A.2. Install Maven
The following software must be installed:
- An archiving tool for extracting the contents of compressed files.
- Open JDK.
Procedure A.1. Install Maven
Download Maven.
- Enter http://maven.apache.org/download.cgi in the address bar of a browser.
- Download
apache-maven-3.0.5ZIP file and save it to your hard drive.
Install and configure Maven.
On Red Hat Enterprise Linux
- Extract the ZIP archive to the directory where you wish to install Maven.
- Open a terminal.
- Add the M2_HOME environment variable by entering the following command:
export M2_HOME=/usr/local/apache-maven/apache-maven-3.0.x
- Add the M2 environment variable by entering the following command:
export M2=$M2_HOME/bin
- Add the M2 environment variable to your path by entering the following command:
export PATH=$M2:$PATH
- Make sure that JAVA_HOME is set to the location of your JDK. For example:
export JAVA_HOME=/usr/lib/jvm/java-1.7.0-openjdk.x86_64
- Make sure that $JAVA_HOME/bin is in your PATH environment variable.
- Run the following command to verify that Maven is installed successfully on your machine:
mvn --version
On Microsoft Windows
- Extract the ZIP archive to the directory where you wish to install Maven. The subdirectory
apache-maven-3.0.xis created from the archive. - Press Start+Pause|Break. The System Properties dialog box is displayed.
- Click the Advanced tab and click Environment Variables.
- Under System Variables, select Path.
- Click Edit and add the two Maven paths using a semicolon to separate each entry.
- Add the M2_HOME variable and set the path to
C:\Program Files\Apache Software Foundation\apache-maven-3.0.X. - Add the M2 variable and set the value to %M2_HOME%\bin.
- Update or create the Path environment variable:
- Add the %M2% variable to allow Maven to be executed from the command line.
- Add the variable %JAVA_HOME%\bin to set the path to the correct Java installation.
- Click OK to close all the dialog boxes including the System Properties dialog box.
- Open Windows command prompt and run the following command to verify that Maven is installed successfully on your machine:
mvn --version
Maven is successfully installed and configured on your machine.
Appendix B. Verify Your Red Hat JBoss Fuse Service Works Installation
Note
EAP_HOME/InstallationLog.txt.
- If the installer encountered any problems during installation, the installer will display an error message to the user. You can find out more information by viewing the
EAP_HOME/InstallationLog.txtfile. - If no error was reported, you can perform additional verification by performing the following steps:
- Start the server by running
standalone.shcommand - Open the
server.logfile to check if any error messages have been logged and that SwitchYard (and other component subsystems) have loaded correctly - Navigate to the Management Console (http://localhost:9990/) check that you can see the SwitchYard Runtime properties.
- Compile, deploy and run a quickstart application.
Appendix C. Revision History
| Revision History | |||
|---|---|---|---|
| Revision 6.0.0-57 | Wednesday July 22 2015 | ||
| |||
| Revision 6.0.0-56 | Friday June 5 2015 | ||
| |||
| Revision 6.0.0-55 | Tuesday April 14 2015 | ||
| |||
| Revision 6.0.0-54 | Monday February 23 2015 | ||
| |||
| Revision 6.0.0-53 | Tuesday January 13 2015 | ||
| |||
| Revision 6.0.0-52 | Thursday November 20 2014 | ||
|
| |||
