Chapter 9. To Publish a Fuse Project to JBoss Fuse
This tutorial walks you through the process of publishing an Apache Camel project to Red Hat JBoss Fuse. It assumes that you have an instance of Red Hat JBoss Fuse installed on the same machine on which you are running the Red Hat JBoss Fuse Tooling.
In this tutorial you will:
- Define a Red Hat JBoss Fuse server
- Configure the publishing options
Start up the Red Hat JBoss Fuse server and publish the
- Connect to the Red Hat JBoss Fuse server
Verify whether the
CBRrouteproject’s bundle was successfully built and published
To complete this tutorial you will need:
- Access to a Red Hat JBoss Fuse 6.3 instance
- The CBRroute project you updated in Chapter 8, To Test a Route with JUnit
Defining a Red Hat JBoss Fuse Server
To define a server:
- Open Fuse Integration perspective.
- Click the Servers tab in the lower, right panel to open the Servers view.
Click the link No servers are available. Click this link to create a new server… to open the Define a New Server page.Note
To define a new server when one is already defined, right-click inside the Servers view to open the context menu, and then select menu:New[ > > Server > ].
Expand the JBoss Fuse node to expose the available server options:
- Click JBoss Fuse 6.3 Server.
Accept the defaults for Server’s host name (localhost) and Server name (JBoss Fuse 6.3 Runtime Server), and then click to open the JBoss Fuse Runtime page:Note
If you do not have JBoss Fuse 6.3 already installed, you can download it now using the Download and install runtime… link.Note
If you have already defined a JBoss Fuse 6.3 server, the tooling skips this page, and instead displays the configuration details page shown in [configDetails].
- Accept the default for Name (JBoss Fuse 6.3 Runtime).
- Click Home Directory field, to navigate to the JBoss Fuse 6.3 installation and select it. next to the
Select the runtime JRE from the drop-down menu next to Execution Environment.
Select either JavaSE-1.8 (recommended) or JavaSE-1.7. If neither appears as an option, click the Environments… button and select either version from the list.Note
The JBoss Fuse 6.3 server requires Java 8 (recommended) or Java 7. To select either version for the Execution Environment, you must have previously installed it.
Leave the Alternate JRE option as is.
Click JBoss Fuse server configuration details page:to save the runtime definition for JBoss Fuse 6.3 Server and open the
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, you can discover the correct port number by looking in the Red Hat JBoss Fuse installDir
In User Name, enter the name used to log into the server.
This is a user name stored in the Red Hat JBoss Fuse installDir
If the default user has been activated (uncommented) in the
/etc/users.propertiesfile, the tooling autofills User Name and Password with the default user’s name and password, as shown in [configDetails].
If one has not been set, you can either add one to that file using the format
joe=secret,Administrator), or you can set one using the karaf
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
In Password:, enter the password required for User name to log into the server.
This is the password set either in Red Hat JBoss Fuse’s installDir
/etc/users.propertiesfile or by the karaf
JBoss Fuse 6.3 Runtime Server [stopped, Synchronized] appears in the Servers view.
In the JBoss Fuse 6.3 Runtime Server [stopped, Synchronized]:view, expand
JBoss Fuse 6.3 Runtime Server [stopped, Synchronized] entry.] appears as a node under
Configuring the publishing options
Using publishing options, you can configure how and when your
CBRroute project is published to a running server:
- Automatically, immediately upon saving changes made to the project
- Automatically, at configured intervals after you have changed and saved the project
- Manually, when you select a publish operation
In this tutorial, you are going to configure immediate publishing upon saving changes to the
CBRroute project. To do so:
In the JBoss Fuse 6.3 Runtime Server [stopped, Synchronized] entry to display its overview:view, double-click the
On the server’s Overview page, expand the Publishing section to expose the options.
Make sure the option Automatically publish when resources change is enabled.
Change the value of Publishing interval to speed up or delay publishing the project when changes have been made.
To configure manual publishing:
- Enable the Overview page. option on the server’s
- Disable the Add and Remove page. option on the server’s
Then to manually publish changes made to selective resources configured on the running server, use the Full Publish option on the resource’s context menu in the Servers view. The Incremental Publish option is not supported and clicking it results in a full publish.
Starting the Red Hat JBoss Fuse server
This section provides instructions for starting the Fuse server and then assigning the
CBRroute module to it for immediate publishing.
In the Servers view, select JBoss Fuse 6.3 Runtime Server and click to start it.Important
A warning that the host identification has changed may appear. Click only if the JBoss Fuse 6.3 server runtime is installed on the same machine where Red Hat JBoss Fuse Tooling is running! Otherwise click and contact your system administrator.to replace the key
Wait a few seconds for JBoss Fuse 6.3 Server to start up. When it does:
The Terminal view displays the JBoss Fuse splash screen:
Servers view displays:
JMX Navigator displays JBoss Fuse 6.3 Runtime Server[Disconnected]:
- In the Servers view, right-click JBoss Fuse 6.3 Runtime Server [Started] to open the context menu.
Select Add and Remove to open the Add and Remove page:
Make sure the option If server is started, publish changes immediately is checked.
CBRrouteand click to assign it to the JBoss Fuse server;
JBoss Fuse 6.3 Runtime Server [Started, Synchronized]Note
For a server, synchronized means that all modules published on the server are identical to their local counterparts.
CBRroute [Started, Synchronized]Note
For a module, synchronized means that the published module is identical to its local counterpart. Because automatic publishing is enabled, changes made to the CBRroute project are published in seconds (according to the value of the Publishing interval).
Connecting to the JBoss Fuse 6.3 runtime server
When you connect to the JBoss Fuse 6.3 Runtime Server, you can see the published elements of your
CBRroute project and interact with them. The instructions in this section will show a display such as the following:
- In the Servers view, double-click JMX[Disconnected] to connect to the runtime server.
Camelfolder in the Servers view or JMX Navigator to expose the elements of the
You can interact with the
CBRrouterouting context using either the Servers view or JMX Navigator, but JMX Navigator provides more room to expand the routing context’s nodes, making it easier for you to access them.Note
_context1node appears in JMX Navigator under Server Connections (or in the Servers view under JMX[Connected]), you can start tracing on it, as described in Chapter 7, To Trace a Message Through a Route.
Click the Bundles node to populate the Properties view with the list of bundles installed on the JBoss Fuse 6.3 Runtime Server:
CBRroutein the Properties view’s Search field to quickly determine whether your project’s
CBRroutebundle is included in the list. Note that it is the last bundle in the list, identified by its Symbolic Name,
CBRroute, which is the name you gave your project when you created it.Note
Alternatively, you can issue the
osgi:listcommand in the Terminal view to see a generated list of bundles installed on the JBoss Fuse server runtime. The tooling uses a different naming scheme for OSGi bundles displayed by the
osgi:listcommand. In this case, the command returns
Empty Camel Blueprint Project [CBRroute], which appears at the end of the list of installed bundles.
<build>section of project’s
pom.xmlfile, you can find the bundle’s symbolic name and its bundle name (OSGi) listed in the
Uninstalling the CBRroute project
You do not need to disconnect the JMX connection or stop the server to uninstall a published resource.
To remove the
CBRroute resource from the JBoss Fuse runtime server:
- In the Servers view, right-click JBoss Fuse 6.3 Runtime Server to open the context menu.
Select Add and Remove:
In the Configured column, select
CBRroute, and then click to move the
CBRrouteresource to the Available column.
- Click .
In the Servers view, right-click JMX[Connected] to open the context menu, and then click Refresh.
Cameltree under JMX[Connected] disappears.Note
In JMX Navigator, the
Cameltree under Server Connections > JBoss Fuse 6.3 Runtime Server[Connected] also disappears.
With the Bundles page displayed, start typing
CBRroute`in the Properties view’s Search field to verify that the bundle has been removed.