Home
Products
Red Hat Fuse
6.2.1
Tooling User Guide

Tooling User Guide

Red Hat JBoss Fuse Tooling

Developing and Debugging Applications

Red Hat

Version 6.2.1

21 Sep 2017

Abstract

This guide describes how to use the Red Hat JBoss Fuse Tooling, which provides developer tools designed to increase your productivity when designing, developing, testing, and debugging your integration applications.

About Red Hat JBoss Fuse Tooling
Copy link

Red Hat JBoss Fuse Tooling provides a set of developer tools that enable you to work with Fuse and Apache versions of ActiveMQ, Camel, CXF, Karaf, and ServiceMix within Red Hat JBoss Development Studio. You can connect and configure Enterprise Integration Patterns to build routes, browse endpoints and routes, drag and drop messages onto running routes, trace message flows, edit running routes, browse and visualize runtime processes via JMX, and deploy your project's code to Red Hat JBoss Fuse containers and to Apache ServiceMix and Apache Karaf.

Using Red Hat JBoss Fuse Tooling simplifies and streamlines the process of developing integration applications by providing tooling that is specifically designed to work with:

Red Hat JBoss Fuse
Red Hat JBoss A-MQ
Apache Camel
Apache CXF
Apache Karaf

Note

You can also develop Fuse projects using Maven (for details, see Getting Started with Developing).

Using the Red Hat JBoss Fuse Tooling streamlines the process at all stages of application development:

Create a Maven project for your application.
The tooling loads all of the relevant Maven archetypes for creating integration projects using the Red Hat supported Apache projects.
Add new pieces of logic and functionality to an application.
The tooling has a wizard for creating Apache Camel context files.
Edit the integration logic.
The tooling has a visual route editor that makes editing Apache Camel routes as easy as dragging and dropping route components.
Debug your local Camel context.
The tooling includes a full-featured Camel debugger for debugging locally running Camel contexts.
Test the application.
The tooling includes testing tools that provide the full gamut of testing capabilities including:
- creating and using JUnit test cases on Apache Camel routes
- using JMX to analyze running components
- tracing messages through Apache Camel routes
Deploy the application.
The tooling can deploy applications to a number of containers.

Note

See the Red Hat JBoss Fuse Tooling Tutorials for step-by-step instructions on:

Creating a Route
Running a Route
Adding a Content-Based Router
Adding Another Route to the CBR Routing Context
Debugging a Routing Context
Tracing a Message Through a Route
Testing a Route with JUnit
Publishing a Fuse Project to Red Hat JBoss Fuse

Part I. Introducing the Fuse Tooling User Interface
Copy link

Red Hat JBoss Fuse Tooling is an Eclipse-based IDE for creating and testing small- and large-scale integration applications. Its key features are a graphical routing editor, a full-featured Camel debugger for debugging locally running routing contexts, an integrated testing platform that uses JMX to communicate with the containers in a small-scale test environment, and tooling for using Fabric8 to test applications in large-scale, highly-distributed test environments.

Chapter 1. JBoss Perspective
Copy link

Overview
Copy link

By default, Red Hat JBoss Developer Studio starts up in JBoss perspective. To access the design time tooling, you select File → New → Fuse Project on the menu bar.

Note

Though you can also do all of your development in Fuse Integration perspective, JBoss perspective provides more space for the route editor to expand to accommodate complex routes.

Creating a new Fuse project provides access to the route editor, the main design time tooling, shown in Figure 1.1.

Figure 1.1. route editor

It consists of four main areas:

Canvas—the large grid area on which routes are constructed
Palette—the pane to the right of the canvas from which Enterprise Integration Patterns (EIPs) are selected
Project view—the pane on the left side of the canvas, which can display multiple views of the active project. The pane defaults to Project Explorer, which displays the project's folders and files in an hierarchical tree format.
Note
Red Hat recommends you to close the JMX Navigator view and then drag Outline view from the upper right side of the workspace to the lower left side, beneath Project Explorer, to provide optimal space for the route editor. Outline view displays, in an outline of EIP icons, the contents of the current <camelContext> element in the routing context file.
Properties editor—the editor in which you configure the selected node's properties. It opens in a tab in the pane below the canvas.

Canvas
Copy link

The canvas is route editor's workbench and where you do most of your work. It displays a graphical representation of a route, which is made up of one or more connected EIP patterns (called nodes once they are placed on the canvas). Because the canvas displays only one route at a time, it delineates one route from another. You can add additional routes to your project, but each is displayed separately on its own slice of canvas.

Patterns are typically placed on the canvas by dragging them from the palette. Once on the canvas, a node's properties can be edited in the Properties editor. To do so, you need only select a node to open and populate the Properties editor with the properties that apply to that node. You can also edit a route's properties by clicking the canvas, which opens and populates the Properties editor with the properties that correspond to a single route in the routing context file.

Note

Clicking the Source tab at the lower, left of the canvas displays the XML code generated for the route, which you can then edit. The edits you make in Source view appear on the canvas when you switch back to Design View.

Palette
Copy link

The Palette contains all of the patterns needed to construct a route. The Palette groups the patterns into categories according to function:

Components—endpoint patterns that start or end a route
Defined Endpoints—endpoint nodes that have been defined in the routing context
Routing—patterns that direct the flow of messages based on specified criteria
Control Flow—patterns that behave like control functions in a programming language. For example, some define loops, some handle error conditions, some handle transactions, and so on.
Transformation—patterns that change the contents of a message as it passes through a route
Miscellaneous—patterns that control the environment in which a route executes. For example, the Threads pattern specifies the number of threads available.

Project Explorer
Copy link

Project Explorer provides access to all of the components that make up a project. It provides the tools for managing, configuring, running, and debugging your project.

Outline view
Copy link

Outline view provides a graphical outline of your route components. It enables you to switch easily between routes in a multiroute project. Clicking on a route in Outline view displays it on the route editor's canvas.

Outline view also provides a viewing portal when the route extends beyond the viewable area on the canvas. Sliding the view portal in Outline view over outlier nodes moves the canvas accordingly to bring those nodes into view.

Properties editor
Copy link

You use the Properties editor to configure the route and each node in it. Each type of node has a set of properties that can or must be set. The Properties editor opens populated with fields that apply to the selected node.

The Properties editor makes it clear which fields are required.

marks any required property that is not set, and the Properties editor displays an error message stating the number of required properties that still must be set, as shown in Figure 1.2.

Figure 1.2. Properties editor's error reporting

The Properties editor's Documentation tab displays information about how to configure the selected node.

Chapter 2. Debug Perspective
Copy link

Overview
Copy link

The Debug perspective, shown in Figure 2.1, provides access to all of the Camel debugger's functions. It contains all of the views used to monitor and debug a running routing context.

Figure 2.1. Debug perspective

Debug view
For the running routing context, Debug view displays the debug stack.
You can switch between breakpoints within the same message flow, listed under the Camel Context at service:jmx:rmi://jndi/rmi://localhost:1099/jmxrmi/camel entry, to review and compare variable values in Variables view.
Messages flows are identified by their unique breadcrumb ID, and the breadcrumb ID of each subsequent message flow is incremented by 2. For example, in Figure 2.1, “Debug perspective”, the breadcrumb ID for the first message flow is ID-janemurpheysmbp-home-61339-11430424775526-0-1, so the breadcrumbID for the second message flow would be ID-janemurpheysmbp-home-61339-11430424775526-0-3.
Variables view
For each node in the routing context that has a breakpoint set, Variables view displays the value of the available variables when the breakpoint is hit. Each variable who's value changed since the preceding breakpoint is highlighted in yellow.
You can change the value of editable variables to check whether such changes produce the expected results and to test the robustness of your routing context.
You can also add variables to the watch list, so you can quickly and easily see whether their values change as expected at the expected point in the message flow.
Breakpoints view
Displays a list of the breakpoints set in the routing context, and shows whether they are enabled or disabled. You can enable and disable individual breakpoints by checking (enabling) or unchecking (disabling) them. This enables you to temporarily focus on nodes in your routing context that are behaving problematically.
The button skips over disabled breakpoints to jump to the next active breakpoint in the routing context. In contrast, the button jumps to the next node of execution in the routing context, regardless of breakpoints.
Camel Context: view
Displays the running CamelContext:<CamelId>.xml in graphical mode. For nodes set with breakpoints, it shows the type of breakpoint set and whether the breakpoint is enabled or disabled. When a breakpoint is hit, its corresponding node on the canvas is outlined in red.
To check a node's configuration, open Properties view and then select the node on the canvas in Camel Context: view.
Console view
Displays the log output generated by the Camel debugger as it executes the routing context.
Properties view
Displays the properties set for the node selected on the canvas in CamelContext: view.

Chapter 3. Fuse Integration Perspective
Copy link

Overview
Copy link

The Fuse Integration perspective, shown in Figure 3.1, provides access to all of the tooling for monitoring and testing your integration application.

Figure 3.1. Fuse Integration perspective

The Fuse Integration perspective consists of eight main areas:

Project Explorer—displays all of the projects known to the tooling. You can view all of the artifacts that make up each project. Project Explorer also displays all of the routing context .xml. files for a project under its Camel Contexts node. This makes it easy for you to find and open the routing context file of any route included in a project.
JMX Navigator—lists the JMX servers and the infrastructure they monitor. It allows you to browse JMX servers and the pocesses they are monitoring. It also identifies instances of Red Hat processes.
Diagram View—displays a graphical tree representing the node selected in JMX Navigator. When you select a process, server, endpoint, or other node, Diagram view shows the selected node as the root and branches down to its children and grandchildren.
When you select a broker, Diagram View displays up to three children: connections, topics, and queues. It also shows configured connections and destinations as grandchildren.
When you select a route, Diagram view displays all of the nodes in the route and shows the different paths that messages can take through it. It also displays timing metrics for each processing step in the route when route tracing is enabled.
Shell view—Displays the command console of the connected container. You can control the container by entering commands in Shell view.
Messages View—lists the messages that have passed through the selected JMS destination or through Apache Camel endpoints when route tracing is enabled.
Servers view—displays a list of servers (Red Hat JBosss Fuse, Apache Karaf, or Apache ServiceMix) managed by the tooling. It displays their runtime status and provides controls for starting and stopping them and for debugging projects deployed on them.
Properties view—displays the properties of the selected node.
Console view— displays the console output for recently executed actions.

JMX Navigator
Copy link

The JMX Navigator drives all monitoring and testing activities in Fuse Integration perspective. It determines which routes are displayed in Diagram View, the Properties viewer, and Messages View. It is also provides menu commands for activating route tracing, adding and deleting JMS destinations, and starting and suspending routes. It is also the target for dragging and dropping messages onto a route.

By default, JMX Navigator shows all of the Java processes running on your local machine. You can add JMX servers as needed to view infrastructure on other machines.

Messages view
Copy link

The Messages View is used for browsing JMS destinations and for tracing messages that have passed through a route.

When a JMS destination is selected in JMX Navigator, the view lists all of the messages sitting in the destination.

When route tracing is enabled, Messages View lists all of the messages that passed through the nodes in the route since tracing started. You can configure Messages View to display only the data in which you are interested and in your preferred sequence.

When a message trace in Messages View is selected, its details (message body and all message headers) are displayed in the Properties viewer. In Diagram View, the step in the route associated with the selected message trace is also highlighted.

Chapter 4. Fabric8 Perspective
Copy link

The Fabric8 perspective, shown in Figure 4.1, is where you access the fabric development and debugging tools.

Figure 4.1. Fabric8 perspective

The Fabric8 perspective consists of six main areas:

Fabric Explorer—lists the fabrics and the containers, profiles, and versions of which they consist.
Diagram View—provides a graphical representation of a node selected in Fabric Explorer.
Shell— provides console access to any container running on the fabric.
Log view—lists the log entries of the selected container or the selected JMX process.
Messages View—lists the message instances that passed through the nodes in a selected route, after tracing was enabled on the route.
Properties view—displays the properties of an object selected in Fabric Explorer.

Fabric Explorer
Copy link

Fabric Explorer provides access to your fabrics. Once the tooling is connected to a fabric, Fabric Explorer provides access to all of the fabric's components (containers, profiles, and profile versions) enabling you to configure, run, and debug your project in the fabric environment.

Diagram view
Copy link

Use Diagram View in conjunction with Messages View to track a message through the nodes of a route for which tracing has been activated. In Diagram View, the node which corresponds to the message instance selected in Messages View is highlighted. Messages View displays metrics for the selected message instance, including the time at which it exited the highlighted node.

Log view
Copy link

Log view displays the log entries of the container selected in Fabric Explorer. This feature enables you to see the log messages of any container running in a fabric.

Double-clicking a process in a container's JMX tree opens the process in a jconsole-like viewer, where you can browse its attributes, operations, notifications, and other information, all of which are presented in tabular format.

Messages view
Copy link

The Messages View is used for tracing messages through a route in a fabric environment.

When an Apache Camel route for which route tracing has been activated is selected in Fabric Explorer, Messages View lists all messages that pass through the route from the time tracing was activated. Messages View also provides metrics for each message instance, making it easier to debug routes.

Use the view's Refresh button periodically to update its display of message traces.

Properties view
Copy link

For container nodes, the Properties view also provides the Profiles tab, for viewing the profiles assigned to the container, and the Profile Details tab, for viewing the details of each assigned profile.

The Profiles editor enables you to change the profiles associated with the selected container, and the Profile Details editor enables you to modify the configuration of the selected profile.

JMX viewer
Copy link

Part II. Developing Applications
Copy link

We reccomend that you develop your applications in Chapter 1, JBoss Perspective because it provides more room to expand the route editor's canvas when you are building complex routes. If it is not already open, click

on the right side of the JBoss Developer Studio tool bar.

Chapter 5. Creating a New Fuse Project
Copy link

Overview
Copy link

The tooling uses Maven archetypes to generate a project with all of the dependencies preconfigured. The archetypes also create the POM file needed to run and deploy your application, as well as sample code and data to get you started.

Procedure
Copy link

To create a Fuse project:

Select File → New → Fuse Project to open the New Fuse Project wizard shown in Figure 5.1, “New Fuse Project Wizard's Project Location Page”.
Figure 5.1. New Fuse Project Wizard's Project Location Page

View larger image

The wizard opens with the Use default workspace location option selected on the location page.
Enter the name of the Fuse project.
Specify the location where the data for the project will be stored.
- To use the default workspace select Use default workspace location.
- To use an alternative location clear Use default workspace location and specify a new location in the provided field.
  Clicking opens a file browser.
If you want to add the new project to an Eclipse working set, select Add project(s) to working set and enter the name of the working set.
Click to open the New Fuse Project details page shown in Figure 5.2.
Figure 5.2. New Fuse Project wizard's details page

View larger image
Select a project type from the list.
Note
The route editor works with these project types:
- camel-archetype-activemq
  Creates a new Apache Camel project that configures and interacts with Apache ActiveMQ.
- camel-archetype-blueprint
  Creates a new Apache Camel project with support for OSGi blueprint that is deployment-ready for OSGi.
- camel-archetype-cxf-code-first-blueprint
  Creates a new Apache Camel project with Apache CXF code-first example using OSGi Blueprint.
- camel-archetype-cxf-contract-first-blueprint
  Creates a new Apache Camel project with Apache CXF contract-first example using OSGi Blueprint.
- camel-archetype-java
  Creates a new Apache Camel project using Java DSL.
  You cannot edit Java DSL in the route editor.
- camel-archetype-spring
  Creates a new Apache Camel project with added support for Spring DSL.
- camel-archetype-spring-dm
  Deprecated Creates a new Apache Camel project with added support for Spring DSL that is deployment-ready for OSGi.
- camel-archetype-web
  Creates a new Apache Camel web project that deploys the Camel routes as a WAR.
- cxf-jaxrs-service
  Creates a simple CXF JAX-RS web application service using Spring configuration.
- cxf-jaxws-javafirst
  Creates a project for developing a Web service starting from Java code.
Enter a group ID for the project in the Group Id field, or accept the default.
The tooling uses the group ID to form the first part of the dot-separated package name. For example, if you enter Demo for the group ID, it appears in the Package field as Demo..
Enter an artifact ID for the project in the Artifact Id field, or accept the default.
The tooling uses the artifact ID as the name of the project and to form the second part of the dot-separated package name. For example, if you enter BigRoute for the artifact ID, it appears in the Package field as Demo.BigRoute.
Enter a version for the project in the Version field, or accept the default.
If you want to change the package name generated for the artifacts, enter the new package name in the Package field.
Click Finish to create the Maven project, which contains starting point artifacts.

Resolving Maven dependency errors
Copy link

You may encounter Maven dependency errors after you create a new Fuse project.

Though it can happen at other times, it more typically occurs when you create a project based on any of the supplied archetypes for the first time, but then cancel the project before the process finishes. Interrupting the process in this way often prevents all of the project's dependencies from downloading from the Maven repositories, which can take some time.

You can often easily resolve these dependency errors by updating Maven dependencies this way:

In Project Explorer, select the root project just created.
Right-click it to open the context menu.
Select Maven → Update Project...
In the Update Maven Project wizard, check Force Update of Snapshots/Releases.
Click OK.
In the bottom, right corner of the workbench, you may see the progress status bar churning as missing dependencies are downloaded from the Maven repositories.

Chapter 6. Creating a New Camel XML file
Copy link

Overview
Copy link

Apache Camel stores routes in an XML file that contains a camelContext element. The tooling includes a wizard that simplifies adding an Apache Camel context file to your project. It creates a new XML file that has all of the required namespaces preconfigured and a template camelContext element.

Procedure
Copy link

To add an Apache Camel context file to your project:

Select File → New → Other... → Fuse Tooling → Camel XML File from the main menu to open the Camel XML File wizard, as shown in Figure 6.1, “Camel XML File wizard”.
Figure 6.1. Camel XML File wizard

View larger image
In RouteContainer, enter the location for the new file, or accept the default.
You can click to search for an appropriate location.
Important
The Spring framework and the OSGi Blueprint framework require that all Apache Camel files be placed in specific locations under the project's META-INF or OSGI-INF folder:
- Spring—projectName /src/main/resources/META-INF/spring/
- OSGi Blueprint—projectName /src/main/resources/OSGI-INF/blueprint/
In File Name, enter a name for the new context file, or accept the default.
The file's name cannot contain spaces or special characters, and it must be unique within the JVM.
In Framework, accept the default, or select which framework the routes will use:
- Spring—for routes that will be deployed in Spring containers, non-OSGi containers, or as standalone applications
- OSGi Blueprint—for routes that will be deployed in OSGi containers
- Routes—for routes that you can load and add into existing camelContexts
Click Finish.
The new context file is added to the project and opened in the route editor.

Chapter 7. Editing a routing context in the route editor
Copy link

Developing an Apache Camel application typically consists of the following tasks:

Adding one or more routes to the routing context.
Adding a starting point pattern to a route.
Adding one or more endpoint patterns to a route.
Adding one or more processor patterns that represent how messages will be transformed and routed between the starting point and endpoint(s).
Connecting the patterns (referred to as nodes once they are placed on the canvas).
Configuring the details for each of the endpoints and processors that make up the route.
Adding any configuration beans to the context.

7.1. Adding routes to the routing context
Copy link

Overview
Copy link

The camelContext element within an XML context file creates a routing context. The camelContext element can contain one or more routes, but the route editor's canvas can display only one of the routes at a time. Therefore the canvas is each route's delineator, and each route displayed on the canvas maps to a route element in the generated camelContext element.

When you create a new Fuse Project, the tooling creates an example camelContext.xml file that is defined either as camel-context.xml (Spring) or blueprint.xml (Blueprint). You can view and edit the contents of the camelContext.xml file in the route editor's Source view. In Design view, the route editor presents an empty canvas, which represents the empty route element. You can drag patterns from the Palette and drop them onto the canvas to create a route. The design time tooling updates the empty route element with XML code generated from the patterns you drop onto the canvas.

The tooling provides three methods for adding a new route:

From the menu bar, by opening the Routes menu, and then selecting Add Route
In Design view, by right-clicking the canvas or a node to access the context menu, and then selecting Add → Route
In Source view, by adding a <route/> element to the existing list within the camelContext element

Procedure
Copy link

To add another route to the camelContext:

Select one of the methods for adding a route.
In Design view, a route icon appears in Outline view, and the Properties editor displays the list of the new route's properties for you to edit.
In the Properties editor, enter an ID (for example, Route2) for the new route in the route's ID field.
In Outline view, the new ID displays next to the new route icon.
In the Properties editor, enter a description of the route in the Description field.
On the menu bar, select File → Save to save the changes you made to the routing context file.

Note

To switch between multiple routes, select the route you want to display on the canvas by clicking it in Outline view or by selecting it from the Routes menu on the menu bar.

7.2. Adding patterns to a route
Copy link

Routes consist of a sequence of connected patterns, referred to as nodes once they are placed on the canvas. To add a pattern to a route you can either:

Drag the pattern from the palette
Use the context menu

Both methods provide access to all of the available patterns. Dragging patterns from the palette and dropping them onto the canvas is an easy and convenient way to add multiple patterns to the canvas quickly. Using a node's context menu, you can add and automatically connect a pattern to the node.

7.2.1. Drag and drop a pattern
Copy link

Overview
Copy link

The Palette lists all of the available patterns, grouped by function. For example, the Loop pattern is part of the Control Flow group.

You can select any pattern from the Palette and drag it to the canvas, which represents a single route.

Procedure
Copy link

To drag a pattern onto a route:

In the Palette, locate the desired pattern.
Select the pattern, drag it to the canvas, and then release the mouse button.
Note
You need not place the pattern in its intended location. You can easily move any node on the canvas by dragging it to a new location.

The new pattern appears on the canvas and becomes the selected node. The Properties editor displays a list of the node's properties for you to edit and configure.

7.2.2. Using the context menu
Copy link

Overview
Copy link

Nodes on the canvas have a context menu that includes an Add option for adding new patterns to a route.

Procedure
Copy link

To add and connect a pattern to a node in a route:

In the canvas, select the node to which you want to connect the new pattern.
Right-click it to open the context menu.
Select Add to display the list of patterns that can be connected to the selected node. The patterns are grouped according to function.
Select the pattern to add to the route.

The new pattern is added to the route and automatically linked to the selected node. The new pattern becomes the currently selected node, and the Properties editor displays a list of the node's properties for you to edit and configure.

7.3. Connecting patterns to make a route
Copy link

Overview
Copy link

Until the patterns on the canvas (referred to as nodes) are connected, they do not constitute a route. The editor does not save a route element in the context file until all nodes are linked together to form a complete route. A complete route typically consists of a starting endpoint, a string of processing nodes, and one or more destination endpoints.

Connecting two nodes on the canvas is as simple as dragging a line from one to the other. Each node has a connector arrow. Selecting a node and dragging its connector arrow to a target node establishes a connection between the two nodes.

Procedure
Copy link

To connect two nodes:

On the canvas, select the source node to display its connector arrow.
Click-drag the source node's connector arrow ( ) to the target node.
The direction of the connection represents the direction messages flow between the nodes in the route.
While hovering over the target node, release the mouse button to drop the connector on it.
The route editor updates the <route> element with the xml generated from the connection. You can view the xml in Source view.
When you are done, save your work by selecting File → Save from the menu bar.

7.4. Configuring a pattern
Copy link

Overview
Copy link

Most patterns require some explicit configuration. For example, an endpoint requires an explicitly entered URI.

The tooling's Properties editor provides a form that lists all of the configuration details a particular pattern supports. The Properties editor also provides the following convenience features:

validating that all required properties have values
drop-down lists for properties that have a fixed set of values
drop-down lists that are populated with the available bean references from the Apache Camel Spring configuration

Procedure
Copy link

To configure a pattern:

On the canvas, select the node you want to configure.
The Details tab in the Properties editor lists all of the selected node's properties for you to edit. The Documentation tab describes the pattern and each of its properties.
Edit the fields in the Properties editor to configure the node.
When done, save your work by selecting File → Save from the menu bar.

7.5. Rearranging patterns on the canvas
Copy link

As your route grows and changes, you'll likely need to change how it is laid out on the canvas. Changing the layout does not change the underlying DSL, but it does make it easier to visualize the route.

The tooling provides two ways to rearrange the patterns on the canvas:

dragging and dropping
the context menu's

7.5.1. Rearranging patterns by dragging them
Copy link

Overview
Copy link

You can select one or more nodes on the canvas and drag them to a new location. Each node's connections are retained and move along with it. However, the layout of the route will continue to change as it grows in scope and complexity.

Procedure
Copy link

To drag a node to a new location on the canvas:

Determine which node or nodes you want to move.
Select one node, or select a group of nodes by dragging a box around them.
Drag the node or nodes to their new location, then release the mouse button.

Note

You can also rearrange the connectors between nodes to accommodate increasing numbers of patterns on the canvas. Clicking a connector joining two nodes on the canvas reveals a line segmented by a bendpoint. You can drag the bendpoint to another location on the canvas while leaving the two nodes in place. Dragging a bendpoint creates two new bendpoints on either side of it, further segmenting the connector. This feature makes it easy to organize the nodes in a complex route for visual clarity.

7.5.2. Automatically aligning patterns
Copy link

Overview
Copy link

The Layout Diagram command on the canvas' context menu automatically aligns all nodes on the canvas relative to the route's start point. By default, the route editor arranges the nodes in a route from left to right across the canvas, according to the order in which they are connected to each other. It moves the start point to the left edge of the canvas, then aligns the processing nodes and endpoints accordingly.

Note

You can change the default layout direction (Right). To do so, on the menu bar select Window → Preferences → Fuse Tooling → Editor, and then select Down from the Choose the layout direction for the diagram editor's drop-down list.

You can continue adding more patterns to your route after you execute the Layout Diagram command.

Procedure
Copy link

To direct the tooling to automatically align all nodes on the canvas:

Right-click the canvas to open the context menu.
Select Layout Diagram.

7.6. Removing patterns from a route
Copy link

Overview
Copy link

As you develop and update a route, you may need to remove one or more of the route's nodes. The Remove option on the nodes' context menu makes this easy to do. When you delete a node from the canvas, all of its connections with all other nodes on the canvas are also deleted.

Note

You can also remove a node by right-clicking it in Outline view and selecting Remove, or by selecting Edit → Delete from the menu bar.

Procedure
Copy link

To remove a node from a route:

Select the node you want to delete.
Right-click it to open the context menu.
Select Remove.

The node and all of its connections are deleted from the canvas.

7.7. Disconnecting two patterns
Copy link

Overview
Copy link

As you develop and update a route, you may need to disconnect some nodes. The Remove option on the connector context menu makes this easy to do.

Note

You can also delete a connector by selecting Edit → Delete from the menu bar.

Procedure
Copy link

To disconnect two nodes:

Select the connector you want to delete.
Right-click it to open the context menu.
Select Remove.

The connector between the nodes is removed.

7.8. Deleting a route
Copy link

Overview
Copy link

In some cases you made need to delete an entire route from your routing context. The Remove Route option on the canvas' context menu makes this easy to do. When you delete a route, all of the nodes the route contains are also deleted.

Note

You can also remove a route from the Routes menu on the menu bar.

Procedure
Copy link

To delete a route:

If the routing context contains more than one route, first select the route you want to delete in Outline view.
Right-click on the canvas to open the context menu.
Select Remove Route.

The route is removed from the canvas and from the camelContext.

7.9. Adding beans and configuration
Copy link

Overview
Copy link

Many routing patterns rely on references to Java objects (beans) for configuration or for implementation details. You add the beans into the routing context file using the route editor's Source tab.

Procedure
Copy link

To add beans to your routing context file:

Open your routing context file in the route editor.
Click the Source tab at the bottom of the route editor's canvas to switch to Source view, so you can edit the XML that defines the route.
Enter the bean elements needed by your route before the camelContext element.
Note
Use the id attribute to identify the bean, not the name attribute.
Important
Do not edit the contents of the camelContext element. Red Hat JBoss Fuse Tooling overwrites the camelContext element when changes are made to the route diagram in Design view.
Save your changes by selecting File → Save on the menu bar.
Click the Design tab at the bottom of the route editor's canvas to return to Design view and the route diagram.

7.10. Configuring the route editor
Copy link

Overview
Copy link

Using JBoss Developer Studio's preference panel, you can specify many aspects of the route editor's behavior:

The default language to use for expressions in EIPs
The method for labeling nodes on the canvas
The direction in which patterns flow on the canvas when creating routes
Whether the canvas displays a grid overlay
Colors used for various diagrammatic components

Procedure
Copy link

To configure the route editor:

In JBoss Developer Studio, click Window → Preferences to open the Preferences dialog.
Click Fuse Tooling → Editor to show the Editor preferences.
Select, from the drop-down list, the default language you want to use for expressions in EIP nodes.
Click the checkbox next to If enabled the ID values will be use for labels if existing to enable or disable using node IDs as labels.
Select, from the drop-down list, the direction in which you want the route editor to align the patterns in a route.
Click the checkbox next to Show diagram grid in Routes Editor to enable or disable displaying the grid overlay on the canvas.
Click Apply to apply the changes to the Editor preferences.
Click Fuse Tooling → Colors to show the Colors preferences.
For each component whose color you want to change, click its color icon to open the color palette, and then select a color from the palette.
When done, click Apply and then OK to close the Preferences dialog.
You can restore the route editor's original color scheme at any time by returning to Fuse Tooling → Colors and clicking Restore Defaults.

Chapter 8. Creating a new Apache Camel JUnit test case
Copy link

Overview
Copy link

A common way of testing routes is to use JUnit. The design time tooling includes a wizard that simplifies creating a JUnit test case for your routes. The wizard uses the endpoints you specify to generate the starting point code and configuration for the test.

Note

After you create the boilerplate JUnit test case, you need to modify it to add expectations and assertions specific to the route that you've created or modified, so the test is valid for the route.

Procedure
Copy link

To create a new JUnit test case for your route:

In Project Explorer, select the camel-context.xml file in your routing project.
Right-click it to open the context menu, and then select New → Camel Test Case to open the New Camel JUnit Test Case wizard, as shown in Figure 8.1, “New Camel JUnit Test Case wizard”.
Figure 8.1. New Camel JUnit Test Case wizard

View larger image

Alternatively, you can open the wizard by selecting File → New → Other... → Fuse Tooling → Camel Test Case from the menu bar.
In Source folder, accept the default location of the source code for the test case, or enter another location.
You can click to search for a location.
In Package, accept the default package name for the generated test code, or enter another package name.
You can click to search for a package.
In Camel XML file under test, accept the default pathname of the routing context file that contains the route you want to test, or enter another pathname.
You can click to search for a context file.
In Name, accept the default name for the generated test class, or enter another name.
Select the method stubs you want to include in the generated code.
If you want to include the default generated comments in the generated code, check the Generate comments box.
Click to open the Test Endpoints page. For example, Figure 8.2, “New Camel JUnit Test Case page” shows a route's input and output file endpoints selected.
Figure 8.2. New Camel JUnit Test Case page

View larger image
Under Available endpoints, select the endpoints you want to test. Click the checkbox next to any selected endpoint to deselect it.
Click .
Note
If prompted, add JUnit to the build path.

The artifacts for the test are added to your project and appear in Project Explorer under src/test/java. The class implementing the test case opens in the Java editor.

Chapter 9. The Source View
Copy link

The tooling's Source tab opens the route editor in Source view (Figure 9.1) to display the contents of an Apache Camel route file as XML.

Figure 9.1. Source view

The Source view is useful for editing and adding any configuration, comments, or beans to the routing context file. The Content Assist functionality helps you when working with configuration files. In the Source view, press Ctrl+Space to see a list of possible values that can be inserted into your project.

While the route editor allows you to change the contents of the camelContext element in the routing context file, not all changes are preserved. Comments inserted into the camelContext element are lost upon switching to Design view.

Chapter 10. Running routes inside Red Hat JBoss Fuse Tooling
Copy link

There are two basic ways to run your routes using the tooling:

As a local camel context (with or without tests)
Using Maven

10.1. Running routes as a local Camel context
Copy link

Overview
Copy link

The simplest way to run an Apache Camel route is as a Local Camel Context. This method enables you to launch the route directly from Project Explorer's context menu. When you run a route from the context menu, the tooling automatically creates a runtime profile for you. You can also create a custom runtime profile for running your route.

Your route runs as if it were invoked directly from the command line and uses Apache Camel's embedded Spring container. You can configure a number of the runtime parameters by editing the runtime profile.

Procedure
Copy link

To run a route as a local Camel context:

In Project Explorer, select a routing context file.
Right-click it to open the context menu, and then select Run As → Local Camel Context.
Note
Selecting Local Camel Context (without tests) directs the tooling to run the project without performing validation tests, which may be faster.

Result
Copy link

The Console view displays the output generated from running the route.

10.2. Running routes using Maven
Copy link

Overview
Copy link

If the project containing your route is a Maven project, you can use the m2e plug-in to run your route. Using this option, you can execute any Maven goals, before the route runs.

Procedure
Copy link

To run a route using Maven:

In Project Explorer, select the root of the project .
Right-click it to open the context menu, and then select Run As → Maven build.
- The first time you run the project using Maven the Edit Configuration and launch editor opens, so you can create a Maven runtime profile.
  To create the runtime profile:
  1. Make sure the route directory of your Apache Camel project appears in the Base directory: field.
    For example on Linux the root of your project will be similar to ~/workspace/simple-router.
  2. In the Goals: field, enter camel:run.
  3. Click Apply and then Run.
- Subsequent Maven runs use this profile, unless you modify it between runs.

Results
Copy link

The Console view displays the output from the Maven run.

10.3. Working with runtime profiles
Copy link

Red Hat JBoss Fuse Tooling stores information about the runtime environments for each project in runtime profiles. The runtime profiles keep track of such information as which Maven goals to call, the Java runtime environment to use, any system variables that need to be set, and so on. A project can have more than one runtime profile.

10.3.1. Editing a Local Camel Context runtime profile
Copy link

Overview
Copy link

A Local Camel Context runtime profile configures how Apache Camel is invoked to execute a route. A Local Camel Context runtime profile stores the name of the context file in which your routes are defined, the name of the main to invoke, the command line options passed into the JVM, the JRE to use, the classpath to use, any environment variables that need to be set, and a few other pieces of information.

The runtime configuration editor for a Local Camel Context runtime profile contains the following tabs:

Camel Context File—specifies the name of the new configuration and the full path of the routing context file that contains your routes.
Main—specifies the fully qualified name of the project's base directory, a few options for locating the base directory, any goals required to execute before running the route, and the version of the Maven runtime to use.
JRE—specifies the JRE and command line arguments to use when starting the JVM.
Refresh—specifies how Maven refreshes the project's resource files after a run terminates.
Environment—specifies any environment variables that need to be set.
Common—specifies how the profile is stored and the output displayed.

The first time an Apache Camel route is run as a Local Camel Context, Red Hat JBoss Fuse Tooling creates for the routing context file a default runtime profile, which should not require editing.

Accessing the Local Camel Context's runtime configuration editor
Copy link

In Project Explorer, select the camelContext file for which you want to edit or create a custom runtime profile.
Right-click it to open the context menu, and then select Run As... → Run Configurations to open the Run Configurations dialog.
In the context selection pane, select Local Camel Context, and then click at the top, left of the context selection pane.
In the Name field, enter a new name for your runtime profile.

Figure 10.1. Runtime configuration editor for Local Camel Context

Local camel context runtime configuration editor

Setting the camel context file
Copy link

The Camel Context File tab has one field, Select Camel Context file.... Enter the full path to the routing context file that contains your route definitions.

The Browse... button accesses the Open Resource dialog, which facilitates locating the target routing context file. This dialog is preconfigured to search for files that contain Apache Camel routes.

Changing the command line options
Copy link

By default the only command line option passed to the JVM is:

-fa context-file

-fa context-file

Copy to Clipboard

Toggle word wrap

If you are using a custom main class you may need to pass in different options. To do so, on the Main tab, click the Add button to enter a parameter's name and value. You can click the Add Parameter dialog's Variables... button to display a list of variables that you can select.

To add or modify JVM-specific arguments, edit the VM arguments field on the JRE tab.

Changing where output is sent
Copy link

By default, the output generated from running the route is sent to the Console view. But you can redirect it to a file instead.

To redirect output to a file:

Select the Common tab.
In the Standard Input and Output pane, click the checkbox next to the File: field, and then enter the path to the file where you want to send the output.
The Workspace..., File System..., and Variables... buttons facilitate building the path to the output file.

10.3.2. Editing a Maven runtime profile
Copy link

Overview
Copy link

A Maven runtime profile configures how Maven invokes Apache Camel. A Maven runtime profile stores the Maven goals to execute, any Maven profiles to use, the version of Maven to use, the JRE to use, the classpath to use, any environment variables that need to be set, and a few other pieces of information.

The runtime configuration editor for a Fuse runtime profile contains the following tabs:

Main—specifies the name of the new configuration, the fully qualified name of the project's base directory, a few options for locating the base directory, any goals required to execute before running the route, and the version of the Maven runtime to use.
JRE—specifies the JRE and command line arguments to use when starting the JVM.
Refresh—specifies how Maven refreshes the project's resource files after a run terminates.
Environment—specifies any environment variables that need to be set.
Common—specifies how the profile is stored and the output displayed.

The first time an Apache Camel route is run using Maven, you must create a default runtime profile for it.

Accessing the Maven runtime configuration editor
Copy link

In Project Explorer, select the root of the project for which you want to edit or create a custom runtime profile.
Right-click it to open the context menu, and then select Run As... → Run Configurations to open the Run Configurations dialog.
In the context selection pane, select m2 Maven Build, and then click at the top, left of the context selection pane.

Figure 10.2. Runtime configuration editor for Maven

Changing the Maven goal
Copy link

The most commonly used goal when running a route is camel:run. It loads the routes into a Spring container running in its own JVM.

The Apache Camel plug-in also supports a camel:embedded goal that loads the Spring container into the same JVM used by Maven. The advantage of this is that the routes should bootstrap faster.

If your POM contains other goals, you can change the Maven goal used by clicking the Configure... button next to the Maven Runtime field on the Main tab. On the Installations dialog, you edit the Global settings for <selected_runtime> installation field.

Changing the version of Maven
Copy link

By default, Red Hat JBoss Fuse Tooling for Eclipse uses m2e, which is embedded in Eclipse. If you want to use a different version of Maven or have a newer version installed on your development machine, you can select it from the Maven Runtime drop-down menu on the Main tab.

Changing where the output is sent
Copy link

By default, the output from the route execution is sent to the Console view. But you can redirect it to a file instead.

To redirect output to a file:

Select the Common tab.
Click the checkbox next to the File: field, and then enter the path to the file where you want to send the output.
The Workspace..., File System..., and Variables... buttons facilitate building the path to the output file.

Chapter 11. Using the JBoss Fuse SAP Tool Suite
Copy link

Abstract

The JBoss Fuse SAP Tool Suite makes it possible to integrate your Camel routes with a remote SAP Application Server. A variety of SAP components are provided to support Remote Function Calls (RFC) and the sending and receiving of Intermediate Documents (IDocs). Note that the SAP Tool Suite depends on the JCo and IDoc client libraries from SAP. You must have an SAP Service Marketplace Account, in order to install and use these libraries.

11.1. Installing the JBoss Fuse SAP Tool Suite
Copy link

Overview
Copy link

The JBoss Fuse SAP Tool Suite provides a SAP Connections view for configuring SAP connections and a collection of SAP components for integrating your Camel routes with an SAP server. The suite is not installed by default, because it requires third-party Jco and IDoc client libraries, which are licensed separately by SAP.

Platform restrictions for SAP tooling
Copy link

Because the SAP tool suite depends on the third-party JCo 3.0 and IDoc 3.0 libraries, it can only be installed on the platforms that these libraries support. For more details about the platform restrictions for SAP tooling, see Red Hat JBoss Fuse Supported Configurations.

Prerequisites
Copy link

Before you can install the JBoss Fuse SAP Tool Suite, you must download the requisites JCo and IDoc libraries from the following location:

http://service.sap.com/connectors

Please note the following points:

You will require an SAP Service Marketplace Account to download the JCo and IDoc client archives.
Choose the appropriate JCo and IDoc libraries for your operating system.
Only version 3.0.11 or greater of the JCo library is supported.
Only version 3.0.10 or greater of the IDoc library is supported.
For this installation procedure, you can leave the downloaded files in archive format. There is no need to extract the contents.

Procedure
Copy link

To install the JBoss Fuse SAP Tool Suite into JBoss Developer Studio, perform the following steps:

In JBoss Developer Studio, select File → Import to open the Import wizard.
In the Select screen of the Import wizard, select JBoss Fuse → Install JBoss Fuse SAP Tool Suite, and click Next.
The Install the JBoss Fuse SAP Tool Suite screen opens, which displays the instructions for downloading the JCo and IDoc libraries from the SAP Service Marketplace. Click Next.
The Select JCo3 and IDoc3 Archive to Import screen opens. Next to the JCo Archive File field, use the Browse button to select the JCo archive that you downloaded from the SAP Service Marketplace. After selecting the JCo archive, the Archive Version and Archive OS Platform fields are automatically filled in, so that you can check whether the library you are installing has the correct version and OS platform.
Next to the IDoc3 Archive File field, use the Browse button to select the IDoc archive that you downloaded from the SAP Service Marketplace.
After selecting both archive files, click Finish.
A new Install wizard (for installing Eclipse plug-ins) opens automatically. This wizard displays the following to plug-ins to be installed:
- JBoss Fuse SAP Tool Suite
- SAP JCo3 and IDoc3 Libraries
Make sure that both of these plug-ins are selected. Click Next.
Note
The SAP JCo3 and IDoc3 Libraries plug-in is dynamically constructed from the selected JCo and IDoc libraries.
The Install Details screen allows you to review the plug-ins to be installed. Click Next.
The Review Licenses dialog opens. Select the I accept radiobutton option, and then click Finish.
If you encounter a Security Warning dialog (warning of unsigned content), click OK to ignore the warning and continue installing.
The Restart Eclipse dialog opens. Click OK to restart Eclipse.

11.2. Create and Test an SAP Destination Connection
Copy link

Overview
Copy link

The JBoss Fuse SAP Tools Suite provides an SAP Connections view, which enables you to create and manage SAP destination connections and SAP server connections. This section describes how to create and test an SAP destination connection in the SAP Connections view.

Procedure
Copy link

To create and test an SAP destination connection, perform the following steps:

If you have not already added the SAP Connections view to your perspective, select Window → Show View → Other to open the Show View dialog. Select SAP Connections and click OK. The SAP Connections view opens on the left of your perspective (under Project Explorer).
In the SAP Connections view, right-click on Destination Data Store and select New Destination, to open the Create Destination dialog.
Enter a name for the destination in the New Destination Name field and click OK.
Select the newly created destination in the Destination Data Store tree, so that its properties show up in the Properties view.
In the Properties view, click on the Basic tab to configure the basic properties required to connect to an SAP destination. In this tab, fill in the following property fields to configure the connection:
- SAP Application Server
- SAP System Number
- SAP Client
- Logon User
- Logon Password
- Logon Language
These are standard SAP client connection properties. If you need more information about these settings, please consult the SAP documentation.
You are now ready to test the destination connection. In the SAP Connection view, right-click on the destination name and select Test.
The Test Destination Connection dialog opens. Click Test.
The dialog uses the current destination configuration settings to connect to the SAP server. If the test is successful, you will see the following message in the status area:
```
Connection test for destination 'YourDestination' succeeded.
```
```
Connection test for destination 'YourDestination' succeeded.
```
Copy to Clipboard Toggle word wrap
Otherwise, an error report appears in the status area.
Click Close, to close the Test Destination Connection dialog.

11.3. Create and Test an SAP Server Connection
Copy link

Overview
Copy link

Procedure
Copy link

To create and test an SAP server connection, perform the following steps:

If you have not already added the SAP Connections view to your perspective, select Window → Show View → Other to open the Show View dialog. Select SAP Connections and click OK. The SAP Connections view opens on the left of your perspective (under Project Explorer).
In the SAP Connections view, right-click on Server Data Store and select New Server, to open the Create Server dialog.
Enter a name for the server connection in the New Server Name field and click OK.
Select the newly created server connection in the Server Data Store tree, so that its properties show up in the Properties view.
In the Properties view, click on the Mandatory tab to configure the basic properties required for an SAP server connection. In this tab, fill in the following property fields to configure the connection:
- Gateway Host
- Gateway Port
- Program ID
- Repository Destination
- Connection Count
In the Repository Destination field, you can fill in one of the destination names from the Destination Data Store tree (see Section 11.2, “Create and Test an SAP Destination Connection”). An SAP server endpoint uses this destination to retrieve meta-data from a remotely hosted meta-data repository.
The other properties are standard SAP server connection properties. Please consult the SAP documentation for more information.
You are now ready to test the server connection. In the SAP Connection view, right-click on the server connection name and select Test.
The Test Server Connection dialog opens. Click Server.
The dialog uses the current server configuration settings to start up a server endpoint and connect to the gateway host. If the test is successful, you will see the following messages in the status area:
```
Server state: STARTED
Server state: ALIVE
```
```
Server state: STARTED
Server state: ALIVE
```
Copy to Clipboard Toggle word wrap
If the test fails, the server status is reported as DEAD.
Click Stop, to shut down the test server.
Click Close, to close the Test Server Connection dialog.

11.4. Export SAP Connection Configuration to a File
Copy link

Overview
Copy link

After creating some SAP destination connections (see Section 11.2, “Create and Test an SAP Destination Connection”) and SAP server connections (see Section 11.3, “Create and Test an SAP Server Connection”), you can export the SAP connection configuration to a file (either in Blueprint XML or Spring XML format). You will need this exported configuration data when you come to creating an SAP endpoint (the connection configuration is required in order to configure an SAP endpoint).

Procedure
Copy link

To export SAP connection configurations to a file, perform the following steps:

In the SAP Connections view, right-click on Sap Connection Configuration and select Export to open the Export SAP Connection Configuration dialog.
Enter the location of the export file in the Export Location field, either directly or using the Browse button.
Select the Export File Type using the drop-down menu. The supported file types are: Blueprint XML or Spring XML. Select the file type that matches the file type you will use to create your Camel routes.
Click Finish.

11.5. Create a New SAP Endpoint
Copy link

Overview
Copy link

You can use the Components palette in the Camel editor to add SAP components to a route. But you must also remember to paste the requisite SAP connection configuration data into your Blueprint XML or Spring XML code.

Prerequisites
Copy link

You must already have created some SAP destination connections and/or server connections, and have exported this configuration to a file of the appropriate type (Blueprint XML or Spring XML). See Section 11.4, “Export SAP Connection Configuration to a File”.

Procedure
Copy link

To create a new SAP endpoint, perform the following steps:

It is assumed that you already have a Fuse project and a Camel XML file to work with (which could either be in Blueprint XML or Spring XML format).
Open your Camel XML file in the Camel editor. If you have already installed the JBoss Fuse SAP Tool Suite, you should be able to see the SAP components under the Components palette in the Camel editor. The following SAP components are provided by the tool suite:
- SAP IDoc Destination
- SAP IDoc List Destination
- SAP IDoc List Server
- SAP qRFC Destination
- SAP Queued IDoc Destination
- SAP Queued IDoc List Destination
- SAP sRFC Destination
- SAP sRFC Server
- SAP tRFC Destination
- SAP tRFC Server
In the Design view of the Camel editor, drag one of these components onto the canvas to create a new SAP endpoint in the current camelContext.
Note
The SAP Netweaver component does not belong to the JBoss Fuse SAP Tool Suite. It is hosted in the Apache Camel project.
Switch to the Source view of the Camel editor, by clicking on the Source tab at the bottom of the canvas. In this view, you can see the XML source of the routes.
Open an exported SAP connection configuration file that you exported earlier (see Section 11.4, “Export SAP Connection Configuration to a File”), making sure that the type of the exported SAP connection configuration file matches the type of your Camel XML file (Blueprint XML or Spring XML).
The SAP connection configuration data is encoded as a bean element, with the id value, sap-configuration. Copy this bean element.
Return to the Source view of the Camel editor. Paste the bean element as a child of the root beans element in the Camel XML file.
You might not need all of the entries in the SAP connection configuration. Delete any unneeded destination connection and server connection entries (entry elements).
Note
Remember that server connections usually also depend on a destination connection (for retrieving meta-data from a remote repository). So, even if you only need a server connection, do not delete all of the destination connection entries.
When specifying an SAP endpoint URI, you must embed either a destination name or a server connection name in the URI format. For example, the sap-srfc-destination component has the following URI format:
```
sap-srfc-destination:destinationName:rfcName
```
```
sap-srfc-destination:destinationName:rfcName
```
Copy to Clipboard Toggle word wrap
To reference a particular destination, use the value of the relevant entry element's key attribute as the destinationName in this URI.

Chapter 12. Getting Started with Data Transformation
Copy link

12.1. Fuse Transformation Tooling
Copy link

One of the challenges that comes with system and data integration is that the component systems often work with different data formats. You cannot simply send messages from one system to another without translating it into a format (or language) recognized by the receiving system. Data transformation is the term given to this translation.

The Fuse Transformation tooling provided with JBoss Fuse is a GUI to assist developers in implementing data translations as part of Camel routes.

12.2. Data Transformation Tutorial
Copy link

In this tutorial you will learn how to use the data transformation tooling to include data transformation in a predefined Camel route. The Camel route directs messages from a source endpoint that produces XML data to a target endpoint that consumes JSON data. You will add and define a data transformation component that maps the source's XML data format to the target's JSON data format.

Prerequisites
Copy link

JBoss Fuse tooling installed on JBoss Developer Studio. See Install Red Hat JBoss Developer Studio Integration Stack
Maven installed and configured correctly. See Red Hat JBoss Fuse Maven Repositories
the transformation quickstart applications downloaded and installed

Importing the starter quickstart application
Copy link

Right-click in Project Explorer to open the context menu.
Select Import → Import....
Expand the Maven folder, and select Existing Maven Projects.
Click Next to open the Maven Projects wizard.

View larger image
Click Browse to find and select the root directory of the starter quickstart application.
If the browse operation finds multiple projects, make sure you select the starter quickstart application. The full path to the starter quickstart application appears in the Projects pane.
Click Finish.
After the import operation finishes, the starter project appears in Project Explorer.
In Project Explorer, expand the starter project.
Double-click starter/src/main/resources/META-INF/spring/camel-context.xml to open it in the route editor.

View larger image
Click the Source tab to view the underlying XML.
You can see that an XML file is produced from a source endpoint and a JSON file is consumed by a target endpoint.
Click the Design tab to return to Design view.
Remove the arrow connecting the source and target endpoints.
Note
Do not save your project now. If you do, the endpoints will disappear because they are not connected, which makes the route invalid.
If Console view is not already open, open it now by clicking Window → Show View → Console.

Note

Although the following mini tutorials are written to be run in consecutive order, you can run through them in any order, but the Console output per tutorial will differ from that shown.

Adding a data transformation node to the Camel route
Copy link

In the Palette, expand the Transformation drawer.

View larger image
Drag a Data Transformation component onto the canvas.
The New Transformation wizard opens with the Project, Dozer File Path, and Camel File Path fields auto filled.

View larger image
Fill in the remaining fields:
- In Transformation ID, enter xml2json.
- For Source Type, select XML from the drop-down menu.
- For Target Type, select JSON from the drop-down menu.
Click Next.
The Source Type (XML) definition page opens, where you specify either an XML Schema (default) or an example XML Instance Document to provide the type definition of the source data:

View larger image
Leave XML Schema enabled.
For Source file, browse to the location of the XML schema file or the XML instance file to use for the type definition of the source data, and select it (in this case, abc-order.xsd).
The XML Structure Preview pane displays a preview of the XML structure.
In Element root, enter ABCOrder.
The tooling uses this text to label the pane that displays the Source data items to map.
The Source Type (XML) definition page should now look like this:

View larger image
Click Next.
The Target Type (JSON) definition page opens, where you specify the type definition for the target data.

View larger image
Click JSON Instance Document.
In the Target File field, enter the path to the xyz-order.json instance document, or browse to it. The JSON Structure Preview pane displays a preview of the JSON data structure:

View larger image
Click Finish.

The Transformation editor opens, so you can map data items in your XML source to data items in your JSON target.

The Transformation editor is composed of three panels:

Source—lists the available data items of the source
Transformations—displays the mappings between the source and target data items
Target—lists the available data items of the target

In addition, the editor's Details view, located just below the editor's three panels (once the first mapping has been made), graphically displays the hierarchical ancestors for both the mapped source and target data items currently selected. For example:

custId" id="uid--l3zwzz4h9" onclick="event.preventDefault()"> Details view with source property customerNum mapped to target property role=

custId" class="doc-image" loading="lazy">

Using Details view, you can customize the mapping for the selected source and target data items:

Set property—Modify an existing mapping or map a simple data item to one in a collection (see the section called “Mapping a simple data item to a data item in a collection”)
Set variable—Specify a constant value for a data item (see the section called “Mapping a constant variable to a data item”)
Set expression—Map a data item to the dynamic evaluation of a specified expression (see the section called “Mapping an expression to a data item”)
Add function—Modify the value of a mapped data item using a built-in function (see the section called “Adding a built-in function to a mapped data item”)
Add custom function—Modify the value of a mapped data item using Java method you create or one you previously created (see the section called “Adding a custom function to a mapped data item”)

Mapping source data items to target data items
Copy link

Expand all items in the Source and Target panels located on left and right sides of the Transformations panel.

View larger image
Drag a data item from the Source panel and drop it on its corresponding data item in the Target panel.
For example, drag the customerNum data item from the Source panel and drop it on the custId data item in the Target panel.

View larger image

The mapping appears in the Transformations panel, and the details of both the Source and Target data items appear below in Details view.
Continue dragging and dropping source data items onto their corresponding target data items until you have completed all basic mappings.
In the starter example, the remaining data items to map are:
Expand
Source Target
orderNum orderId
status priority
id itemId
price cost
quantity amount
Note
You can map collections (data items containing lists or sets) to noncollection data items and vice versa, but you cannot map collections to other collections.
Note
To easily discover which data items are collections, click in both the Source and Target panels. (Brackets appear before the name of any data item that is part of a collection.) For an example, see Step 1 in the section called “Adding a custom function to a mapped data item”.
Click on both the Source and Target panels to quickly determine whether all data items have been mapped.

View larger image

Only data items that have not been mapped are listed in the Source and Target panels.
In the starter example, the remaining unmapped Target attributes are approvalCode and origin.
Click the camel-context.xml tab to return to the route editor in Design view.
Hover your cursor over each endpoint to reveal its connecter arrow.

View larger image
Selecting the file:src/data?fil... node, drag and drop its connector arrow onto the ref:xml2json node. Likewise drag and drop the connector arrow from the ref:xml2json node onto the file:target/messa... node.

View larger image

Connecting the nodes on the canvas creates a valid Camel route, which you can now save.
Click File → Save.

Source	Target
`orderNum`	`orderId`
`status`	`priority`
`id`	`itemId`
`price`	`cost`
`quantity`	`amount`

You can run a JUnit test on your transformation file after you create the transformation test. For details, see the section called “Creating the transformation test file and running the JUnit test”. If you do so at this point, you will see this output in Console view:

<?xml version="1.0" encoding="UTF-8"?>
<ABCOrder xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:java="http://java.sun.com">
    <header>
        <status>GOLD</status>
        <customer-num>ACME-123</customer-num>
        <order-num>ORDER1</order-num>
    </header>
    <order-items>
        <item id="PICKLE">
            <price>2.25</price>
            <quantity>1000</quantity>
        </item>
        <item id="BANANA">
            <price>1.25</price>
            <quantity>400</quantity>
        </item>
    </order-items>
</ABCOrder>

<?xml version="1.0" encoding="UTF-8"?>
<ABCOrder xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:java="http://java.sun.com">
    <header>
        <status>GOLD</status>
        <customer-num>ACME-123</customer-num>
        <order-num>ORDER1</order-num>
    </header>
    <order-items>
        <item id="PICKLE">
            <price>2.25</price>
            <quantity>1000</quantity>
        </item>
        <item id="BANANA">
            <price>1.25</price>
            <quantity>400</quantity>
        </item>
    </order-items>
</ABCOrder>

Copy to Clipboard

Toggle word wrap

for the source XML data, and

{"custId":"ACME-123","priority":"GOLD","orderId":"ORDER1","lineItems":[{"itemId":"PICKLE",
"amount":1000,"cost":2.25},{"itemId":"BANANA","amount":400,"cost":1.25

{"custId":"ACME-123","priority":"GOLD","orderId":"ORDER1","lineItems":[{"itemId":"PICKLE",
"amount":1000,"cost":2.25},{"itemId":"BANANA","amount":400,"cost":1.25

Copy to Clipboard

Toggle word wrap

for the target JSON data.

Creating the transformation test file and running the JUnit test
Copy link

Right-click the starter project in Project Explorer, and select New → Other → Fuse Tooling → Fuse Transformation Test.
Select Next to open the New Transformation Test wizard.
In the New Transformation Test wizard, set the following values:
Expand
Field Value
Package example
Transformation ID xml2json
Click Finish.
In Project Explorer, navigate to starter/src/test/java/example, and open the TransformationTest.java file.

Field	Value
Package	`example`
Transformation ID	`xml2json`

Add the following code to the transform method:

startEndpoint.sendBodyAndHeader(readFile("src/data/abc-order.xml"), "approvalID", "AUTO_OK");

startEndpoint.sendBodyAndHeader(readFile("src/data/abc-order.xml"), "approvalID", "AUTO_OK");

Copy to Clipboard

Toggle word wrap

Click File → Save.
You can now run a JUnit test on your transformation file at any point in these tutorials.
In Project Explorer, expand the starter project to expose the /src/test/java/example/TransformationTest.java file.
Right click it to open the context menu, and select Run as JUnit Test.
The JUnit Test pane opens to display the status of the test. To avoid cluttering your workspace, drag and drop the pane in the bottom panel near Console view.

View larger image
Open Console view to see the log output.

Mapping a constant variable to a data item
Copy link

When a source/target data item has no corresponding target/source data item, you can map a constant variable to the existing data item.

In the starter example, the target data item origin does not have a corresponding source data item. To map the origin attribute to a constant variable:

In the Source panel, click the Variables tab to open Variables view.

View larger image
In Variables view, click to open the Enter a new variable name dialog.

View larger image
Enter a name for the variable you want to create.
For the starter example, enter ORIGIN.
Click OK.
The newly created variable ORIGIN appears in Variables view in the Name column and the default value "ORIGIN" in the Value column.
Click the default value to edit it, and change the value to Web.
Press Enter.
Drag and drop the new variable ORIGIN onto the origin data item in the Target panel.

View larger image

The new mapping of the variable $(ORIGIN) appears in the Transformations panel and in Details view.

Run a JUnit test on your TransformationTest.java file. For details, see the section called “Creating the transformation test file and running the JUnit test”.

Console view displays the json-formatted output data:

{"custId":"ACME-123","priority":"GOLD","orderId":"ORDER1","origin":"Web",
"approvalCode":"AUTO_OK","lineItems":[{"itemId":"PICKLE","amount":1000,"cost":2.25},
{"itemId":"BANANA","amount":400,"cost":1.25}]}

{"custId":"ACME-123","priority":"GOLD","orderId":"ORDER1","origin":"Web",
"approvalCode":"AUTO_OK","lineItems":[{"itemId":"PICKLE","amount":1000,"cost":2.25},
{"itemId":"BANANA","amount":400,"cost":1.25}]}

Copy to Clipboard

Toggle word wrap

Mapping an expression to a data item
Copy link

This feature enables you, for example, to map a target data item to the dynamic evaluation of a Camel language expression.

Use the target approvalCode data item, which lacks a corresponding source data item:

Click to add an empty transformation map to the Transformations panel.

View larger image
From the Target panel, drag and drop the approvalCode data item to the target field of the newly created mapping in the Transformations panel.

View larger image

The approvalCode data item also appears in Details view's target box.
In Details view, click on the ABCOrder source box to open the drop-down menu.

View larger image

Menu options depend on the selected data item's data type. The available options are bolded.
Select Set expression to open the Expression dialog.

View larger image
In Language, select the expression language to use from the list of those available. Available options depend on the data item's data type.
For the starter example, select Header.
In the Details pane, select the source of the expression to use.
The options are Value and Script.
For the starter example, click Value, and then enter ApprovalID.
Click OK.

View larger image

Both Transformations panel and Details view display the new mapping for the target data item approvalCode.

Run a JUnit test on your TransformationTest.java file. For details, see the section called “Creating the transformation test file and running the JUnit test”.

Console view displays the json-formatted output data:

{"custId":"ACME-123","priority":"GOLD","orderId":"ORDER1","origin":"Web",
"approvalCode":"AUTO_OK","lineItems":[{"itemId":"PICKLE","amount":1000,"cost":2.25},
{"itemId":"BANANA","amount":400,"cost":1.25}]}

{"custId":"ACME-123","priority":"GOLD","orderId":"ORDER1","origin":"Web",
"approvalCode":"AUTO_OK","lineItems":[{"itemId":"PICKLE","amount":1000,"cost":2.25},
{"itemId":"BANANA","amount":400,"cost":1.25}]}

Copy to Clipboard

Toggle word wrap

Adding a custom function to a mapped data item
Copy link

You may need to modify the formatting of source data items when they do not satisfy the requirements of the target system.

For example, to satisfy the target system's requirement that all customer ids be enclosed in brackets:

Transformations panel, select the customerNum mapping to populate Details view.

View larger image
In Details view, click on the ABCOrder source box to open the drop-down menu.

View larger image
Select Add custom function to open the Add Custom Function page.

View larger image
Click next to the Class field to open the Create New Java Class wizard.

View larger image
Modify the following fields:
- Package—Enter example.
- Name—Enter MyCustomMapper.
- Method Name—Change map to brackets.
Leave all other fields as is.
Click Finish.
The Add Custom Function page opens with the Class and Method fields auto filled:

View larger image
Click OK to open the MyCustomMapper.java file in the Java editor:

View larger image
Edit the brackets method to change the last line return null; to this:
```
return "[" + input + "]";
```
```
return "[" + input + "]";
```
Copy to Clipboard Toggle word wrap
Click the transformation.xml tab to switch back to the Transformation editor.

View larger image

Details view shows that the brackets method has been associated with the customerNum data item.
The brackets method is executed on the source input before it is sent to the target system.

Run a JUnit test on your TransformationTest.java file. For details, see the section called “Creating the transformation test file and running the JUnit test”.

Console view displays the json-formatted output data:

{"custId":"[ACME-123]","priority":"GOLD","orderId":"ORDER1","origin":"Web",
"approvalCode":"AUTO_OK","lineItems":[{"itemId":"PICKLE","amount":1000,"cost":2.25},
{"itemId":"BANANA","amount":400,"cost":1.25}]}

{"custId":"[ACME-123]","priority":"GOLD","orderId":"ORDER1","origin":"Web",
"approvalCode":"AUTO_OK","lineItems":[{"itemId":"PICKLE","amount":1000,"cost":2.25},
{"itemId":"BANANA","amount":400,"cost":1.25}]}

Copy to Clipboard

Toggle word wrap

Mapping a simple data item to a data item in a collection
Copy link

In this tutorial, you will modify an existing mapping that maps all ids in the Source to the itemIds in the Target. The new mapping will map the customerNum data item in the Source to the itemId of the second item in the lineItems collection in the Target.

With this change, no ids in the Source will be mapped to itemIds in the Target.

Note

To discover which data items are in collections, click Show data types icon

at the top of both the Source and Target panels. The data type of each item is displayed next to it.

In the Transformations panel, select the mapping id —> itemId to display the mapping in Details view.
On the Source box, click to open the drop-down menu, and select Set property.

View larger image
In the Select a property page, expand the header node and select customerNum.
Click OK to save the change and open the Collection Indexes page.

View larger image
In the Collection Indexes page, click the toggle button next to lineItems to increase its value to 1.
Indexes are zero-based, so a value of 1 selects the second instance of itemId in the collection.
Click OK to save the change and open the transformation.xml file.

View larger image

Notice that Details view shows customerNum mapped to the itemId of the second item in the lineItems collection.

View larger image

Run a JUnit test on your TransformationTest.java file. For details, see the section called “Creating the transformation test file and running the JUnit test”.

Console view displays the json-formatted output data:

{"custId":"[ACME-123]","priority":"GOLD","orderId":"ORDER1","origin":"Web",
"approvalCode":"AUTO_OK","lineItems":[{"amount":1000,"cost":2.25},
{"itemId":"ACME-123","amount":400,"cost":1.25}]}

{"custId":"[ACME-123]","priority":"GOLD","orderId":"ORDER1","origin":"Web",
"approvalCode":"AUTO_OK","lineItems":[{"amount":1000,"cost":2.25},
{"itemId":"ACME-123","amount":400,"cost":1.25}]}

Copy to Clipboard

Toggle word wrap

Adding a built-in function to a mapped data item
Copy link

You can use the built-in string-related functions to apply transformations to mapped data items.

In the Transformations panel, select the status to priority mapping to populate Details view.

View larger image
In the Source box, click to open the drop-down menu, and select Add function.

View larger image
In the Functions pane, select append, and in the Arguments pane, enter -level for the value of suffix.
This append function adds the specified suffix to the end of the status string before mapping it to the target priority data item.
Click OK.

View larger image

By default, Details view displays the results of adding the append function to the status data item in a user-friendly format. You can change this formatting by clicking the right-most on the Source box, and selecting Show standard formatting.

View larger image

Run a JUnit test on your TransformationTest.java file. For details, see the section called “Creating the transformation test file and running the JUnit test”.

Console view displays the json-formatted output data:

{"custId":"[ACME-123]","priority":"GOLD-level","orderId":"ORDER1","origin":"Web",
"approvalCode":"AUTO_OK","lineItems":[{"amount":1000,"cost":2.25},{"itemId":"ACME-123",
"amount":400,"cost":1.25}]}

{"custId":"[ACME-123]","priority":"GOLD-level","orderId":"ORDER1","origin":"Web",
"approvalCode":"AUTO_OK","lineItems":[{"amount":1000,"cost":2.25},{"itemId":"ACME-123",
"amount":400,"cost":1.25}]}

Copy to Clipboard

Toggle word wrap

Chapter 13. Using the Switchyard Tooling
Copy link

13.1. JBoss Integration and SOA Development
Copy link

JBoss Integration and SOA Development
Copy link

The JBoss SwitchYard Tooling for JBoss Developer Studio supports integration and SOA development by providing these features:

Creation of SwitchYard projects
Configuration of SwitchYard capabilities
Editing SwitchYard application configuration using a graphical editor
Java2WSDL transformation
XML catalog entries for SwitchYard configuration schema
Support for workspace deployment of SwitchYard projects

The JBoss SwitchYard Tooling plug-in is provided by the JBoss Development Studio Integration Stack.

Installing JBoss Developer Studio Integration Stack
Copy link

JBoss Developer Studio Integration Stack (JBDSIS) is packaged as a plug-in for JBoss Developer Studio installations. It contains numerous, individual plug-ins, including the Fuse and SwitchYard tooling. You can download JBDSIS through JBoss Central, and then install all of the plug-ins it contains or only a select few. For more details, see Product Documentation for Red Hat JBoss Developer Studio Integration Stack.

Once installed, you may need to complete additional configuration tasks before you can use the individual JBoss Developer Studio Integration Stack components.

Here are some general tips to follow:

Honor all XML schema locations
After installation, go to XML → XML Files → Validation → Preferences and disable Honor all XML schema locations. This prevents erroneous XML validation errors from appearing on switchyard.xml files.
DTD warning
Importing SwitchYard quickstarts into JBoss Developer Studio results in non-fatal warnings regarding log4j.dtd. You can safely ignore them. To stop receiving the warning, make sure that either the log4j.xml or log4j.properties file is present before starting a project.
JavaSE-1.6 error message
When commencing a project, the warning "Build path specifies execution environment JavaSE-1.6" may appear. To disable this warning, go to your Java preferences and ensure that JavaSE-1.7 or JavaSE-1.8 is checked to support JavaSE-1.6 environments.

13.2. Running a SwitchYard Project on a JBoss Fuse Server
Copy link

To publish and run Fuse SwitchYard projects on an installed Fuse server, you must first add the server and its runtime definition to the tooling's Servers list. Once added to the list, the server appears in the Servers view, where you can configure it, start and stop it, and publish projects to it.

You can publish SwitchYard projects to JBoss Fuse 6.2.0 and newer servers that you have defined and added to the Servers list.

Note

If you haven't already installed a server, you can do so when you define and add it to the Servers list.

Adding a JBoss Fuse server
Copy link

Follow the instructions in Section 28.1, “Adding a Server” to define and add an installed JBoss Fuse 6.2.1 server.

Installing the SwitchYard features on the server
Copy link

JBoss Fuse is SwitchYard-ready, but you have to install the switchyard features.

In the Servers view, select the JBoss Fuse server you just added, and click on the view's menu bar to start it up.
Console view opens and displays the server's startup progress:

View larger image

Wait until [PATCH] Storing user changes appears at the end of the output.

Switch to Shell view, and install the switchyard-* features, one after another, on the server:

JBossFuse:admin@root> features:install switchyard-bean
JBossFuse:admin@root> features:install switchyard-camel
JBossFuse:admin@root> features:install switchyard-soap

JBossFuse:admin@root> features:install switchyard-bean
JBossFuse:admin@root> features:install switchyard-camel
JBossFuse:admin@root> features:install switchyard-soap

Copy to Clipboard

Toggle word wrap

Note

To see a list of all available SwitchYard-related features, enter features:list | grep switchyard*.

Check that the switchyard-* features are installed and active:
```
JBossFuse:admin@root> osgi:list
```
```
JBossFuse:admin@root> osgi:list
```
Copy to Clipboard Toggle word wrap
The end of the output should show the switchyard components installed and active :

View larger image

Importing a SwitchYard quickstart project
Copy link

The SwitchYard quickstarts are installed in $FUSE_HOME/quickstarts/switchyard/.

Right-click in Project Explorer, and select Import → Import... to open the Choose Import source dialog.

View larger image
In the Maven folder, select Existing Maven Projects.
Click Next to open the Select Maven projects dialog.

View larger image
Click the Browse button next to the Root Directory field to locate and select the $FUSE_HOME/quickstarts/switchyard/bean-service.

View larger image
In the Projects pane, make sure the box next to the pom.xml file entry for the switchyard-bean-service is checked to select it.
Click Finish to start the import.
The switchyard-bean-service project appears in Project Explorer.
Wait a moment for the import process to finish.
Note
See the section called “Resolving Maven dependency errors” for details on what to do if you encounter Maven dependency errors, caused by failure to download all of the project's dependencies from the Maven repositories.
In Project Explorer, right-click the switchyard-bean-service project to open the context menu, and select Enable Fuse Camel Nature.
This option enables you to publish a switchyard project to the JBoss Fuse server, which you can do at any time now (for details, see the section called “Publishing a SwitchYard project to the server”).

Testing the SwitchYard quickstart project locally
Copy link

It's a good idea to run projects as a JUnit test to check that they successfully build and run locally. The provided test files included with each SwitchYard quickstart are complete and comprehensive and need no modification.

In Project Explorer, expand the switchyard-bean-service project to expose src/test/java/OrderServiceTest.java file.
If you want to take a look at the test code, double-click the file to open it in the Java editor.
In Project Explorer, right-click the OrderServiceTest.java file to open the context menu, and select Run As → JUnit Test.
Console view automatically opens and displays the log entries generated by the JUnit test.

View larger image

The last two log entries indicate that the test ran successfully against Apache Camel as expected.
Click the JUnit tab to open JUnit view.

View larger image

This test proves that the switchyard-bean-service successfully builds and runs locally.
Note
If you failed to set the Execution environment to JavaSE-1.7 or JavaSE-1.8 when you defined the JBoss Fuse server, this test will fail. You can easily reset it by right-clicking the JRE System Library node in Project Explorer, and selecting Build Path → Configure Build Path. In the Java Build Path dialog's Library tab, edit the current library to change the Execution environment setting to JavaSE-1.7 or JavaSE-1.8. (The library you select must be installed on your machine.) Then rerun the test.

Publishing a SwitchYard project to the server
Copy link

You can publish a project to a supported server, defined and listed in the Servers view, whether it's running or not. A published project will run as scheduled according to the server's settings (for details, see Chapter 29, Publishing Fuse Projects to a Server).

In the Servers view, right-click the target server to open the context menu, and then select Add and Remove.
When a project is ready for publishing, it appears in the Available column. For example:

View larger image

Note
The option If server is started, publish changes immediately is enable by default. See the section called “Publishing Fuse projects automatically when resources change” for information on how this option works and on using other publishing options.
Double-click the project in the Available column to move it to the Configured column.

View larger image
Click Finish.
Once publishing has finished, the project appears as a node under the server runtime node in the Servers view.

View larger image

Servers view shows that both the server runtime and the project are started and synchronized.
Note
For a server runtime, Synchronized means that all published resources on the server are identical to their local counterparts. For a published resource, Synchronized means that it is identical to its local counterpart.
In Shell view, enter the command osgi:list to confirm that the switchyard-bean-service project is installed and active.

View larger image

Testing the published SwitchYard project
Copy link

You can use the JBoss Web Service Tester tool to test your published web service.

Open a web browser, and go to http://localhost:8181/cxf/ to see the available SOAP services with OrderService in the list.

View larger image

This site provides a link to the OrderService's WSDL.
Click the link to the OrderService's WSDL to open it in the browser.

View larger image
Copy the URL displayed in the browser's address field.
In JBoss Developer Studio, click Window → Show View → Other, then scroll down to the JBoss Tools Web Services folder, and select Web Service Tester.

View larger image
Click the drop-down menu labeled GET, and select JAX-WS.

View larger image

The Request Body pane displays an example SOAP request message.
Click next to to open the Specify the Source WSDL for the Web Service dialog, and then paste the URI you copied in Step 3 into the WSDL URI field.

View larger image

The Web Service Tester auto fills the remaining fields with the data retrieved from the WSDL.
Click OK.

View larger image

The Web Service Tester displays the XML request message retrieved from the WSDL in the Request Body pane.
You can enter values for the <order> items <orderId>, <itemId>, and <quantity> to test the project's request and response services.
Note
You can discover what the data types are for each order item. In Project Explorer, double-click src/test/java/OrderServiceTest.java file to open it in the Java editor:

View larger image
In the Request Body pane, click the value field of each order item and enter an appropriate value for it. For example:
- For <orderID> replace ? with ORDER10
- For <itemId> replace ? with BUTTER
- For <quantity> replace 0 with 1000
Click to the right of to invoke the submitOrder operation. and populate the Response Body pane with an example response message.
Console view automatically opens to show the status of the submitOrder operation:

View larger image
Switch to the Web Service Tester tool and check the response message in the Response Body pane.

View larger image

13.3. Running a SwitchYard Project on a JBoss Enterprise Application Server
Copy link

To publish and run Fuse SwitchYard projects on an installed EAP server, you must first:

Install JBoss Fuse on the JBoss EAP server
For details, see Installation of JBoss Fuse on JBoss EAP
Add the server and its runtime definition to the tooling's Servers list
Once added to the list, the server appears in the Servers view, where you can configure it, start and stop it, and publish projects to it.

You can publish SwitchYard projects to Red Hat JBoss Enterprise Platform 6.4 and newer servers that you have defined and added to the Servers list.

Note

If you haven't already installed a server, you can do so when you define and add it to the Servers list.

Adding a JBoss EAP server
Copy link

You can add a new server to the Servers view in three ways:

In Servers view, click the link No servers are available. Click this link to create a new server....
Note
This link appears in Servers view only when no server has been defined.
Right-click in Servers view to open the context menu, then select New → Server.
On the menu bar, select File → New → Other → Server → Server.

In the Define a New Server dialog, select Red Hat JBoss Enterprise Application Platform 6.1+.

View larger image

Server's host name and Server name are auto filled by default. In Server name, you can enter a different name to use to identify the server in the Servers view.
Click Next to open the Create a New Server Adapter page.

View larger image

To specify that the server life-cycle is managed from outside the tooling, check Server is externally managed. Assume server is started..
If you have not configured a runtime before, Create new runtime (next page) appears on the drop-down menu bar under The selected profile requires a runtime (as shown in the figure above). Otherwise, a previously configured runtime appears on the drop-down menu bar.
Note
You can assign the same runtime to multiple server instances, which enables you to quickly launch a server in debug mode or to configure other runtime settings.
To use a previously created runtime with this server, click the drop-down menu and select it from the list (skip to Step 6).
To create a new runtime, select Create new runtime (next page) from the list.
Click Next to open the JBoss Runtime page.

View larger image

Note
If the server is not already installed on your machine, you can install it now by clicking the link Download and install runtime... and following the site's download instructions. Depending on the site, you may be required to provide valid credentials before you can continue the download process.
Configure the JBoss runtime:
- Accept the default for Name, or enter a different name.
- In Home Directory, enter the path where the server runtime is installed, or click Browse to find and select it.
- Select the runtime JRE from the drop-down menu next to Execution Environment.
  If the version you want does not appear on the list, click Environments, and then select the version from the list. The JRE version you select must be installed on your machine.
- Accept the defaults for Configuration base directory and Configuration file, or browse to the directory where the .xml configuration file to use is located.
Click Finish.
The server appears in the Servers view.

View larger image

Importing a SwitchYard quickstart project
Copy link

The JBoss Fuse on JBoss EAP installer installs the SwitchYard quickstarts in $EAP_HOME/quickstarts/switchyard/.

Right-click in Project Explorer, and select Import → Import... to open the Choose Import source dialog.

View larger image
In the Maven folder, select Existing Maven Projects.

View larger image
Click Next to open the Select Maven projects dialog.

View larger image
Click the Browse button next to the Root Directory field to locate and select the $EAP_HOME/quickstarts/switchyard/bean-service.

View larger image
In the Projects pane, make sure the pom.xml file entry for the switchyard-bean-service is selected.
Click Finish to start the import.
The switchyard-bean-service project appears in Project Explorer.
Wait a moment for the import process to finish.

Testing a SwitchYard project locally
Copy link

Before you try to publish your project to a server, it's useful to confirm that it builds and runs locally. The provided test files included with each SwitchYard quickstart are complete and comprehensive and need no modification.

In Project Explorer, expand the switchyard-bean-service project to expose src/test/java/OrderServiceTest.java file.
If you want to take a look at the test code, double-click the file to open it in the Java editor.
In Project Explorer, right-click the OrderServiceTest.java file to open the context menu, and select Run As → JUnit Test.
Console view automatically opens and displays the log entries generated by the JUnit test.

View larger image

These log entries indicate that the test ran successfully against Apache Camel as expected.
Click the JUnit tab to open JUnit view.

View larger image

This test proves that the switchyard-bean-service successfully builds and runs locally.

Publishing a SwitchYard project to the server
Copy link

You can publish a project to a supported EAP server, defined and listed in the Servers view, whether it's running or not. A published project will run as scheduled according to the server's settings (for details, see (Chapter 29, Publishing Fuse Projects to a Server).

Important

The EAP server must have JBoss Fuse on JBoss EAP installed on it. For details, see Installation of JBoss Fuse on JBoss EAP

In the Servers view, select the EAP 6.4 server you just added, and click on the menu bar to start it.
In the Servers view, right-click the server to open the context menu, and select Add and Remove.
When a project is ready for publishing, it appears in the Available column.

View larger image

Note
The option If server is started, publish changes immediately is enable by default. See the section called “Publishing Fuse projects automatically when resources change” for information on how this option works and on using other publishing options.
Double-click the project in the Available column to move it to the Configured column.

View larger image
Click Finish.
Once publishing has finished, the project appears as a node under the server runtime node in the Servers view.

View larger image

Servers view shows that both the server runtime and the project are started and synchronized.
Note
For a server runtime, Synchronized means that all published resources on the server are identical to their local counterparts. For a published resource, Synchronized means that it is identical to its local counterpart.
Look at the log output in Console view to confirm that the switchyard-bean-service project is deployed and running:

View larger image

Testing the published SwitchYard project
Copy link

You can use the JBoss Web Service Tester tool to test your published web service.

From the log output in Console view, copy the address of the bean-service project's OrderService.
In the example we are using, the address is http://localhost:8080/quickstart-bean/OrderService.
Open a browser, and paste the address of the OrderService in the browser's address field.
Add ?wsdl to the end of the address, so it reads http://localhost:8080/quickstart-bean/OrderService?wsdl.
Press Enter.
The browser displays the WSDL for the OrderService:

View larger image
Copy the URL in the browser's address field.
In JBoss Developer Studio, click Window → Show View → Other, then scroll down to the JBoss Tools Web Services folder, and select Web Service Tester.

View larger image
Click the drop-down menu labeled GET, and select JAX-WS.

View larger image

The Request Body pane displays an example SOAP request message.
Click next to to open the Specify the Source WSDL for the Web Service dialog, then paste the URL you copied in Step 5 into the WSDL URI field.

View larger image

The Web Service Tester auto fills the remaining fields with the data retrieved from the WSDL.
Click OK.

View larger image

The Web Service Tester displays the XML request message retrieved from the WSDL in the Request Body pane.
You can enter values for the <order> items <orderId>, <itemId>, and <quantity> to test the project's request and response services.
Note
You can discover what the data types are for each order item. In Project Explorer, double-click src/test/java/OrderServiceTest.java file to open it in the Java editor:

View larger image
In the Request Body pane, click the value field of each order item and enter an appropriate value for it. For example:
- For <orderID>, replace ? with ORDER10
- For <itemId>, replace ? with BUTTER
- For <quantity>, replace 0 with 1000

Click

to the right of

to invoke the submitOrder operation. and populate the Response Body pane with an example response message.

Console view automatically opens to display the status of the submitOrder operation like this—

... INFO [stdout] (http-localhost/127.0.0.1:8080-2) |--- Validating Order object: [OrderID=ORDER10, 
       ItemID=BUTTER, quantity=1000] ---|

... INFO [stdout] (http-localhost/127.0.0.1:8080-2) |--- Validating OrderAck object: [OrderID=ORDER10,
       accepted=true, status=Order Accepted [intercepted]] ---|

... INFO [stdout] (http-localhost/127.0.0.1:8080-2) |--- Validating Order object: [OrderID=ORDER10, 
       ItemID=BUTTER, quantity=1000] ---|

... INFO [stdout] (http-localhost/127.0.0.1:8080-2) |--- Validating OrderAck object: [OrderID=ORDER10,
       accepted=true, status=Order Accepted [intercepted]] ---|

Copy to Clipboard

Toggle word wrap

—at the end of the Console output.

Switch to the Web Service Tester tool and check the response message in the Response Body pane.

View larger image

Part III. Debugging Routing Contexts
Copy link

The Camel debugger includes many features for debugging routing contexts:

Setting conditional and unconditional breakpoints on nodes in the route editor
Autolaunching the debugger and switching to Debug Perspective
Interacting with the running routing context:
- Switch between breakpoints to quickly compare variable values of message instances
- Examine and change the value of variables of interest
- Add variables of interest to the Watch list to track them throughout the debug session
- Disable and re-enable breakpoints on-the-fly
- Track message flow graphically in the routing context runtime
- Examine Console logs to track Camel and debugger actions

Note

Before you can run the Camel debugger, you must set breakpoints on the nodes of interest displayed on the route editor's canvas. Once that's done, you can run the Camel debugger on a project's routing context .xml file to find the logic errors in it and fix them. Invoking the Camel debugger runs the routing context in debug mode and opens the Debug perspective (Chapter 2, Debug Perspective).

Chapter 14. Setting Breakpoints
Copy link

Overview
Copy link

You can set breakpoints in either JBoss perspective or in Fuse Integration perspective, but JBoss perspective provides more room for expanding the route editor's canvas when building and modifying routes. To set breakpoints, your project's routing context .xml file must be open in the route editor's Design View.

The Camel debugger supports two types of breakpoints:

Unconditional breakpoints—triggered whenever one is encountered during a debugging session
Conditional breakpoints—triggered only when the breakpoint's specified condition is met during a debugging session

Note

You cannot set breakpoints on Consumer endpoints or on When or Otherwise nodes.

Note

The Camel debugger requires the camelContext element and each node for which a breakpoint is set to have a unique ID. You can set IDs manually in a node's Properties editor or directly in the CamelContext file in Source view, or you can let Fuse Tooling generate and apply them automatically. The Please confirm... dialog opens whenever you set a breakpoint on a node that does not already have a unique ID.

Important

Make sure you save any changes you make to your routing context file before you run the Camel debugger on it. Otherwise, your changes will not be included in the debugging session.

Setting unconditional breakpoints
Copy link

With your routing context displayed on the canvas in Design View:

Select a node whose state you want to examine during the debugging session.
Click its icon to set an unconditional breakpoint.
In the Please Confirm... dialog, click OK to have the Route Editor automatically generate and apply a unique ID to the <camelContext> element and to the node or nodes that need it, or click Cancel if you want to manually enter unique IDs in the <camelContext> element and to each node that needs one.
Repeat these steps for each node on which you want to set an unconditional breakpoint.

Setting conditional breakpoints
Copy link

With your routing context displayed on the canvas in Design View:

Select a node whose state you want to examine during the debugging session.
Click its icon to set a conditional breakpoint and open the Edit the condition and language of your breakpoint... dialog.

View larger image
Click the Language drop-down menu and select the expression langauge to use to create the condition that will trigger the breakpoint.
Fuse Tooling supports twenty expression languages from which to choose. Except for constant, method, property, and ref, each of these languages provides variables for creating conditional expressions.
Click the Variables drop-down menu and select in sequence one or more of the language's supported variables to create the condition for triggering the breakpoint. The variables you select appear in the Condition text box.
Alternatively, you can manually enter the expression directly into the Condition text box.
Repeat steps Step 1 through Step 4 for each node on which you want to set a conditioanl breakpoint.

Disabling breakpoints
Copy link

You can temporarily disable a breakpoint, leaving it in place, then enable it again later. The

button skips over disabled breakpoints during debugging sessions.

To disable a breakpoint, select the node on the canvas and click its

icon. The breakpoint turns gray, indicating it has been disabled.

To enable a disabled breakpoint, select the node on the canvas and click its

icon. Depending on whether the disabled breakpoint is conditional or unconditional, it turns yellow or red, respectively, to indicate it has been re-enabled.

Note

You can also disable and re-enable breakpoints during debugging sessions. For details, see Chapter 19, Disabling Breakpoints in a Running Context.

Deleting breakpoints
Copy link

You can delete individual breakpoints or all breakpoints.

Individual breakpoints—on the canvas, select the node whose breakpoint you want to delete, and click its icon.
All breakpoints—right-click the canvas, and select Delete all breakpoints.

Chapter 15. Starting the Camel Debugger
Copy link

Overview
Copy link

Note

You must set breakpoints in your routing context file before you can start the Camel debugger.

You run the Camel debugger on the routing context file, so be sure to save any changes you made to the file before you invoke the debugger. Otherwise your changes will not be included in the debugging session.

Procedure
Copy link

In Project Explorer, select the routing context file you want to debug.
Right-click it to open the context menu, and then select Debug As... → Local Camel Context.
Fuse Tooling builds the Camel route, starts up Apache Camel, starts the routing context, enables JMX, starts the route(s) in the routing context, adds the breakpoints to the nodes, and enables the Camel debugger.
The Camel debugger suspends execution of the routing context at the first breakpoint it encounters, and asks whether you want it to open the Debug perspective.

View larger image
Click Yes to open Debug perspective.
Debug perspective opens with the routing context suspended at the first breakpoint in the running routing context.
Important
Breakpoints are held for a maximum of five minutes, after which debugging automatically resumes, moving on to the next breakpoint or to the end of the routing context if there are no more breakpoints.

View larger image

Note
To see the console output, you'll need to open Console view if it was not open when you switched perspectives.
Note
By default, Debug perspective opens displaying Outline view, which provides the means to switch between separate routes in a routing context. If your routing context contains a single route, closing Outline view will provide more space to expand the other views, making it easier to access and examine debugger output.

Watching message exchanges progress through the routing context
Copy link

Click

(Step Over) to jump to the next node of execution in the routing context. Click

(Resume) to continue execution at the next active breakpoint in the routing context.

Chapter 16. Stopping the Camel Debugger
Copy link

Overview
Copy link

To stop the Camel debugger, click Terminate button

on the menu bar once if the debugging session has ended. Otherwise you need to click Terminate button

twice. Once to terminate the currently running node thread and once to terminate the Camel Context thread (both displayed in Debug view).

Note

Terminating the Camel debugger also terminates the Console but does not clear its output. To clear the output, click

(Clear Console) on Console view's menu bar.

Terminating the Camel Debugger before the session ends
Copy link

Terminating the debugger before the debugging session ends may add extraneous entries to some of the project's folders in Project Explorer. You may see message lock files or target/.CamelContextInDebug_xxxxxxxx_temp/camel-context.xml lines in the root project's src/main/resources/framework-INF/framework_name folder. InFuse Integration perspective, You may also see them in the project's Camel Contexts folder.

To clear them, right-click the root project, and then select Refresh.

Chapter 17. Changing Variable Values
Copy link

Overview
Copy link

When the Camel debugger hits a breakpoint, Variables view displays the values of all variables available at that point in the routing context. Some variables are editable, allowing you to change their value. This enables you to see how the application handles changes in program state.

Note

Not all variables are editable. The context menu of those that are displays the option, Change Value....

Procedure
Copy link

To change the value of a variable:

If necessary, start up the debugger. See Chapter 15, Starting the Camel Debugger.
In Variables view, select a variable whose value you want to change, and then click its Value field.

View larger image

The variable's value field turns a lighter shade of blue, indicating it is in edit mode.
Note
Alternatively, you can right-click the variable to open its context menu, and select Change Value... to edit its value.
Enter the new value and then click Enter.
Console view displays an INFO level log entry noting the change in the variable's value (for example, Breakpoint at node to1 is updating message header on exchangeId: ID-dhcp-97-16-bos-redhat-com-52574-1417298894070-0-2 with header: Destination and value: ChangedTarget).
Continue stepping through the breakpoints and check whether the message is processed as expected. At each step, check Debug view, Variables view, and the Console output.

Chapter 18. Adding Variables to the Watch List
Copy link

Overview
Copy link

By adding them to the watch list, you can easily zero in on particular variables to see whether their values change as expected over the course of the routing context.

Procedure
Copy link

To add a variable to the watch list:

If necessary, start up the debugger. See Chapter 15, Starting the Camel Debugger.
In Variables view, right-click a variable you want to track to open the context menu.

View larger image
Select Watch.
A new tab, Expressions, appears next to the Breakpoints tab.
Click the Expressions tab to open it.

View larger image

Expressions view displays the name of the added variable and its current value.
Repeat Step 2 through Step 4 to add additional variables to the Watch list.
Note
The variables you add will remain in the watch list until you remove them. To do so, right-click a variable in the list to open the context menu, and then click Remove.
With Expressions view open, step through the routing context to track how the value of each variable in the Watch list changes at each step in the routing context.

Chapter 19. Disabling Breakpoints in a Running Context
Copy link

Overview
Copy link

You can disable and re-enable breakpoints in a running routing context in either Breakpoints view or on the canvas of the running CamelContext: <xxxxxx>. You can delete and reset a deleted breakpoint only on the canvas of the running CamelContext: <xxxxxx>.

Note

The string <xxxxxx> represents the ID that you or the debugger assigned to the camelContext element in the project's routing context file.

When a breakpoint is disabled, the

button causes the debugger to skip over it during the debugging session.

Disabling and enabling breakpoints in Breakpoints view
Copy link

Breakpoints view opens with all set breakpoints enabled.

To disable a breakpoint, clear its check box.

For each breakpoint you disable, Console view displays an INFO level log entry noting that it has been disabled (for example, Removing breakpoint to3). Likewise, for each breakpoint you re-enable, Console view displays an INFO level log entry noting that it has been enabled (for example, Adding breakpoint to3).

Note

To re-enable a disabled breakpoint, click its check box. Console view displays an INFO level log entry noting that the breakpoint has been added to the selected node.

Disabling and enabling breakpoints on the running CamelContext: canvas
Copy link

Make sure the routing context running in memory, CamelContext: <xxxxxx>, is active on the canvas.

On the canvas, select the node with the breakpoint you want to disable; for example:

View larger image

Note
The icon denotes an unconditional breakpoint. A icon denotes a conditional breakpoint.
Click the icon in the node's side bar.
The icon replaces the icon in the node's upper left corner, indicating that the breakpoint is now disabled:

View larger image

The node's check box in Breakpoints view is clear, also indicating that the breakpoint is disabled:

View larger image

Console view contains a log of the event:

View larger image

Note
To re-enable the breakpoint, select the node, and then click the icon in its side bar.

Deleting and resetting breakpoints on the running CamelContext: canvas
Copy link

You can delete and reset deleted breakpoints only on the running CamelContext: <xxxxxx> canvas.

On the CamelContext: <xxxxxx> canvas, select the node whose breakpoint you want to delete; for example, setHead_usa:

View larger image

Note that the node's breakpoint is enabled in Breakpoints view.
Note
In the above graphic, the dotted red line surrounding the setHead_usa node identifies the breakpoint on which the debugger is currently suspended.
Click the icon in the node's side bar:

View larger image

The breakpoint is removed from the node on the canvas and also from the list of breakpoints in Breakpoints view:

View larger image

Note
To reset the breakpoint, select the node, and then click the or icon in its side bar, depending on whether you want to set an unconditional or conditional breakpoint.

Part IV. Monitoring and Testing Applications
Copy link

To open Fuse Integration perspective (Chapter 3, Fuse Integration Perspective), click

on the right side of the JBoss Developer Studio tool bar. If the

icon is not available on the tool bar, click

and then select Fuse Integration from the list of available perspectives.

Chapter 20. JMX Navigator
Copy link

JMX Navigator, shown in Figure 20.1, displays all of the processes running in your application and drives all interactions with the monitoring and testing features. Other areas of the Fuse Integration perspective adapt to display information related to the node selected in JMX Navigator. JMX Navigator's context menu also provides the commands needed to activate route tracing and to add JMS destinations.

Figure 20.1. JMX Navigator

By default, JMX Navigator discovers all of the JMX servers running on the local machine and lists them under the lists them following categories:

Local Processes
Server Connections
User-defined connections

You can add other JMX servers using a server's JMX URL.

20.1. Viewing Processes in JMX
Copy link

Overview
Copy link

JMX Navigator lists all known processes in a series of trees. The root for each tree is a JMX server.

The first tree in the list is a special Local Processes tree that contains all of the JMX servers running on the local machine. You must connect to one of the JMX servers to see the processes it contains.

Viewing processes in a local JMX server
Copy link

To view information about processes in a local JMX server:

Expand the Local Processes entry in JMX Navigator.
Double-click one of the top-level entries under Local Processes to connect to the JMX server.
Double-click it to open a connection.
Click the icon that appears next to the entry to display the list of all components running in the JVM.

Viewing processes in alternate JMX servers
Copy link

To view information about processes in an alternate JMX server:

Add the JMX server to JMX Navigator.
Expand the server's entry in JMX Navigator using the icon that appears next to the entry to display the list of all components running in the JVM.

20.2. Adding a JMX server
Copy link

Overview
Copy link

JMX Navigator lists all of the local JMX servers under the Local Processes branch of the tree. You may need to connect to specific JMX servers to see components deployed on other machines.

To add a JMX server you need to know the JMX URL of the server you want to add.

Procedure
Copy link

To add a JMX server to the JMX Navigator:

Click New Connection on the JMX Navigator tab .
In the Create a new JMX connection wizard, select Default JMX Connection.
Click Next>.
Select the Advanced tab.
In the Name field, enter a name for the JMX server.
The name can be any string. It is used to label the entry in the JMX Navigator tree.
In the JMX URL field, enter the JMX URL of the server.
If the JMX server requires authentication, enter your user name and password in the Username and Password fields.
Click Finish.
The new JMX server is displayed as a branch in the JMX Navigator tree.

Chapter 21. Viewing a component's properties
Copy link

Overview
Copy link

The tooling collects and displays all of the JMX properties reported by Fuse components. This information can provide significant insight into what is happening in your integration application.

Procedure
Copy link

To see a Fuse component's properties:

Locate the node for the component in the Fuse JMX Navigator.
You may have to expand nodes on the tree to locate low-level components.
Select the Fuse component's node from the tree.
Open the Properties view.
The selected component's properties will be displayed in table format.
You can use the Search box in Properties view to locate specific properties based on value.

Chapter 22. Browsing messages
Copy link

Overview
Copy link

A key tool in debugging applications in a distributed environment is seeing all of the messages stored in the JMS destinations and route endpoints in the application. The tooling can browse the following:

JMS destinations
JMS routing endpoints
Apache Camel routing endpoints
SEDA routing endpoints
Browse routing endpoints
Mock routing endpoints
VM routing endpoints
DataSet routing endpoints

Procedure
Copy link

To browse messages:

Select the JMS destination or endpoint from Fuse JMX Navigator.
The list of messages is displayed in the Messages View.
Select an individual message to inspect from the list of messages in the Messages View.
Message details and content are displayed in the Properties view.

Chapter 23. Tracing Routes
Copy link

Debugging a route usually involves solving one of two problems:

a message was improperly transformed
a message failed to reach its destination endpoint

Tracing one or more test messages through the route is the easiest way to discover the source of these problems.

The route tracing feature of the tooling enables you to monitor the path a message takes through a route and see how the message is transformed as it passes from processor to processor.

Diagram View displays a graphical representation of the route, which enables you to see the path a message takes through it. For each processor in a route, it also displays the average processing time, in milliseconds, for all messages processed since route start-up and the number of messages processed since route start-up.

Messages View displays the messages processed by a JMS destination or route endpoint selected in the JMX Navigator tree. Selecting an individual message in Messages View displays the full details and content of the message in Properties view.

Tracing messages through a route involves the following steps:

Creating test messages for route tracing
Activating route tracing
Tracing messages through a route
Deactivating route tracing

23.1. Creating test messages for route tracing
Copy link

Overview
Copy link

Route tracing works with any kind of message structure. The Fuse Message wizard creates an empty message, leaving the structuring of the message entirely up to you.

Procedure
Copy link

To create a test message:

In Project Explorer, right-click the project to open the context menu.
Select New → Fuse Message to open the New File wizard.
Enter or select the folder in which you want to store the message.
In the File name field, enter a name for the message.
Click Finish.
The new message opens in the XML editor.
Fill in the contents (body and header text) of the message.
On the menu bar, click File → Save to save the test message.

23.2. Activating route tracing
Copy link

Overview
Copy link

Before you can trace messages through a route, you must activate route tracing for the route's routing context.

Procedure
Copy link

To start tracing on a routing context:

In the Fuse JMX Navigator tree, select the routing context on which you want to start tracing.
You can select any route in the context to start tracing on the entire context.
Right-click it to open the context menu, and then select Start Tracing to start the trace.
If Stop Tracing Context is enabled on the context menu, then tracing is already active.

23.3. Tracing messages through a route
Copy link

Overview
Copy link

The best way to see what's happening in a route is to watch what happens to a message at each stop along the route. The tooling provides a mechanism for dropping messages into a route and tracing the message's path through it.

Procedure
Copy link

To trace messages through a route:

Create one or more test messages as described in Section 23.1, “Creating test messages for route tracing”.
Activate tracing for the route's routing context as described in Section 23.2, “Activating route tracing”.
Drag one of the test messages onto the route's starting point.
In the Fuse JMX Navigator tree, select the route being traced.
The Messages View is populated with a list of messages representing the message at each stage in the traced route.
Open Diagram View to see a graphical representation of the selected route.
In the Messages View, select one of the messages.
In Diagram View, the route step in which the selected message is sitting is highlighted. The Properties view displays the full details and content of the test message.

You can repeat this process as needed.

23.4. Deactivating route tracing
Copy link

Overview
Copy link

When you are finished debugging the routes in a routing context, you should deactivate tracing for the routing context.

Important

Deactivating tracing stops tracing and flushes the trace data for all of the routes in the routing context. This means that you cannot review any past tracing sessions.

Procedure
Copy link

To stop tracing for a routing context:

In the Fuse JMX Navigator tree, select the routing context for which you want to deactivate tracing.
You can select any route in the context to stop tracing for the context.
Right-click it to open the context menu, and then select Stop Tracing Context.
If Start Tracing appears on the context menu, tracing is not activated for the routing context.

Chapter 24. Managing JMS destinations
Copy link

The tooling's Fuse JMX Navigator allows you to easily add or delete JMS destinations from a running Red Hat JBoss Fuse A-MQ.

Important

These changes are not persistent across broker restarts.

24.1. Adding a JMS destination
Copy link

Overview
Copy link

When testing a new scenario, it is convenient to add a new JMS destination to one of your brokers. The tooling provides a menu choice for adding a destination with a single click.

Procedure
Copy link

To add a JMS destination to a broker:

In the Fuse JMX Navigator tree, select either the Queues child or the Topics child in the broker node where you want to add a destination.
Right-click it to open the context menu, and then select Create Queue/Topic.
In the naming dialog, enter a name for the destination.
Click OK.
The new destination appears in the tree.

24.2. Deleting a JMS destination
Copy link

Overview
Copy link

When testing fail over scenarios or other scenarios that involve failure handling, it's convenient to be able to easily remove a JMS destination. The tooling has a menu option that allows you to remove a destination with a single click.

Procedure
Copy link

To delete a JMS destination:

In the Fuse JMX Navigator tree, select the JMS destination you want to delete.
Right-click it to open the context menu, and then select Delete Queue/Topic.

Chapter 25. Managing routing endpoints
Copy link

JMX Navigator allows you to easily add or delete routing endpoints.

Important

These changes are not persistent across router restarts.

25.1. Adding a routing endpoint
Copy link

Overview
Copy link

When testing a new scenario, it is convenient to add a new endpoint to a routing context. The tooling provides a menu choice for adding a routing endpoint with a single click.

Procedure
Copy link

To add an endpoint to a routing context:

In the JMX Navigator tree, select the Endpoints child in the routing context node where you want to add an endpoint.
Right-click it to open the context menu, and then select Create Endpoint.
In the naming dialog, enter a URL defining the new endpoint.
Click OK.
The new destination appears in the tree.

25.2. Deleting a routing endpoint
Copy link

Overview
Copy link

When testing fail over scenarios or other scenarios that involve failure handling, it is convenient to be able to easily remove an endpoint from a routing context. The tooling has a menu option that allows you to remove an endpoint with a single click.

Procedure
Copy link

To delete a routing endpoint:

In the JMX Navigator tree, select the endpoint you want delete.
Right-click it to open the context menu, and then select Delete Endpoint.

Chapter 26. Editing running routes
Copy link

Overview
Copy link

If you want to experiment with changes to a running route, you can make the edits directly from the Fuse Integration perspective. The tooling opens the context file containing the route in the route editor. When your changes are saved, they take effect immediately.

The changes are made to the in-memory model of the running context, but are not persisted as part of their original project or any other project.

Note

If you want to save the changes permanently, you must use the Save As menu option.

Procedure
Copy link

To edit a running route:

In the JMX Navigator tree, select the context containing the route(s) you want to edit.
Right-click to open the context menu, and select Edit Routes.
Route editor displays the context and all of its routes.
Edit the route(s) as described in Part II, “Developing Applications”.
When done, save the edited route.
- Select File → Save to update the in-memory version of the routing context.
  Changes take effect immediately.
- >Select File → Save As to save the edited routing context in a new context file.

Chapter 27. Managing routing contexts
Copy link

JMX Navigator enables you to easily suspend and resume routing contexts.

27.1. Suspending a routing context
Copy link

Overview
Copy link

The tooling enables you to suspend the operation of a routing context from JMX Navigator. Suspending a context gracefully shuts down all of the routes in the context, but keeps them loaded in memory so that they can easily be resumed.

Procedure
Copy link

To suspend a routing context:

In the JMX Navigator tree, expand the project's Camel Contexts node, and select the routing context you want to suspend.
Right-click it to open the context menu, and then select Suspend Camel Context.
Note
If Resume Camel Context appears on the context menu, the context is already suspended.

27.2. Resuming a routing context
Copy link

Overview
Copy link

The tooling enables you to resume a suspended routing context from JMX Navigator. Resuming a context restarts all of the routes in it, so that they can process messages.

Procedure
Copy link

To resume a routing context:

In the JMX Navigator tree, expand the project's Camel Contexts node, and select the routing context you want to resume.
Right-click it to open the context menu, and then select Resume Camel Context.
Note
If Suspend Camel Context appears in the context menu, the context and its routes are running.

Part V. Publishing Applications to a Container
Copy link

To publish Fuse projects to a server container, you must first add the server and its runime definition to the tooling's Servers list. Then you can assign Fuse projects to the server runtime and set the publishing options for it.

You manage servers and publish Fuse projects to them in Fuse Integration perspective (for an overview, see Chapter 3, Fuse Integration Perspective). To open Fuse Integration perspective, click

on the right side of the JBoss Developer Studio tool bar. If the

icon does not appear on the tool bar, click

and then select Fuse Integration from the list of available perspectives.

Chapter 28. Managing servers
Copy link

The Servers panel enables you to run and manage servers in your Red Hat Developer Studio environment. The supported servers are:

Red Hat JBoss Fuse Server—versions 6.x
Apache Karaf Server—versions 2.x, 3.0
Apache ServiceMix Server—versions 4.5, 5.x

Note

For step by step instructions on how to publish a Camel project to Red Hat JBoss Fuse, see Red Hat JBoss Fuse Tooling Tutorials, To Publish a Fuse Project to Red Hat JBoss Fuse.

28.1. Adding a Server
Copy link

Overview
Copy link

For the tooling to manage a server, you need to add the server to the Servers list. Once added, the server appears in Servers panel, where you can connect to it and publish your Fuse projects.

Note

If adding a Red Hat JBoss Fuse 6.0 or 6.1 server, it's recommended that you edit its installDir/etc/users.properties file and add user information, in the form of user=password,role, to enable the tooling to establish an SSH connection to the server.

Procedure
Copy link

You can add a new server to the Servers panel in three ways:

In Servers panel, click the link No servers are available. Click this link to create a new server....
Note
This link appears in Servers panel only when no server has been defined.
Right-click in Servers panel to open the context menu, then select New → Server.
On the menu bar, select File → New → Other → Server → Server.

In the Define a New Server dialog, expand the JBoss Fuse node to expose the list of available server options:

View larger image
Click the server you want to add.
In Server's host name, accept the default (localhost).
Note
The address of localhost is 0.0.0.0.
In Server name, accept the default, or enter a different name for the runtime server.
Click Next > to open the server's Runtime definition page:

View larger image

Note
If the server is not already installed on your machine, you can install it now by clicking the link Download and install runtime... and following the site's download instructions. Depending on the site, you may be required to provide valid credentials before you can continue the download process.
Accept the default for Name.
In Home Directory, enter the path where the server runtime is installed, or click Browse to find and select it.
Select the runtime JRE from the drop-down menu next to Execution Environment.
If the version you want does not appear on the list, click the Environments button and select the version from that list. The JRE version you select must be installed on your machine.
Note
JBoss Fuse 6.2 requires either JRE versions 1.7 or 1.8.
Leave the Alternate JRE option as is.
Click Next > to save the server's runtime definition and open its Configuration details page:

View larger image
Accept the default for SSH Port (8101).
The runtime uses the SSH port to connect to the server's Karaf shell. If this default is incorrect for your setup, you can discover the correct port number by looking in the server's installDir/etc/org.apache.karaf.shell.cfg file.
In User Name, enter the name used to log into the server.
In the case of Red Hat JBoss Fuse, this is a user name stored in the Red Hat JBoss Fuse installDir/etc/users.properties file.
Note
If the default user has been activated (uncommented) in the /etc/users.properties file, the tooling autofills User Name and Password with the default user's name and password, as shown in Step 10. The default user is already activated in JBoss Fuse 6.2, but not in JBoss Fuse 6.0 or 6.1.
If one has not been set, you can either add one to that file using the format user=password,role (for example, joe=secret,Administrator), or you can set one using the karaf jaas command set:
- jaas:realms—to list the realms
- jaas:manage --index 1—to edit the first (server) realm
- jaas:useradd <username> <password>—to add a user and associated password
- jaas:roleadd <username> Administrator—to specify the new user's role
- jaas:update—to update the realm with the new user information
If a jaas realm has already been selected for the server, you can discover the user name by issuing the command JBossFuse:karaf@root>jaas:users.
In Password, enter the password required for User Name to log into the server.
Click Finish to save the server's configuration details.
The server runtime will appear in Servers panel. For example:

View larger image

Expanding the server node exposes the server's JMX node:

View larger image

28.2. Starting a Server
Copy link

Overview
Copy link

When you start a configured server, the tooling opens the server's remote management console in a Shell panel. This allows you to easily manage the container while testing your application.

Procedure
Copy link

To start a server:

In the Servers panel, select the server you want to start.
Click .
- Console view opens and displays a message asking you to wait while the container is starting; for example:
  
  View larger image
  
  Note
  If you did not properly configure the user name and password for opening the remote console, a dialog opens asking you to enter the proper credentials. See Section 28.1, “Adding a Server”.
- After the container has started up, Shell view opens to display the container's management console; for example:
  
  View larger image
- The running server appears in Servers panel:
  
  View larger image
- The running server also appears in JMX Navigator under Server Connections:
  
  View larger image

28.3. Connecting to a Running Server
Copy link

Overview
Copy link

After you start up a configured server, it appears in Servers panel and in JMX Navigator, under the ServerConnections node. You may need to expand the Server Connections node to see the server.

To publish and test your Fuse project application on the running server, you must first connect to it. You can connect to a running server either in Servers panel or in JMX Navigator.

Note

Servers panel and JMX Navigator are synchronized with regards to server connections, so connecting to a server in Servers panel also connects it in JMX Navigator, and vice versa.

Connecting to a running server in Servers panel
Copy link

In Servers panel, expand the server runtime to expose its JMX[Disconnected] node.
Double-click the JMX[Disconnected] node:

View larger image

Connecting to a running server in JMX Navigator
Copy link

In JMX Navigator, select the server to which you want to connect under the Server Connections node.
Double-click it:

View larger image

Viewing bundles installed on the connected server
Copy link

In either the Servers panel or JMX Navigator, expand the server runtime tree to expose the Bundles node, and select it.
The tooling populates Properties view with a list of bundles that are installed on the server:

View larger image

Using Properties view's Search tool, you can search for bundles by their Symbolic Name or by their Identifier, if you know it. As you type in the symbolic name or the identifier, the list updates, showing only the bundles that match the current search string.
Note
The Symbolic Name is the artifactId that you gave the project when you first created it. You can find the artifactId in the project's pom.xmlfile.

28.4. Disconnecting from a Server
Copy link

Overview
Copy link

When you are done testing your application, you can disconnect from the server without stopping it.

Note

Servers panel and JMX Navigator are synchronized with regards to server connections, so disconnecting from a server in Servers panel also disconnects it in JMX Navigator, and vice versa.

Disconnecting from a server in Servers panel
Copy link

In Servers panel, expand the server runtime to expose its JMX[Connected] node.
Right-click the JMX[Connected] node to open the context menu, and then select Disconnect.

View larger image

Disconnecting from a server in JMX Navigator
Copy link

In JMX Navigator, select the server from which you want to disconnect.
Right-click it to open the context menu, and then select Disconnect.

View larger image

28.5. Stopping a Server
Copy link

Overview
Copy link

You can shut down a server in one of two ways:

from Servers panel
from the server's remote console in Shell view

Using Servers panel
Copy link

To stop a server:

In Servers panel, select the server you want to stop.
Click .

Using the remote console
Copy link

To stop a server:

Open the Shell view hosting the server's remote console.
Type CTRL+D.

28.6. Deleting a Server
Copy link

Overview
Copy link

When you are finished with a configured server, or if you misconfigure a server, it is easy to delete it and it's configuration.

Deleting a server
Copy link

In Servers panel, right-click the server you want to delete to open the context menu.
Select Delete.
Click OK.

Deleting the server's configuration
Copy link

On the menu bar, click JBoss Developer Studio → Preferences → Server.
Note
On Linux and Windows machines, you access Preferences through the Window menu.
Expand the Server folder, and then select Runtime Environments to open the Server Runtime Environments page.
From the list, select the runtime environment of the server that you previously deleted from Servers panel, and then click Remove.
Click OK.

Chapter 29. Publishing Fuse Projects to a Server
Copy link

Abstract

You deploy Fuse projects into a server runtime using the Eclipse publishing mechanism. To do so, you must have defined and added the server to the Servers panel in Fuse Integration perspective (for details, see Chapter 28, Managing servers. For a step-by-step demonstration, see Red Hat JBoss Fuse Tooling Tutorials, To Publish a Fuse Project to Red Hat JBoss Fuse.

Overview
Copy link

You can set up supported servers to publish assigned Fuse projects automatically or to publish them only when you manually invoke the publish command.

Each server runtime added to the Servers panel has its own Overview page that contains its configuration, connection, and publishing details:

You may need to expand Publishing to expose the server runtime publishing options and default settings:

Never publish automatically—You must select this option to manually publish projects.
Important
You must also disable the If server started, publish changes immediately option on the server's Add and Remove page (for details see, the section called “Publishing Fuse projects manually”.
Automatically publish when resources change—[default] Enable this option to automatically publish or republish a Fuse project when you save changes made to it. How quickly projects are published depends on the Publishing interval (default is 15 seconds).
Automatically publish after a build event—For Fuse projects, works the same as Automatically publish when resources change.

Publishing Fuse projects automatically when resources change
Copy link

The default publishing option for server runtimes is Automatically publish when resources change.

If necessary, start up the server runtime to which you want to publish a Fuse project. For details, see Section 28.2, “Starting a Server”.
In the Servers panel, double-click the server runtime to open its Overview page.
Expand Publishing, and then select Automatically publish when resources change.
To increase or decrease the interval between publishing cycles, click the radio button next to Publishing interval (in seconds) up or down, as appropriate.
In the Servers panel, right-click the server runtime to open the context menu, and then select Add and Remove.

View larger image

All resources available for publishing appear in the Available column.
To assign a resource (in this case, the wildThing Fuse project) to the server runtime:
- double-click it, or
- select it, and click Add >.
The selected resource moves to the Configured column:

View larger image

At this stage, the time at which the assigned resource would actually be published would depend on whether the server runtime was running and on the Publishing interval setting. However, if the server was stopped, you would have to manually publish the project after you started the server (for details, see the section called “Publishing Fuse projects manually”).
Click the If server started, publish changes immediately option to enable it:

View larger image

This option ensures that the configured project is published immediately once you click Finish. The Automatically publish when resources change option on the server runtime Overview page ensures that the configured project is republished whenever changes made to the local project are saved.
Click Finish.
The project appears in the Servers panel under the server runtime node, and the server runtime status reports [Started,Publishing...]:

View larger image

When publishing is done, the status of both the server runtime and the project report [Started,Synchronized]:

View larger image

Note
For a server runtime, Synchronized means that all published resources on the server are identical to their local counterparts. For a published resource, Synchronized means that it is identical to its local counterpart.

Publishing Fuse projects manually
Copy link

If necessary, start up the server runtime to which you want to publish a Fuse project. For details, see Section 28.2, “Starting a Server”.
In the Servers panel, double-click the server runtime to open its Overview page.
Expand Publishing, and then select Never publish automatically.
If the Fuse project has already been assigned to the server runtime, make sure the If server started, publish changes immediately option is disabled.
1. In the Servers panel, right-click the server runtime to open the context menu.
2. Click Add and Remove... to open the server's Add and Remove page.
3. If the If server started, publish changes immediately option is enabled, disable it.
4. Skip to Step 6.
If the Fuse project has not been assigned to the server runtime, assign it now.
1. Follow Step 5 through Step 6 in the section called “Publishing Fuse projects automatically when resources change”.
2. Do not enable the If server started, publish changes immediately option.
Click Finish.
The project appears in the Servers panel under the server runtime node, and the server runtime status reports [Started]:

View larger image
In the Servers panel, right-click the project's node (in this case, the Fuse project wildThing) to open the context menu:

View larger image
Select Full Publish.
During the publishing operation, the status of both the server runtime and the project report [Started,Republish]:

View larger image

When publishing is done, the status of both the server runtime and the project report [Started,Synchronized]:

View larger image

Note
The tooling does not support the Incremental Publish option. Clicking Incremental Publish results in a full publish.

Verifying the project was published to the server
Copy link

After you have published a Fuse project to a server runtime, you can connect to the server and check that the project's bundle was installed on it.

Connect to the server runtime. For details see the section called “Connecting to a running server in Servers panel”.
In the Servers panel, expand the server runtime tree to expose the Bundles node and select it.
The tooling populates Properties view with a list of bundles that are installed on the server:

View larger image
To find your project's bundle, either scroll down to the bottom of the list, or start typing the bundle's symbolic name in Properties view's Search box.
The bundle's symbolic name is the artifactId you gave the project when you created it. You can find the artifactId at the very beginning of the project's pom.xml file. To open it in the tooling's XML editor, click pom.xml in Project Explorer, and then click the pom.xml tab in the XML editor.

Part VI. Working with Fabrics
Copy link

A fabric is a distributed configuration, provisioning, and clustering mechanism for developing, testing, and running Red Hat JBoss Fuse Tooling projects on multiple computers in an on-premises or public Cloud. You can view and edit fabrics, and the containers, versions, and profiles of which they consist. You can also create and delete containers and profiles, but you can only create versions.

For in-depth information on Fabric8, see the Fabric Guide and Cloud Computing with Fabric on the Red Hat Customer Portal

To open Fabric8 perspective (Chapter 4, Fabric8 Perspective), click

on the right side of the JBoss Developer Studio tool bar, and then select Fabric8 from the list of available perspectives.

Warning

The Fabric8 Tooling feature has now been deprecated. Red Hat support for this feature will be discontinued from JBoss Fuse version 6.2. However, this feature will be removed completely after JBoss Fuse 7.0 release.

Chapter 30. Setting up a Fabric Environment
Copy link

The tooling provides an environment for developing and debugging fabric applications. Use the tooling to build a mock-up of your actual fabric into which you can deploy your application to test and debug it.

Overview
Copy link

To set up a fabric environment, you must have access to an existing fabric.

Note

With Red Hat JBoss Fuse and the JBoss Server Extensions feature installed, you can start up Red Hat JBoss Fuse and create a fabric from inside the tooling. See Chapter 28, Managing servers

Setting up a fabric environment involves several basic steps:

Providing the details for connecting to an existing fabric
Connecting to the fabric
Creating the containers that will host the various components of your distributed integration application
Assigning each container one or more profiles, which provision containers by deploying and installing specified applications.

Note

For cloud applications, unless the cloud already has a fabric registry agent running on it, you must create one yourself before you can include it to your fabric environment. For details, see Chapter 35, Creating a Fabric in the Cloud.

Opening the fabric perspective
Copy link

To set up a fabric environment, you must switch to the Fabric8 perspective, by selecting Window → Open Perspective → Other... → Fabric8, or clicking new perspective button

in the Perspectives tab, and selecting Fabric8.

Chapter 31. Specifying and Connecting to a Fabric
Copy link

Before you can view and edit your fabric, you must add it to the Fabric Explorer view. You can add multiple fabrics in Fabric8 perspective and connect to them concurrently.

31.1. Adding fabric details
Copy link

Overview
Copy link

For the tooling to connect to a fabric, you must provide certain details about the fabric.

Procedure
Copy link

To specify the details for connecting to a fabric:

In Fabric Explorer, right-click Fabrics to open the context menu, and then select Add Fabric details to open the Fabric Details wizard, as shown in Figure 31.1.
Figure 31.1. Fabric Details wizard

View larger image
In Name, enter the name of the fabric to which you want to connect. The name you enter identifies the fabric whose location you specify in Jolokia URL, and this name will appear in Fabric Explorer.
The default Name is Local Fabric.
In Jolokia URL, enter the url, in the form http://hostname:port/jolokia/, of the fabric to which you want to connect. This URL specifies the location of a fabric registry agent, whose default port is 8181.
The default URL is http://localhost:8181/jolokia/.
In User name, enter the name used to log into the specified fabric.
This is the user name that was either specified when the fabric was created or is defined in the Red Hat JBoss Fuse installDir/etc/users.properties file. In that file, user information is specified using this format: user=password,role (for example, admin=admin,Administrator).
You can discover the user name by issuing the command JBossFuse:karaf@root>jaas:users, if the Jaas realm has been selected for the fabric.
In Password, enter the password required for User name to log into the specified fabric.
This is the password that was either specified for User name when the fabric was created or is defined in the Red Hat JBoss Fuse installDir/etc/users.properties file.
In Zookeeper Password, enter the password required for logging into the specified fabric's zookeeper registry.
This is the password that was either specified when the fabric was created or is the password of the first user defined in the Red Hat JBoss Fuse installDir/etc/users.properties file.
You can discover the Zookeeper password by issuing the command JBossFuse:karaf@root>fabric:ensemble-password.
Click OK.
The fabric's name appears in Fabric Explorer as a node beneath Fabrics.
Note
Before you can view or modify a fabric's containers, profiles or versions, you must connect to the fabric. For details see Section 31.2, “Connecting to a fabric”

31.2. Connecting to a fabric
Copy link

Overview
Copy link

The tooling connects to a fabric using the connection information you specified for it in the Fabric Details dialog.

Procedure
Copy link

To connect to a fabric:

In Fabric Explorer, select the fabric to which you want to connect, then right-click it to open the context menu.
Select Connect.
An expand arrow ( ) appears next to the fabric you selected in Fabric Explorer.
Click ( ) to expand the fabric's tree and browse its containers, profiles, and versions.
From here, you can create and deploy new containers or modify existing ones by assigning them new profiles or modified versions of existing profiles.

31.3. Disconnecting from a fabric
Copy link

Overview
Copy link

Typically, you'd disconnect from a fabric without stopping its containers since they usually run application services. In this case, the containers will continue to run, unless stopped using the tooling or the Red Hat JBoss Fuse console command line.

Procedure
Copy link

In Fabric Explorer, select the fabric from which you want to disconnect, then right-click it to open the context menu.
Select Disconnect.
The tooling closes the connection with the selected fabric.

31.4. Editing a fabric's details
Copy link

Overview
Copy link

When any of the details for connecting to your fabric change, you need to update the details in the tooling.

Important

Before you edit a fabric's details, disconnect from the fabric.

Procedure
Copy link

In Fabric Explorer, select the fabric whose details you want to edit, and right-click it to open the context menu.
Select Edit Fabric details to open the Fabric Details dialog, as shown in Figure 31.1, “Fabric Details wizard”.
In Name, enter a new name for the fabric, if necessary.
In Jolokia URL, enter the new url of the fabric, if necessary.
In User name, enter a name with which the new user will log into the selected fabric, if necessary.
In Password, enter the new password to use for logging into the selected fabric, if necessary.
Click OK.

31.5. Deleting a fabric's details
Copy link

Overview
Copy link

To remove a fabric from Fabric Explorer, you delete its details.

Procedure
Copy link

In Fabric Explorer, select the fabric whose details you want to delete, then right-click it to open the context menu.
Select Delete Fabric details.
The tooling closes the connection with the selected fabric, and then deletes the fabric's details.

Chapter 32. Working with Fabric Containers
Copy link

32.1. Creating a new child container
Copy link

Overview
Copy link

A child container is created on the server where its parent is.

Procedure
Copy link

To create a new child container:

If necessary, in Fabric Explorer, expand the tree of the selected fabric in which you want to create the new child container.
Right-click the target parent container to open the context menu, and then select Create a new child container.
Figure 32.1. Create Child Container wizard

View larger image
In Container name, enter a name for the new child container.
We recommend that you replace the default name with a meaningful name that identifies the container's role or function.
If multiple versions exist, you can select one from the Version drop-down list. Otherwise, accept the default value.
Under Profiles, click the checkbox next to the profile or profiles you want to assign to the new child container.
Profiles determine the function of containers; what applications they run. You can assign multiple profiles to a container, as long as the applications they install do not conflict with one another.
Important
Do not assign a base profile (one ending in -base) to a container.
Click OK.
The new child container appears in Fabric Explorer as a node under Containers
Note
Selecting the new container in Fabric Explorer populates its Profiles and Profile Details pages in Properties viewer.

32.2. Creating a container on a remote host
Copy link

Overview
Copy link

To create a container on a remote host, the remote host machine must be ssh-enabled.

Note

Creating a container via ssh on a remote Windows machine is not supported.

Procedure
Copy link

To create a new container on a remote machine:

If necessary, in Fabric Explorer, expand the tree of the fabric for which you want to create the new remote container.
Right-click Containers to open the context menu, and then select Create a new container via SSH.
Figure 32.2. Create Container via SSH wizard

View larger image

Note
An error icon ( ) marks required fields that lack a valid value, and the dialog banner displays the number of errors detected.
In Container name, enter a name for the new container.
We recommend that you replace the default name with a meaningful name that identifies the container's role or function.
If multiple versions exist, you can select one from the Version drop-down list. Otherwise, accept the default value.
In Host, enter the name or the IP address of the remote host.
In User name, enter the name of a user authorized to log into the remote host.
In Password, enter the password for User name.
In Path, accept the default (~/containers/), or enter the path of the new container's location on the remote host.
In Port, accept the default port number (22), or enter a new port number to use for establishing an ssh connection on the remote host.
In SSH retries, accept the default (1), or enter the maximum number of retries to attempt at establishing an ssh connection on the remote host.
In Retry delay, accept the default (1), or enter the delay, in milliseconds, between retry attempts.
Under Profiles, click the checkbox next to the profile or profiles you want to assign to the container.
Profiles determine the function of a container; what applications it runs. You can assign multiple profiles to a container, as long as the applications they install do not conflict with one another.
Important
Do not assign a base profile (one ending in -base) to a container.
Click OK.
The new container appears in Fabric Explorer as a container node under Containers
Selecting the new container in Fabric Explorers populates its Profiles and Profile Details pages in Properties viewer.

32.3. Creating a new container on a cloud
Copy link

Overview
Copy link

To create a container on a cloud, you need to specify the cloud's connection details and then create the container.

Procedure
Copy link

To create a new container on a cloud:

In Fabric Explorer, if necessary, expand the tree of the fabric for which you want to create the new container on the cloud. Right-click Containers to open the context menu.
Select Create a new container on the cloud to open the Create Container in a Cloud wizard.
Figure 32.3. Create Container in a Cloud/Choose the Cloud page

View larger image

Note
Unless the connection details for a cloud have already been added to the tooling, this dialog opens devoid of selections. You can add a cloud's connection details now by clicking Add Cloud details and following the procedure in Section 35.1, “Adding cloud details”.
Select a cloud from the list, and click Next to open the New Containers Details page.
Figure 32.4. New Containers Details page

View larger image

Note
An error icon ( ) marks required fields that lack a valid value, and the dialog banner displays the number of errors detected.
In Container name, enter a name for the new container.
We recommend that you replace the default name with a meaningful name that identifies the container's role or function.
If multiple versions exist, you can select one from the Version drop-down list. Otherwise, accept the default version.
In Group, accept the default (fabric), or enter the group in which to start up the new container.
In User, accept the default (admin), or enter the name of another user who is authorized to log into the new cloud container.
This is the user that was either specified when the fabric was created or is defined in the Red Hat JBoss Fuse installDir/etc/users.properties file (see Section 31.1, “Adding fabric details”).
In Password, enter the pasword required for User to log into the new cloud container.
This is the password that was specified for User when the fabric was created or is defined for the user in the Red Hat JBoss Fuse installDir/etc/users.properties file.
In Zookeeper Password, accept the default generated password for logging into the cloud container's zookeeper registry, or enter the zookeeper password that was used when the fabric was created.
You can discover the zookeeper password by issuing the commmand JBossFuse:karaf@root>fabric:ensemble-password.
In Hardware ID, select from the drop-down list the ID of the hardware archetype to use.
Hardware archetypes specify the amount of memory and compute power available for running applications on machine images.
Important
The next three fields provide two methods for specifying the software configuration (operating system, application server, and applications) you want to use. Either select an OS Family (and optionally a version), or select an Image ID.
In OS Family, select from the drop-down list the family name of the operating system you want to use.
If you select an OS Family, do not also select an Image ID.
In OS Version, optionally select from the drop-down list the version for the operating system you selected.
If you selected an OS Family, skip this step. Otherwise, in Image ID, select from the drop-down list the ID of the image template to use for the software configuration.
Note
The tooling starts an instance of the image in the cloud, and then installs a fabric agent and provisions the new agent with the selected profiles. Depending on the cloud provider, instantiation and provisioning could take some time.
Under Profiles, select the profile or profiles you want to assign to the container.
Profiles determine the function of containers—what applications they run. You can assign a container multiple profiles, as long as the applications they install do not conflict with one another.
Important
Do not assign a base profile (one ending in -base) to a container.
Click OK.
The new container appears in Fabric Explorer as a container node under Containers
Note
Selecting the new container in Fabric Explorer populates its Profiles and Profile Details pages in Properties viewer.

32.4. Starting a container
Copy link

Overview
Copy link

When you create a container, it starts up automatically and continues to run until stopped by some event, planned or otherwise. You can manually restart a stopped container.

Procedure
Copy link

To start a container:

If necessary, in Fabric Explorer, expand the tree of the fabric whose container you want to start.
Select the container and right-click it to open the context menu.

Click Start Container.

Note

To check whether the tooling started the container, click Containers in Fabric Explorer, and open the Properties view. You should see something similar to Figure 32.5, where mycamelExample was started and provisioned successfully.

Figure 32.5. Container status in Properties view

The status indicators in the Status column of the Properties view indicate the startup state of the container, as shown Table 32.1:

Expand

Table 32.1. Container startup status
Icon	Meaning
	Container stopped
	Container started; analysis and provisioning in progress
	Container started and provisioned successfully
	Failure occurred during startup or provisioning

32.5. Changing a Container's Profiles
Copy link

Overview
Copy link

A container's profiles determine what the container is hosting. If you want to change what is deployed in a container or how it is configured, you change the profiles deployed to it.

Important

The profile or profiles you select will override the entire list of profiles currently deployed in the selected container.

Procedure
Copy link

To change the profiles deployed to a container:

Select the container.
In the Properties view, select the Profiles tab.
From the list, select the profile or profiles you want to deploy to the container by highlighting them.
Note
To select multiple profiles, hold down the CTRL key while you select them.

32.6. Stopping a container
Copy link

Overview
Copy link

There are times when you might want to stop then restart a container; for example, to recycle a hung container, force a container to reprovision itself, or to reclaim CPU cycles.

Procedure
Copy link

To stop a container:

If necessary, in Fabric Explorer, expand the tree of the fabric whose container you want to stop.
Select the container and right-click it to open the context menu.
Click Stop Container.
Note
To check whether the tooling stopped the container, click Containers in Fabric Explorer, and open the Properties view. You should see something similar to Figure 32.6, where myRoute was stopped successfully.
Figure 32.6. Container status in Properties view

View larger image

For information on the meaning of the status indicators that might appear in the Status column of the Properties view, see Table 32.1, “Container startup status”.

32.7. Deleting a container
Copy link

Overview
Copy link

When a container becomes obsolete—no longer used in the fabric integration project—you may want to delete it. Before you do so, make sure no other container in the project depends on it. Deleting a container terminates the container and its processes and removes its configuration from the fabric.

Note

To delete a container, it must be running in the fabric.

Procedure
Copy link

To delete a container:

If necessary, in Fabric Explorer, expand the tree of the fabric whose container you want to delete.
Click Containers to populate Properties view with a list of the fabric's containers.
In Properties view, select the container you want to delete, and then click on the right-hand side of the toolbar.
Figure 32.7. Container selected for deletion in Properties view

View larger image
In the Destroy Container(s) dialog, click OK to delete the selected container.
The tooling displays a message that removal is in progress. In Properties view, the container's status briefly changes to stopped, and then the container disappears from the list.
In Fabric Explorer, open the fabric's context menu, and click Refresh to update Containers and remove the deleted container from the tree.
Note
If you have the Red Hat JBoss Fuse console open in Shell view, you can verify that the container and its configuration have been removed from the fabric by entering at the command line fabric:container-list.

Chapter 33. Working with Fabric Profiles
Copy link

Profiles are applied to fabric containers, and they determine the function and behavior of their containers. A profile consists of code and configurations, which specify the type of service or application a container runs. The code may come from OSGi bundles and Karaf features pulled from repositories, also specified in the profile. Defined hierarchically, profiles can be set up to inherit from other profiles, building on their parents' definitions.

33.1. Creating a new profile
Copy link

Overview
Copy link

The tooling provides access to numerous profiles, each of which imparts specific functionality and behaviors to the containers to which it's assigned. But you may want to create new profiles that inherit from these base profiles, so you can override, for example, configuration details. You may also want to create your own profiles to deploy your own code. To do so, you create a new profile based on an existing one, and then change its configuration and properties to generate the specific behaviors you want to deploy to the target containers.

Note

This procedure creates a brand new profile. If you want to create a new version of an existing profile to incrementally test changes to deployed containers, see Chapter 34, Working with Versions

Procedure
Copy link

To create a new profile:

In Fabric Explorer, expand the fabric in which you want to create a new profile.
Expand the fabric's tree to the level of the profiles, as shown in Figure 33.1.
Figure 33.1. Accessing the profiles

View larger image
Select the profile on which you want to base the new profile, and right-click it to open the context menu.
Important
Because the selected profile is the parent of the new profile, the new profile inherits the selected profile's configurations, properties, features, repositories and bundles as well as those of the selected profile's ancestors. However, a child's configurations override an ancestor's when their configuration files have the same name.
Note
Neither configuration files nor properties are visible within the tooling, but you can view them in the Red Hat JBoss Fuse Management Console. For details, see the Red Hat JBoss Fuse Management Console documentation at https://access.redhat.com/documentation/en-US/Red_Hat_JBoss_Fuse/.
Select Create a new Profile.
Figure 33.2. Create Profile dialog

View larger image
In Profile name, enter a name for the new profile.
Use a name that is descriptive of the new profile's function.
Click OK to create and save the new profile.
The new profile is added to the list of profiles in Fabric Explorer, under its parent profile.
In Fabric Explorer, select the new profile to populate the Properties editor with the new profile's properties information and profile details.
In the Properties editor, click the Details tab.
Figure 33.3. Profiles page

View larger image

On the Profiles page, you can add, delete, or edit features, the repositories from which features are downloaded, and bundles. You can also add or remove parent profiles. Profiles can have multiple parents, and they inherit the qualities of each
Features are files that aggregate references to interdependent or related bundles that together define a feature. Typically, you'd use bundles only if the feature they define is not already included in a features file. For more information on bundles and features, see Deploying Features.
Child profiles inherit everything (configurations, properties, features, repositories, and bundles) from their immediate parents and from all of their parents' ancestors. When the child's and any ancestor's configuration file have the same name, the child's configuration file replaces the ancestor's file. Otherwise, configurations are cumulative.
Note
The Profiles page displays only the features, repositories, and bundles added by the child profile, not those contributed by the profile's parents or other ancestors. The Parents pane shows (highlighted) the profile's immediate parents only.
Make the changes you want to the new profile to configure it.
Changes are automatically saved as you make them.
Note
In Fuse Integration perspective, you can easily add a Fuse project to the new profile by dragging it from Project Explorer and dropping it onto the new profile in Fabric Explorer. When you do, the fabric tooling builds the project, runs all tests, installs the project in the new profile, and uploads the profile into the fabric's internal Maven repository. Because profiles are stored in a fabric's internal repository, they cannot be shared across other fabrics.
Important
If you drop your project on a fabric container, rather than on a profile, the next time that container is provisioned, your project is wiped out.
You can now assign the new profile to a container.
In Fabric Explorer, select the container to which you want to assign the new profile.
The fabric tooling populates the Properties editor with the container's properties information and profile details.
Open the container's Details tab, and then select the new profile in the Profiles list.
Repeat Step 10 and Step 11 for each container to which you want to assign the new profile.

33.2. Deleting a profile
Copy link

Overview
Copy link

When a profile is inactive—no longer assigned to any container in the fabric—you can safely delete it.

Procedure
Copy link

To delete an inactive profile:

In Fabric Explorer, expand the fabric which contains the profile you want to delete.
Expand the fabric's tree to the level of versions, and then expand the version that contains the target profile.
Select the target profile, and right-click it to open the context menu.
Select Delete Profile.

Chapter 34. Working with Versions
Copy link

Versioning provides the means for safely rolling out upgrades of the profiles deployed and running in containers across a fabric. Using versioning, you can make incremental updates to existing profiles, and then test them out on small groups of containers. When you've completed and tested the final versions, you can confidently deploy them to their target containers in the fabric.

34.1. Creating a new version of a profile
Copy link

Overview
Copy link

A version is simply the collection of all profiles associated with a fabric. When you create a new version, you are copying all of the profiles from the most recent version—the base version—into the new version. Once that's done, you can upgrade the profiles in the new version by modifying them.

Creating a new version
Copy link

To create a new version:

In Fabric Explorer, select the fabric in which you want to create a new version.
Expand the fabric's tree to the level of Versions, shown in Section 33.1, “Creating a new profile”.
Select Versions, and then right-click it to open the context menu.
Select Create Version.
In the Create Version wizard, enter a new version or accept the default value.
The default version is always a minor increment of the highest-numbered version. So, if the highest-numbered version is 1.3, the new version will default to 1.4, and all of the profiles in version 1.3 will be copied into version 1.4.
Important
Version names are important! The tooling sorts version names based on the numeric version string, according to major.minor numbering, to determine the version on which to base a new one. You can safely add a text description to a version name as long as you append it to the end of the generated default name like this: 1.3<.description>. If you abandon the default naming convention and use a textual name instead (for example, Patch051312), the next version you create will be based, not on the last version (Patch051312), but on the highest-numbered version determined by dot syntax.
Click OK.
The tooling copies all of the base version's profiles into the new version and displays the new version in Fabric Explorer, directly under the base version.

Modifying profiles in the new version
Copy link

To modify a profile in the new version:

In Fabric Explorer, expand the newly created version.
Select a profile that you want to modify.
The tooling populates the Properties editor with the profile's details for you to edit.
In the Properties editor, click the Details tab to access the Profiles page.
Make the changes you want to the new profile to configure it.
Changes are automatically saved as you make them.

34.2. Setting a container's version
Copy link

Overview
Copy link

After you've created a new version, you can assign it to selected containers. This feature enables you to easily roll out upgraded profiles in a controlled and orderly way.

Important

Setting a container's version immediately provisions the container with the profiles from the selected version.

Procedure
Copy link

To set a container's version:

In Fabric Explorer, select the container whose profiles you want to change.
Right-click it to open the context menu, and then select Select Version.
The Select Version submenu lists all available versions.
Click the version you want to assign the selected container.
The container is immediately provisioned with the new version of any profile assigned to it.

Chapter 35. Creating a Fabric in the Cloud
Copy link

To create a fabric on a cloud, you need to

Have established an account with a cloud provider
Provide the tooling the account details for connecting to the cloud
Specify the details required for creating the fabric and the machine image on which it will run

35.1. Adding cloud details
Copy link

Overview
Copy link

To connect to a cloud, the tooling needs the relevant access and authorization information. This information was provided to you or a system administrator by the cloud provider, when the account was set up.

Procedure
Copy link

To add a cloud's access details:

In Fabric Explorer, right-click Clouds to open the context menu, and then select Add Cloud details.
Figure 35.1. Cloud Details wizard

View larger image

Note
An error icon ( ) marks required fields that lack a valid value, and the dialog banner displays the number of errors detected.
In Name, enter a name for the cloud.
Important
The next three fields provide two methods for specifying the provider's information. You select either a provider's name, or you select both an API and its endpoint.
In Provider name, select the name of the cloud provider from the drop-down list.
If you select a provider name, the tooling autofills Api name and Endpoint with the selected provider's information, so you can skip to Step 6.
In Api name, select from the drop-down list the name of the API you want to use.
This list displays only APIs that have been installed on your local machine or environment.
In Endpoint, enter the uri of the web service that exposes the API you selected in Step 4.
If you have an on-premises, private cloud installed, you need to get this uri from the cloud administrator.
In Identity, enter the account identifier supplied by the cloud provider.
For example, for Amazon Elastic Compute Cloud (EC2) accounts, you'd enter the Access Key ID.
In Credential, enter the account password supplied by the cloud provider.
For example, for Amazon Elastic Compute Cloud (EC2) accounts, you'd enter the Secret Access Key.
In Owner, for EC2 only, enter the id assigned to a custom image.
This option is EC2-specific and applies only to custom images. To query or use a custom image, you must enter the owner id assigned to it by EC2; otherwise, the image will not appear in the list of instances.

If you entered valid access details, the tooling connects to the cloud whose access details you specified and loads the provider's images. Once that's done, the name you entered in Step 2 appears as a node under Clouds in Fabric Explorer.

35.2. Specifying fabric details
Copy link

After you've added the access information that the tooling needs to connect to a cloud, you can create a fabric on the cloud. This procedure assumes that you have already added the cloud details.

Overview
Copy link

Creating a fabric on a cloud involves creating on the cloud a container that contains a fabric registry and specifying the machine image on which you want to create and run it.

Procedure
Copy link

To create a fabric on a cloud:

In Fabric Explorer, right-click Fabrics to open the context menu, and then select Create Fabric in the cloud.
On the Create Fabric in the cloud wizard's Choose the Cloud page, select the cloud from the list, and then click Next to open the wizard's Fabric Details page.
Figure 35.2. Fabric Details page

View larger image

Note
An error icon ( ) marks required fields that lack a valid value, and the dialog banner displays the number of errors detected.
You may have to wait a few seconds while the tooling retrieves the location, hardware, and image IDs from your cloud provider to populate the wizard's corresponding fields.
In Fabric Name, accept the default name, or enter a different name for the new fabric.
In Container name, accept the default name, or enter a different name for the new container that will host the fabric registry.
In Group, accept the default name, or enter a different name for the group in which to start up the new fabric registry container.
In User, accept the default user name, or enter a different user name to use for logging into the new fabric registry container.
In Password, enter the password required for User to log into the specified fabric.
In Zookeeper Password, accept the default, generated password for logging into the cloud fabric's zookeeper registry, or enter a different password.
In Location ID, select from the drop-down list the ID of the region in which the machines you want to use are located.
In Hardware ID, select from the drop-down list the ID of the hardware archetype you want to use.
Hardware archetypes specify the amount of memory and compute power available for running applications on machine images.
Important
The next three fields provide two methods for specifying the software configuration (operating system, application server, and applications) you want to use. Either select an OS Family (and optionally a version), or select an Image ID.
In OS Family, select from the drop-down list the family name of the operating system you want to use.
If you select an OS Family, do not also select an Image ID.
In OS Version, optionally select from the drop-down list the version for the operating system you selected.
If you selected an OS Family, skip this step. Otherwise, in Image ID, select from the drop-down list the ID of the image template to use for the software configuration.
In Maven proxy URI, accept the default URI, or enter the URI to the Maven proxy repository you want to use.
Click Finish.
The tooling creates the container, then provisions it with all of the bundles, features, and profiles required to create a fabric registry. This process can take up to ten minutes. When it's done, the container specified in Step 4 appears in Fabric Explorer as a node under Fabrics.
Note
It's a good idea to access your cloud account and verify that the new fabric registry container is up and running.

Appendix A. Wizard field references
Copy link

Name

New Camel XML File — Creates a new XML file for editing routes with the route editor

Properties

Table A.1 describes the properties you can specify.

Expand

Table A.1. New Camel XML File properties
Name	Default	Description
RouteContainer		Specifies the folder into which the new file will be placed.
File Name	camelContext.xml	Specifies the name of the new routing context file.
Framework	Spring	Specifies whether the context file is intended to be used in a Spring container or in an OSGi container that supports Blueprint or to be added to into existing `camelContext`s.

Important

The Spring framework and the OSGi Blueprint framework require that all Apache Camel files be placed in specific locations under the project's META-INF folder:

Spring—projectName /src/main/resources/META-INF/spring/
OSGi Blueprint—projectName /src/main/resources/META-INF/blueprint/

Name

New Fuse Project — Creates a new Fuse project

Properties

Table A.2 describes the properties you can specify.

Expand

Table A.2. New Fuse IDE project: select project location properties
Name	Default	Description
Project Name		Specifies the name of the new project.
Use default Workspace location	Enabled	Specifies whether to create the new project in the default workspace.
Location		Specifies the full path to an alternate workspace when the default workspace location option is disabled.
Add project(s) to working set	Disabled	Specifies whether to add the new project to one or more established working sets.
Working set		Specifies the working sets in which to add the new project when the working set option is enabled.

Name

New Fuse Project — Creates a new Fuse project

Properties

Table A.3 describes the properties you can specify.

Expand

Table A.3. New Fuse project: select project archetype and specify its details properties
Name	Default	Description
Archetype		Specifies the Maven archetype to use to create the new project.
Group ID		Specifies the group ID Maven uses when generating the new project. This ID is mapped to the POM file's `groupId` element.
Artifact ID		Specifies the artifact ID Maven uses when generating the new project. This ID is mapped to the POM file's `artifactId` element.
Version	1.0.0-SNAPSHOT	Specifies the version name Maven uses when generating the new project. You can accept the default version name, or enter a new one. This value is mapped to the POM file's `version` element.
Package	<groupID>.<artifactID>	Specifies the package name for the generated artifacts. You can accept the default package name, or enter a new one.

Name

New Fuse Message — Creates a new message to use in route tracing.

Properties

Table A.4 describes the properties you can specify.

Expand

Table A.4. Fuse Message File properties
Name	Default	Description
Parent Folder	The selected folder	Specifies the folder into which the new message file will be placed.
File Name	message.xml	Specifies the name of the new message file.

Name

New Camel JUnit Test Case — Configures the JUnit artifacts created to test a Apache Camel route.

Properties

Table A.5 describes the properties you can specify.

Expand

Table A.5. New Camel JUnit properties
Name	Default	Description
Source Folder	project/src/test/java	Specifies the folder into which the JUnit code is placed.
Package	Name of the package when the project was created	Specifies the package name for the JUnit code.
Camel XML file under test	Selected context file, or blank if other than a context file is selected	Specifies the Camel XML file containing the routes to be tested.
Name	classname based on the selected context file (for example, CamelContextXMLTest), or empty if none selected	Specifies the name of the JUnit class.
Method stubs		Specifies the JUnit method stubs to include in the generated test class.
Generate comments		Specifies whether to generate comments in the new test class.

Name

Test Endpoints — Lists the endpoints that can be tested by a JUnit test case.

Properties

Table A.6 describes the properties you can specify.

Expand

Table A.6. Test Endpoint properties
Name	Default	Description
Available endpoints	all	Specifies the endpoints to test in the Camel JUnit test case.

Name

Define a New Server — Defines a new server instance.

Properties

Table A.7 describes the properties you can specify.

Expand

Table A.7. New Server properties
Name	Default	Description
Server type		Specifies the type of server to define.
Server's host name		Specifies the name of the machine running the server.
Server name		Specifies the name of the server.
Server runtime environment	Selected server's runtime	Specifies the runtime environment of the server.

Name

New Server Configuration — Configures access details for the server.

Properties

Table A.8 describes the properties you can specify.

Expand

Table A.8. Server Configuration details properties
Name	Default	Description
Host Name	For localhost, `0.0.0.0`	Specifies the address of the machine running the server.
Port Name	8101	Specifies the port used to contact the server.
User Name		[Optional] Specifies the name of a user authorized to access the server remotely.
Password		[Optional] Specifies the password the authorized user must enter to access the server remotely.

Name

Add and Remove — Specifies the resources available to a server.

Properties

Table A.9 describes the properties you can specify.

Expand

Table A.9. Add and Remove properties
Name	Description
Available	Specifies the resources that are available to the server.
Configured	Specifies the resources that the server is configured to use.

Name

Fabric Details — Specifies information needed to connect to a fabric.

Properties

Table A.10 describes the properties you can specify.

Expand

Table A.10. Fabric Details properties
Name	Default	Description
Name	Local Fabric	Specifies the name of the fabric to connect to.
Jolokia URL	https://localhost:8181/jolokia	Specifies the url, in the form of https://hostname:port/jolokia, of the specified fabric.
User name		Specifies the name of a user that has login privileges.
Password		Specifies the password of the specified user.
Zookeeper Password		Specifies the password for accessing the fabric registry.

Name

Create Child Container — Specifies information needed to create a container on the local host.

Properties

Table A.11 describes the properties you can specify.

Expand

Table A.11. Create Child Container properties
Name	Default	Description
Container name	Container#	Specifies the name of the new container.
Version	The highest-numbered version according to major.minor numbering	Specifies the version of the profiles to use.
Profiles		Specifies the profile(s) to install in the new container.

Name

Create Container via SSH — Specifies information needed to create a container on a remote host.

Properties

Table A.12 describes the properties you can specify.

Expand

Table A.12. Create Container via SSH properties
Name	Default	Description
Container name	Container#	Specifies the name of the new container.
Version	The highest-numbered version according to major.minor numbering	Specifies the version of the profiles to use.
Host		Specifies the name or the IP address of the remote host.
User name		Specifies the name of a user authorized to login to the remote host.
Password		Specifies the password of the specified user.
Path	~/containers	Specifies the path of the new container's location on the remote host.
Port	22	Specifies the port number to use for establishing an ssh connection on the remote host.
SSH retries	1	Specifies the maximum number of retries to attempt at establishing an ssh connection on the remote host.
Retry delay	1	Specifies the delay, in milliseconds, between retry attempts.
Profiles		Specifies the profile(s) to install in the new container.

Name

Create Container in a Cloud — Specifies information needed to create a container in a cloud.

Properties

Table A.13 describes the properties you can specify.

Expand

Table A.13. Create Container in a Cloud:New Containers details properties
Name	Default	Description
Container name	Container#	Specifies the name of the new container.
Version	The highest-numbered version according to major.minor numbering	Specifies the version of the profiles to use.
Group	fabric	Specifies the name of the group in which to start up the new container.
User	admin	Specifies the name of a user authorized to login to the new container.
Location ID		Selects the region in which the machines you want to use are located.
Hardware ID		Selects the hardware archetype to use.
OS Family		Selects the general operating system to use.
OS Version		Selects the version of the operating system you selected.
Image ID		Selects a specific image template to use for the software configuration.
Profiles		Specifies the profile(s) to install in the new container.

Name

Create Version — Specifies the identifier for the new version of the fabric's profiles.

Properties

Table A.14 describes the properties you can specify.

Expand

Table A.14. Create Version properties
Name	Default	Description
Create a new version for rolling upgrades to Profiles	The highest-numbered version according to major.minor numbering	Specifies the identifier for the new version of fabric's profiles.

Name

Cloud Details — Specifies information needed to connect to a cloud.

Properties

Table A.15 describes the properties you can specify.

Expand

Table A.15. Cloud Details properties
Name	Default	Description
Name		Specifies the name of the cloud to connect to.
Provider name		Selects the cloud provider.
Api name		Selects the API to use on the specified cloud.
Endpoint		Specifies the cloud endpoint uri.
Identity		Specifies the account identifier (supplied by the cloud provider).
Credential		Specifies the account password (supplied by the cloud provider).
Owner		Specifies the name of the account owner.

Name

Create Fabric in the Cloud — Specifies information needed to create a fabric in a cloud.

Properties

Table A.16 describes the properties you can specify.

Expand

Table A.16. Create Fabric in a Cloud:Fabric details properties
Name	Default	Description
Fabric name	Cloud Fabric	Specifies the name of the new fabric.
Container name	Registry	Specifies the name of the fabric registry container.
Group	fabric	Specifies the name of the group in which to start up the fabric registry container.
User	admin	Specifies the name of a user authorized to login to the fabric registry container.
Password		Specifies the user's password for logging into the the fabric.
Zookeeper Password	****************	Specifies the zookeeper password for logging into the cloud fabric's zookeeper registry.
Location ID		Selects the region in which the machines you want to use are located.
Hardware ID		Selects the hardware archetype to use.
OS Family		Selects the general operating system to use.
OS Version		Selects the version of the operating system you selected.
Image ID		Selects a specific image template to use for the software configuration.
Maven proxy URI	http://repo.fusesource.com/nexus/content/groups/ea	Specifies the Maven proxy repository to use.

Appendix B. Tooling preferences
Copy link

Name

Editor — Sets the default value for some route editor properties.

Properties

Table B.1 describes the properties you can specify.

Expand

Table B.1. Editor Properties
Name	Default	Description
Language	Simple	Specifies the default expression language used by the route editor.
ID values	Enabled	Determines whether ID values are used to label EIP nodes on the route editor's canvas.
Layout direction	Right	Specifies the direction in which routes are laid out on the route editor's canvas.
Diagram grid	Enabled	Determines whether a grid overly is displayed in the background on the route editor's canvas.

Name

Colors — Sets the default colors for diagrammatic components of Route editor.

Properties

Table B.2 describes the properties you can specify.

Expand

Table B.2. Colors Properties
Name	Description
Route Editor Diagram Grid Color	Specifies the default color for the diagram grid.
Route Editor Diagram Connection Color	Specifies the default color for the connection in the diagram.
Route Editor Diagram Text Color	Specifies the default color for the text in the diagram.
Route Editor Diagram Figure Background	Specifies the default color of EIP node background.
Route Editor Diagram Figure Foreground	Specifies the default color of EIP node foreground.

Legal Notice
Copy link

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.

Tooling User Guide

Developing and Debugging Applications

Red Hat

About Red Hat JBoss Fuse ToolingCopy linkLink copied to clipboard!

Part I. Introducing the Fuse Tooling User InterfaceCopy linkLink copied to clipboard!

Chapter 1. JBoss PerspectiveCopy linkLink copied to clipboard!

OverviewCopy linkLink copied to clipboard!

CanvasCopy linkLink copied to clipboard!

PaletteCopy linkLink copied to clipboard!

Project ExplorerCopy linkLink copied to clipboard!

Outline viewCopy linkLink copied to clipboard!

Properties editorCopy linkLink copied to clipboard!

Chapter 2. Debug PerspectiveCopy linkLink copied to clipboard!

OverviewCopy linkLink copied to clipboard!

Related topicsCopy linkLink copied to clipboard!

Chapter 3. Fuse Integration PerspectiveCopy linkLink copied to clipboard!

OverviewCopy linkLink copied to clipboard!

JMX NavigatorCopy linkLink copied to clipboard!

Messages viewCopy linkLink copied to clipboard!

Chapter 4. Fabric8 PerspectiveCopy linkLink copied to clipboard!

Fabric Explorer Copy linkLink copied to clipboard!

Diagram viewCopy linkLink copied to clipboard!

Log viewCopy linkLink copied to clipboard!

Messages viewCopy linkLink copied to clipboard!

Properties viewCopy linkLink copied to clipboard!

JMX viewerCopy linkLink copied to clipboard!

Part II. Developing ApplicationsCopy linkLink copied to clipboard!

Chapter 5. Creating a New Fuse ProjectCopy linkLink copied to clipboard!

OverviewCopy linkLink copied to clipboard!

ProcedureCopy linkLink copied to clipboard!

Resolving Maven dependency errorsCopy linkLink copied to clipboard!

Related topicsCopy linkLink copied to clipboard!

Chapter 6. Creating a New Camel XML fileCopy linkLink copied to clipboard!

OverviewCopy linkLink copied to clipboard!

ProcedureCopy linkLink copied to clipboard!

Related topicsCopy linkLink copied to clipboard!

Chapter 7. Editing a routing context in the route editorCopy linkLink copied to clipboard!

7.1. Adding routes to the routing contextCopy linkLink copied to clipboard!

OverviewCopy linkLink copied to clipboard!

ProcedureCopy linkLink copied to clipboard!

Related topicsCopy linkLink copied to clipboard!

7.2. Adding patterns to a routeCopy linkLink copied to clipboard!

7.2.1. Drag and drop a patternCopy linkLink copied to clipboard!

OverviewCopy linkLink copied to clipboard!

ProcedureCopy linkLink copied to clipboard!

Related topicsCopy linkLink copied to clipboard!

7.2.2. Using the context menuCopy linkLink copied to clipboard!

OverviewCopy linkLink copied to clipboard!

ProcedureCopy linkLink copied to clipboard!

Related topicsCopy linkLink copied to clipboard!

7.3. Connecting patterns to make a routeCopy linkLink copied to clipboard!

OverviewCopy linkLink copied to clipboard!

ProcedureCopy linkLink copied to clipboard!

7.4. Configuring a patternCopy linkLink copied to clipboard!

OverviewCopy linkLink copied to clipboard!

ProcedureCopy linkLink copied to clipboard!

Related topicsCopy linkLink copied to clipboard!

7.5. Rearranging patterns on the canvasCopy linkLink copied to clipboard!

7.5.1. Rearranging patterns by dragging themCopy linkLink copied to clipboard!

OverviewCopy linkLink copied to clipboard!

ProcedureCopy linkLink copied to clipboard!

7.5.2. Automatically aligning patternsCopy linkLink copied to clipboard!

OverviewCopy linkLink copied to clipboard!

ProcedureCopy linkLink copied to clipboard!

7.6. Removing patterns from a routeCopy linkLink copied to clipboard!

OverviewCopy linkLink copied to clipboard!

ProcedureCopy linkLink copied to clipboard!

Related topicsCopy linkLink copied to clipboard!

7.7. Disconnecting two patternsCopy linkLink copied to clipboard!

OverviewCopy linkLink copied to clipboard!

ProcedureCopy linkLink copied to clipboard!

Related topicsCopy linkLink copied to clipboard!

7.8. Deleting a routeCopy linkLink copied to clipboard!

OverviewCopy linkLink copied to clipboard!

ProcedureCopy linkLink copied to clipboard!

7.9. Adding beans and configurationCopy linkLink copied to clipboard!

OverviewCopy linkLink copied to clipboard!

ProcedureCopy linkLink copied to clipboard!

Related topicsCopy linkLink copied to clipboard!

7.10. Configuring the route editorCopy linkLink copied to clipboard!

About Red Hat JBoss Fuse Tooling
Copy link

Part I. Introducing the Fuse Tooling User Interface
Copy link

Chapter 1. JBoss Perspective
Copy link

Overview
Copy link

Canvas
Copy link

Palette
Copy link

Project Explorer
Copy link

Outline view
Copy link

Properties editor
Copy link

Chapter 2. Debug Perspective
Copy link

Overview
Copy link

Related topics
Copy link

Chapter 3. Fuse Integration Perspective
Copy link

Overview
Copy link

JMX Navigator
Copy link

Messages view
Copy link

Chapter 4. Fabric8 Perspective
Copy link

Fabric Explorer
Copy link

Diagram view
Copy link

Log view
Copy link

Messages view
Copy link

Properties view
Copy link

JMX viewer
Copy link

Part II. Developing Applications
Copy link

Chapter 5. Creating a New Fuse Project
Copy link

Overview
Copy link

Procedure
Copy link

Resolving Maven dependency errors
Copy link

Related topics
Copy link

Chapter 6. Creating a New Camel XML file
Copy link

Overview
Copy link

Procedure
Copy link

Related topics
Copy link

Chapter 7. Editing a routing context in the route editor
Copy link

7.1. Adding routes to the routing context
Copy link

Overview
Copy link

Procedure
Copy link

Related topics
Copy link

7.2. Adding patterns to a route
Copy link

7.2.1. Drag and drop a pattern
Copy link

Overview
Copy link

Procedure
Copy link

Related topics
Copy link

7.2.2. Using the context menu
Copy link

Overview
Copy link

Procedure
Copy link

Related topics
Copy link

7.3. Connecting patterns to make a route
Copy link

Overview
Copy link

Procedure
Copy link

7.4. Configuring a pattern
Copy link

Overview
Copy link

Procedure
Copy link

Related topics
Copy link

7.5. Rearranging patterns on the canvas
Copy link

7.5.1. Rearranging patterns by dragging them
Copy link

Overview
Copy link

Procedure
Copy link

7.5.2. Automatically aligning patterns
Copy link

Overview
Copy link

Procedure
Copy link

7.6. Removing patterns from a route
Copy link

Overview
Copy link

Procedure
Copy link

Related topics
Copy link

7.7. Disconnecting two patterns
Copy link

Overview
Copy link

Procedure
Copy link

Related topics
Copy link

7.8. Deleting a route
Copy link

Overview
Copy link

Procedure
Copy link

7.9. Adding beans and configuration
Copy link

Overview
Copy link

Procedure
Copy link

Related topics
Copy link

7.10. Configuring the route editor
Copy link

Overview
Copy link

Procedure
Copy link

Related topics
Copy link