Few days ago, new milestone 3.0.0.M03 of Eclipse Virgo was released. Final release of this well prepared OSGi-based application Server getting closer so I decided to take a look at how to use it to write simple modular web application.
What does it mean a modular web application in OSGi environment? I imagine that this application should:
1) Change their look after installation of some extensions.
2) Also we should be able to write new request handlers for our application or modify flow control of existed.
First idea which occurred to me how to resolve first mentioned problem is to use fragment bundles mechanism. Fragment bundles give opportunity to create bundles with resources and classes which will be accessible from host bundle classloader. A key use case of its was “providing translation files for different locales“. So we can do few fragments with jsp files which should be able to include in index servlet page. Also we can provide some configuration files with class names of new request handlers which could be created using java reflection.
But fragment bundles have some disadvantages. How we can read in specification: “The new content of the updated fragment must not be allowed to attach to the host bundles until the Framework is restarted or the host bundle is refreshed“. This mean that we cannot do installation of extention without refreshing host bundle. Also new jsps must be compiled as a part of host application’s jsps so it is second reason why host bundle should be restarted. The last thing is that fragment bundles can’t have Bundle Activator which is also useful in many cases.
Eclipse Virgo gives component which resolves this problems – Virgo Snaps. It is easy in use extension which helps create modular web application framework. Sources are available here
After build of project and copy artifacts to virgo:
cd build-snaps
ant jar
cd ..
cp org.eclipse.virgo.snaps.api/target/artifacts/org.eclipse.virgo.snaps.api.jar ${virgo.home}/repository/usr/
cp org.eclipse.virgo.snaps.core/target/artifacts/org.eclipse.virgo.snaps.core.jar ${virgo.home}/repository/usr/
… and restart of server, we are ready to use snaps.
In samples dir there is example menu-bar showing idea of Snaps. In host bundle – animal.menu.bar we can see in top.jsp usage of taglib snaps:
- “> ${snap.properties[‘link.text’]}
It is simple way to iterate through snaps associated with this host. Only thing which we must to do is to add this snippet to MANIFEST.MF:
Snap-Host: animal.menu.bar;version="[1.0, 2.0)"
Snap-ContextPath: /cat
In first line we are manifesting that this snap will be used as a part of host animal.menu.bar. In the second that all servlets will be deployed in this subcontext of context of host.
In this example also were used properties from file snap.properties which are available in session as attribute properties of snap.
After install host bundle at url: http://localhost:8080/animal-menu-bar we can see page without menu items. After installation of new items are become available.
