ESB Tools Reference Guide

1. To configure the JBoss Enterprise SOA Platform, select Window → Preferences → Server → Runtime Environments. This will open the Server Runtime Environments page where you can add, remove and edit a server runtime environment.
2. Select Add and choose JBoss Enterprise Middleware → JBoss Enterpise Application Platform 5.x Runtime as a type of runtime environment, then check the Create a new local server box and click Next.
3. On the next step you can specify a name of the server runtime environment and browse to its location. Click Finish to add the server runtime environment.
4. You have now configured the SOA Platform. Check the configuration by creating and running an ESB project.

Procedure 3.1. Task

1. Start the JBoss Developer studio.
2. Select Get started with JBoss Central from the main menu.
3. Select Software/Update from the menu.
4. Select SOA Tooling Plug-in and click Install
5. Confirm that the installation details are correct and click Next and then Next again.
6. Read and accept the liscence agreement and click Finished.
7. Restart the JBoss Developer Studio to complete the installation.

1. Click Window → Preferences → JBoss Tools → JBoss ESB Runtimes to open the JBoss ESB Runtimes page where you can add, remove and edit a JBoss ESB runtime.
   

   View larger image

   

   Figure 3.1. Runtimes

2. Select Add to open a dialog box where you can specify the JBoss ESB runtime location, name and version number. You can define the configuration if you specify the home directory as JBoss AS or SOA-P. If you select a standalone ESB runtime location, the configuration will be empty and can be ignored. You can also customize the libraries of the runtime by checking the Customize JBoss ESB Runtime jars box.
3. The new JBoss ESB Runtime will be configured. Click Finish to finish and save the preferences. You can use the configuration when creating a JBoss ESB project.
4. When an ESB runtime is configured for your project, you are able to modify it by using the Classpath Container page for ESB runtime. To do so, go to the Package Explorer view and right-click on "JBoss ESB Runtime" library.
5. Select Properties and a table listing all available JBoss ESB runtimes will appear.
6. Choose one of the runtimes to set to the ESB project and click OK.
7. The ESB container allows Source and JavaDoc locations to be set via the Properties dialog on each contained JAR. Right-click on any JAR file and select Properties.
8. Choose Java Source Attachment and select the location (folder, JAR or zip) containing new source for the chosen JAR file. You can do this using one of the suggested options (workspace, external folder or file). You can also enter the path manually.
9. Click on Apply and then on OK.
10. To change the Javadoc location, choose Javadoc Location and specify URL to the documentation generated by Javadoc. The Javadoc location will contain a file called package-list.
11. Click on Apply and then on OK.

1. Open the JBoss ESB Project Creation wizard by selecting File → New → Project... in the main menu bar. (Ensure that you have defined the server runtime and ESB runtime in JBDS.)
2. Select ESB → ESB Project in the dialog box.
3. 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 JBoss ESB version.
4. Click the Next button to move to the next step in the wizard, where you can select the source and output folders.
5. Click the Next button to view the Install ESB Facet wizard page where you can view the ESB Content Directory. This folder contains most the of artifacts that an ESB archive needs.
6. You can configure ESB libraries to the project by using the Server Supplied ESB Runtime. Make sure the project has the target runtime set and this runtime has an ESB runtime installed.

   Note

   If you are using JBoss SOA Platform 5.3 or higher, select ESB config version 1.3.1.
7. Click the Finish button and an ESB project with the default jboss-esb.xml file will be created.

1. Note

   Creating ESB project examples is useful for observing how your finished project will behave.

   Before creating an ESB project example, create a JBoss SOA-P runtime.
2. Select File → New → Other... in the main menu bar and then click Examples → JBoss Tools → Project Examples in the new dialog.
3. Clicking the Next button brings you to the wizard page where you can select an ESB project example from the list.
4. Every ESB example has two projects. One is an ESB project and the other is a Java project used to test the ESB project. Below is a list of ready-to-go examples. Each example includes an ESB application that is deployed to the SOA-P server, and a test client that is run as a Java application and interacts with the deployed ESB application:
5. • JBoss ESB HelloWorld Example - demonstrates the minimal files necessary to make a basic ESB component execute as well as to prove that the ESB runtime is properly configured.
   • JBoss ESB HelloWorld Action Example - demonstrates the use of multiple action invocations from a single configuration. You can use a single Action class and make multiple method calls or use multiple Action classes.
   • JBoss ESB HelloWorld File Action Example - demonstrates using the File gateway feature of the JBoss ESB. Files that are found in a particular directory with a particular extension are sent to a JMS queue with actions for processing.
   • JBoss ESB Web Service consumer1 Example - demonstrates how to consume a JSR181 Web Service in an ESB action.
   • JBoss ESB Web Service producer Example - demonstrates how to deploy a JSR181 Webservice endpoint on JBossESB using the SOAPProcessor action.
   • JBoss ESB Smooks CSV -> XML Example - demonstrates how to transform a comma separated value (CSV) file to an XML.
   • JBoss ESB Smooks XML -> POJO Example - demonstrates the use of Smooks performing a simple transformation by converting an XML file into Java POJOs.
   • JBoss ESB Smooks XML -> XML date-manipulation Example - demonstrates how to manually define and apply a Message Transformation within JBoss ESB.
   • JBoss ESB Smooks XML -> XML Example - a very basic example of how to manually define and apply a Message Transformation within JBoss ESB. It applies a very simple XSLT to a SampleOrder.xml message and prints the before and after XML to the console.
6. Select the relevant ESB project example and then click the Finish button. The ESB application project and the test client project will be created.
   

   View larger image

   

   Figure 3.2. HelloWorld example

7. Deploy your ESB project and run a test class as a local Java application to see the test result in the Console view.

1. Before deploying an ESB project, open the Servers view by selecting Window → Show View → Other → Server → Servers.
2. Create a JBoss server with an ESB runtime installed in the Servers view and start it.
3. Right-click on the new JBoss server, select Add and Remove Projects and add the ESB projects you want to deploy in the open dialog.
4. Click the Finish button to add the project to the server. You also can drag the ESB project from the Project Explorer view to the server.

1. After adding 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.
2. The Run and Debug options work on ESB projects causing a (re)deploy for a user designated server.
   You can also click the "Finger touch" button for a quick restart of the project without restarting the server.

3. Exporting

   Additionally, you can deploy your ESB project as an .esb archive. Right-click on the project and choose Export.
   Choose ESB → ESB File and click Next.
   Export the ESB project to the file system. Choose the destination and target runtime, then make the appropriate settings for the archive. Finally, click Finish
4. Your project is now deployed as an .esb archive.

1. Open a project that has the ESB facet enabled. Select File → New → Other... in the main menu bar or context menu for your selected project, then click ESB → ESB File in the new dialog
2. Clicking the Next button brings you to the wizard page where a folder, name and version should be specified. For example, choose jboss-esb.xml as the name and accept the selected projects folder and the default version.

   Note

   For SOA-P version 5.3 your ESB version is 4.11 and the ESB file schema version is 1.3.1. Older ESB file schema versions are also supported if you are using an older SOA-P server release.
3. Your file will be created in the selected project's folder by default. If you want to change the folder it is saved in, click Browse and select another destination.
4. Click Finish to generate the file.

1. Open an ESB or Java project.
2. Select File → New → Other in the main menu or from the context project menu. Then click ESB → ESB Action in the new dialog.
3. Click Next and you will be brought to the New ESB Action wizard where the class name should be specified. You can also set a package or add an interface.
4. JBoss ESB 4.9 introduced a new set of Action Annotations. The new set of Action Annotations help make it easier to create clean ESB Action implementations by hiding the complexities of implementing interfaces and abstract classes, as well as dealing with the ConfigTree type. If you wish use these annotations, check the type As annotated POJO. Otherwise check the type As AbstractActionPipelineProcessor implementation.
   The Annotations are:
   • @Process
   • @ConfigProperty
   • @Initialize
   • @Destroy
   • @BodyParam
   • @PropertyParam
   • @AttachmentParam
   • @OnSucess
   • @OnException
5. Click on Finish to generate the ESB Action class. This class will become available in ESB Editor wizards.

1. The JBoss ESB editor has two views: Tree and Source. You can easily switch from the Tree view to the Source view by selecting the Source tab at the bottom of the editor and work in Source view, and vice-versa.
   

   View larger image

   

   Figure 4.1. Source view

2. Both views have full integration with the Outline view. The Outline view shows a tree structure of the ESB file. Select any element in the Outline view and it will jump to the same place in the Tree/Source editor, so you can navigate through the source code with Outline view.
3. Both views are synchronized with each other, so any changes made in one of the views will immediately appear in the other.
4. The Tree view for the editor displays all ESB artifacts in a tree format. By selecting any node you can view and edit its properties which will appear on the right. Some properties are represented as links to the associated editors.
   

   View larger image

   

   Figure 4.2. Tree view

5. When editing ESB actions which refer to other files (Drools, Groovy, Smooks, etc.), the label for the field turns into a link to launch the appropriate editor for that file.
6. 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.
7. 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.
8. Additionally, you can add a Service and a new listener for it. Filters can also be added this way.

1. To add a new custom Action to your ESB XML file, go to the Tree view in the JBoss ESB Editor.
2. Select the Actions node under the Services node, then right-click and choose New → Custom Action.
   Alternatively, click the Add... button in the editor on the left.
3. You will see the ESB Action wizard. Specify a name and a Java class. Optionally, you can specify a process for the Action.
4. After creating the Action you can see it in the Tree view under the Actions node. You can preview and edit its settings in the Form editor on the left.