ESB Tools Reference Guide

Clicking Next brings you to the JBoss ESB Project wizard page where a project name, ESB version and target JBoss Runtime are to be specified. Specify, for example, helloworld as a Project name and accept the default ESB version.

Clicking Next brings you to the ESB facet installation page where you can specify Java Source Directory and ESB Content Directory. ESB Content Directory is a folder that contains the most of artifacts that an ESB archive needs. You also can configure ESB libraries to the project by selecting a ESB runtime using one of the options:,

1. Use Server Supplied ESB Runtime

2. Select a ESB runtime from the JBoss ESB runtime list predefined in the preferences

If you choose the first option, make sure that the project has the Target JBoss Runtime set and this runtime has a ESB runtime installed.

Click Finish and a ESB project with the default jboss-esb.xml will be created.

Clicking Next brings you to the wizard page where you can select a ESB project example from the example list. Every ESB example has two projects, one is a ESB project and another is a Java project used to test the ESB project.

Select JBoss ESB HelloWorld Example ESB and Client project, and then click Finish, then you will get two projects created.

Deploy the HelloWorld ESB project and run a test class in the client Java project to see the test result in the Console view.

Click Finish to add the project to the server. You also can drag the ESB project from the Project View to the server.

Thus, you have just added the ESB project to the JBoss server module list. Right click the JBoss Server and select Publish to publish the project on the server. You can check the deploying result in the Console view.

Clicking Next brings you to the wizard page where a folder, a name and a version for the file should be specified. Choose, for example, jboss-esb.xml as the name and accept the selected projects folder and the default version.

Thus, your file will be created in the selected projects folder by default. If you want to change the folder for your future file click Browse... button to set needed folder or simply type it.

Clicking on Finish results in the file being generated. The wizard creates one xml file.

Select Add to open a dialog where you can specify the JBoss ESB runtime location, name and version number. You also can customize the libraries of the runtime by checking the Customize JBoss ESB Runtime jars checkbox.

The new JBoss ESB Runtime will be configured. Click OK to finish and save the preferences. You can use the configuration when creating a JBoss ESB project.

When a ESB runtime is configured for your ESB project you are able to change it to any other using the classpath container page for ESB runtime. To do that, turn to the Package Explorer view and right-click the "JBoss ESB Runtime" library. Select Properties and a table listing all available JBoss ESB runtimes will appear:

Choose one of them to set to the ESB project and click Ok.

Select Add, choose JBoss 4.2 Runtime as a type of runtime environment, check the Create a new local server checkbox and click Next:

On the next step you can specify a name of the server runtime environement and browse to its location. Click Finish to add the server runtime environment.

Then you will need to add JBoss ESB libraries to your projects to configure the SOA server runtime exactly for your projects. Right-click on your project, select Build Path > Add Libraries:

Choose JBoss ESB Libraries and click Next:

Select the necessary runtime to add to the project classpath:

Click Finish.

Now you can deploy your Helloworld project to the server and run a test class in the client Java project to see the test result in the Console 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.

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.

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:

You can easily add a new Service too:

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

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.

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

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:

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.

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