Provides a specification of java based annotations to generate deployment descriptors for the JAIN SLEE JSR240.
Using annotations rapidly speeds up development times of JAIN SLEE resource adaptors and services. They can be supported by the JAIN SLEE container explicitly or you can use a post processor to generate the deployment descriptors.
In this technical article I will show you how to use the annotations and compile your project using the Mofokom standalone annotation processor to generate deployment descriptor.
Later I will show you how to use the AspectJ compiler to modify your compiled classes to get member field injection of contexts, jndi, env entries, config properties, child relations and annotation based alarm raising and clearing and transaction rolback.
First step is to add the correct dependencies and plugins to your maven project and configure your container.
javax.slee jain-slee-annotations 1.0 mofokom slee-annotation-processor 1.0... mofokom-public mofokom-public http://www.mofokom.mobi/maven/releases-public
Then include the generated deployment descriptors to the projects target classes directory.
true ${basedir}/target/generated-sources/annotations true ${basedir}/src/main/resourcesThe plugin is just the standard maven compiler plugin which executes the Javac annotation processor. Note that this one uses the xalan xslt libraries to avoid problems with different versions of java and xml apis.
org.apache.maven.plugins maven-compiler-plugin 2.3.2 generate generate-resources compileThen we can get to coding with annotations for example to create a JAIN SLEE event type.
@EventType(name=ExampleEvent.EVENT_TYPE_NAME, vendor=ExampleEvent.EVENT_TYPE_VENDOR, version=ExampleEvent.EVENT_TYPE_VERSION, libraryRefs={@LibraryRef(name="ExampleLibrary",vendor="ISV1",version="1.0"), @LibraryRef(name="ExampleLibrary2",vendor="ISV1",version="1.0")}) public class ExampleEvent {
And to have a sbb which will handle the event
@Service(name = "CompleteExampleService", vendor = "ISV1", version = "1.0", rootSbb = CompleteExampleAnnotatedSbb.class) @Reentrant @Sbb(id = "mysbb", name = "CompleteExampleAnnotatedSbb", vendor = "ISV1", version = "1.0", localInterface = ExampleSbbLocalObject.class, activityContextInterface = ExampleSbbActivityContextInterface.class, sbbRefs = { @SbbRef(name = "SimpleExampleAnnotatedSbb", vendor = "ISV1", version = "1.0", alias = "SimpleSbb")}, SecurityPermissions = Sbb.ALL_PERMISSIONS) public abstract class CompleteExampleAnnotatedSbb implements javax.slee.Sbb {
It could be handled by an initial event selector method.
@InitialEventSelectorMethod({ @EventTypeRef(name = ExampleEvent.EVENT_TYPE_NAME, vendor = ExampleEvent.EVENT_TYPE_VENDOR, version = ExampleEvent.EVENT_TYPE_VERSION)}) public InitialEventSelector ies(InitialEventSelector ies) { return ies; }
or a standard event handler method
@EventHandler(initialEvent = true, eventType = @EventTypeRef(name = ExampleEvent.EVENT_TYPE_NAME, vendor = ExampleEvent.EVENT_TYPE_VENDOR, version = ExampleEvent.EVENT_TYPE_VERSION)) public void onExampleEvent(ExampleEvent event, ActivityContextInterface aci) {
Once you compile inspect the plugins output in
target/generated-sources/annotations/META-INF/event-jar.xml
and
target/generated-sources/annotations/META-INF/sbb-jar.xml
Notice how each element has an id as per xml spec. This is for container specific references or further processing.
Now to go one step further “inject” fields (well it's really only compile time weaving) into your SLEE component use the standard @javax.Resource annotation.
Depending on the container you are using you need to add the aspectj-rt to the mobicents - copy the aspectj-rt-1.7.jar into the server/default/mobicents/lib directory
opencloud - copy the aspectj-rt-1.7.jar into the RhinoSDK/lib/ext
For example you can now inject some SLEE particles
@Resource(name = "Sbb Tracer") private Tracer tracer;
Or inject other JNDI resources
@Resource private SbbContext sbbContext; @Resource(name = "ExampleAnnotatedResourceAdaptor Entity Link") private ExampleResourceAdaptorSbbInterface raSbbInterface; @Resource(mappedName = "slee/resources/http/activitycontextinterfacefactory") private ExampleActivityContextInterfaceFactory activityContextInterfaceFactory; @Resource private InitialContext context;
Then compile with the AspectJ plugin in your maven pom.
org.codehaus.mojo aspectj-maven-plugin 1.4 trueInspect the generated aspects to see what code modifications were made to your classes.
./examples/target/generated-sources/annotations/ExampleAnnotatedResourceAdaptor$SleeAnnotationsAspect.aj
./examples/target/generated-sources/annotations/SimpleExampleAnnotatedSbb$SleeAnnotationsAspect.aj
./examples/target/generated-sources/annotations/CompleteExampleAnnotatedSbb$SleeAnnotationsAspect.aj
./examples/target/generated-sources/annotations/CompleteExampleAnnotatedProfile$SleeAnnotationsAspect.aj
For further documentation see the following.
http://java.net/projects/slee-annotations
sources are available here
https://svn.java.net/svn/slee-annotations~jain-slee-annotations-svn
mailto:commits@slee-annotations.java.net
mailto:jain-slee-annotations@slee-annotations.java.net
Maven artifacts i.e sources,binaries, javadoc hosted here
http://mofokom.mobi/site/jain-slee-annotations
Mofokom slee annotation processor is here
http://www.mofokom.mobi/artifactory/releases-public/mofokom/slee-annotation-processor/1.0/
Full example source code (initially from mobicents project) utilizing all known annotations and injections - please report bugs with this test case.