JBoss.orgCommunity Documentation

Chapter 9. Creating a JAIN SLEE Resource Adaptor

To create a component it may be easier (but not mandatory) to first create a package to contain it. This package should be created as a child of the <ra-module>/src/main/java folder. To do this right-click on the src folder and select NewPackage. Give the new package a name using the popup dialog (shown below).

Figure 9.1. Creating a new Package in Eclipse


In case a new package is not created at this point, it can still be created in the Component wizard, but no validation is performed at that time, regarding the package naming conventions.

To create a new JAIN SLEE Resource Adaptor, right-click on the created package (or the module entry if the package is not yet created) and choose NewOther ... as shown below.

Figure 9.2. Creating a new JAIN SLEE Component in EclipSLEE


A dialog should appear. Expand the JAIN SLEE item and choose JAIN SLEE Resource Adaptor. The dialog should now look like the following:

Figure 9.3. Creating a new JAIN SLEE Resource Adaptor in EclipSLEE


Click Next to get the following dialog:

Figure 9.4. Selecting the package and name for a new JAIN SLEE Resource Adaptor in EclipSLEE


The source folder and package dialogs will be completed if NewOther ... has been selected from right-clicking on a package. Otherwise it may need to be chosen by selecting Browse... and selecting the desired locations or typing it's name in the appropriate field and it will be created in the end.

Name the Resource Adaptor; the name must end with "ResourceAdaptor.java". Then click Next to go to the component identity dialog, pictured below:

Figure 9.5. JAIN SLEE Component Identity dialog in EclipSLEE


The Name, Vendor and Version fields are mandatory and are used by the SLEE to identify the Resource Adaptor. The description field is optional, but strongly recommended to be completed to allow easy identification of the Resource Adaptor in future.

After completing these fields click Next to specify the RA Types the Resource Adaptor implements.

Figure 9.6. JAIN SLEE Resource Adaptor RA Types selection in EclipSLEE


This dialog allows you to specify which RA Types this Resource Adaptor will implement. Select them from the top list (Available RA Types) by clicking Select RA Type. To remove them, select them from the bottom list (Selected RA Types) and click Deselect RA Type. When done, click Next to edit the Resource Adaptor Config Properties.

Figure 9.7. JAIN SLEE Resource Adaptor Config Properties definition in EclipSLEE


Here, the Resource Adaptor's Config Properties can be set. Add a Config Property field by clicking on Add and writing it's name on the Name column, selecting the appropriate Java Type in the Type column and, this is optional, type a default value (if no value is to be set, delete the default ? which is inserted) in the Default Value column.

In this same wizard page, it is possible to define whether this Resource Adaptor supports reconfiguration when in ACTIVE state by checking or leaving unchecked the This Resource Adaptor supports active reconfiguration checkbox.

Once finished, click Finish to create the Resource Adaptor Type.

Skipping optional steps

Finish can be clicked at any point after setting the Resource Adaptor's identity if a skeleton Resource Adaptor is required. It is not necessary to complete each wizard page first.

The Resource Adaptor Java file, MobicentsDemoResourceAdaptor.java (plus the remaining interfaces and classes which were selected at the wizard) is created in the specified package and opened for editing in the workspace. The ra-jar.xml deployment descriptor is updated to reflect the new ratype or created if not already present. The resulting workspace can be seen below.

Figure 9.8. JAIN SLEE Resource Adaptor created in workspace using EclipSLEE