JBoss.orgCommunity Documentation

Chapter 4. Building JAIN SLEE Events

4.1. Creating a JAIN SLEE Event
4.2. Editing a JAIN SLEE Event
4.2.1. Edit Event Identity
4.3. Deleting a JAIN SLEE Event

EclipSLEE provides means to create, edit and delete JAIN SLEE Events.

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 <event-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 4.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 Event, right-click on the created package (or the module entry if the package is not yet created) and choose NewOther ... as shown below.

Figure 4.2. Creating a new JAIN SLEE Component in EclipSLEE


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

Figure 4.3. Creating a new JAIN SLEE Event in EclipSLEE


Click Next to get the following dialog:

Figure 4.4. Selecting the package and name for a new JAIN SLEE Event 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 event; the name must end with "Event.java". Then click Next to go to the component identity dialog, pictured below:

Figure 4.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 event. The description field is optional, but strongly recommended to be completed to allow easy identification of the event in future.

After completing these fields click Finish to create the event.

The event Java file, TestEvent.java is created in the specified package and opened for editing in the workspace. The event-jar.xml deployment descriptor is updated to reflect the new event or created if not already present. The resulting workspace can be seen below.

Figure 4.6. JAIN SLEE Event created in workspace using EclipSLEE


It is possible with EclipSLEE to edit existing components. When right-clicking in one of the JAIN SLEE Event classes a similar menu should be shown:

Figure 4.7. Editing a JAIN SLEE Event through class file


It is also possible to edit by right-clicking on the event-jar.xml descriptor. In that case a sub-menu allowing to pick which Event to edit is shown:

Figure 4.8. Editing JAIN SLEE Events through XML descriptor


After selecting the desired event, the menu shown should be similar to the one presented when using the class file to edit.

The following actions are available for a JAIN SLEE Event:

With this operation it is possible to change the JAIN SLEE Event identity (name, vendor, version) and it's description. The following dialog is presented:

Figure 4.9. Editing JAIN SLEE Event Identity


Other components are not updated!

EclipSLEE does not automatically update other component descriptors in order to reflect such identity change, so it should be made manually.

It is possible with EclipSLEE to delete existing components. Right-clicking in one of the JAIN SLEE Event classes or XML descriptor file (see Section 4.2, “Editing a JAIN SLEE Event”) and selecting the Delete option.

A confirmation dialog similar to the following should be presented:

Figure 4.10. Deleting a JAIN SLEE Event confirmation dialog


Impossible to undo this operation!

Deleting a component is an irreversible operation, so it should be used carefully.