Chapter 3. ESB Editor

ESB editor has lots of useful features, they are described in details in this chapter. In addition you'll get to know with how ESB Editor uses combined visual and source editing of esb files.

3.1. ESB File Editor

ESB File Editor is a powerful and customizable tool. ESB File Editor allows developing an application using ESB technology.

ESB file editor has two tabs: Tree and Source.

You can switch to Tree. The Tree view for the editor displays all ESB artifacts in a tree format. By selecting any node you can see and edit its properties which will appear in the right-hand area. For example, a Provider:

Figure 3.1. Tree View

You can easily switch from Tree to Source by selecting the Source tab at the bottom of the editor and work in Source view.

Figure 3.2. Source View

The Source view for the editor displays a text content of the ESB file. It is always synchronized with Tree view, so any changes made in one of the views will immediately appear in the other.

No matter what view you select, you get full integration with Outline view. For example, you can work in the Source view with the help of the Outline view. The Outline view shows a tree structure of the ESB file. Simply select any element in the Outline view and it will jump to the same place in the Source editor, so you can navigate through the source code with Outline view.

Figure 3.3. Outline View

Adding, editing or deleting of some artifacts operations are available right in the Tree view . Right-click any node and select one of the available actions in the context menu. For example, you can easily add a new Provider:

Figure 3.4. Adding New Provider

Then you can add Channels and Properties for the Providers the same way or using the forms with Add, Edit and Remove buttons to the right.

You can easily add a new Service too:

Figure 3.5. Adding New Service

The same way you can create a listener for service and other elements of ESB:

Figure 3.6. Adding New Listener for Service

The same actions can be done in the right part of Tree view tab (Form editor) using Add, Edit and Remove buttons.

In order to add a new generic Action to your ESB XML file you should select the Actions node under the Services, then right-click and choose New > Generic Action.

Figure 3.7. Adding New Action in the Tree View

Or instead make use of Add... button in the Form editor on the left.

Figure 3.8. Adding New Action in the Form Editor

Note:

The out-of-the-box action Smooks Transformer is now deprecated, and replaced by Smooks Action.

As you can see on the bath figures above, the context menu will also prompt you to insert one of the Actions that are supplied out-of-the-box with JBoss ESB. After choosing one an appeared New Action wizard will ask you to fill out a name field and other fields specific for each Action property. For example, for Content Based Router Action the wizard looks as follows:

Figure 3.9. New Action Wizard

After confirming creating the Action you can see it in the Tree under the Actions node and preview as well as edit its settings in the Form editor on the left.

Figure 3.10. Form Editor for Content Based Router

ESB editor can recognize some specific objects. On the figure you can see org.jboss.soa.esb.actions.ContentBasedRouter in the Class section.

3.2. ESB Editors Features

JBoss ESB tooling has powerful editor features that help you easily make use of content and code assist.

This last chapter covers capabilities on how you can use ESB editor.

3.2.1. ESB syntax validation

When working in JBoss ESB editor you are constantly provided with feedback and contextual error checking as you type. In the Source viewer, if at any point a tag is incorrect or incomplete, an error will be indicated next to the line and also in the Problems view below.

3.2.2. Support for XML Schema

JBoss ESB Framework fully supports XML files based on schemas as well as DTDs.

The schema checks the child elements of any kind of provider element; the ESB generates errors on startup if you attempt to define an incorrect combination (e.g.: a jms-bus inside an ftp-provider).

Note:

The schema used behind ESB editor now uses the latest version available (from SOA-P 4.3). This removes the errors/warnings some users have reported seeing when using SOA-P specific esb.xml files.