Trouble understanding the whole OSGi web eco system

Jens picture Jens · Apr 2, 2010 · Viewed 8.5k times · Source

I am pretty new to the whole Java and OSGi world and I have trouble understanding the eco system of a OSGi web application.

To be more precise I am at the moment trying to understand how all the parts of the eco system are related to each other:

  • OSGi Framework (e.g. Apache Felix, Equinox, Knoplerfish)
  • OSGi Runtime (e.g. Spring DM Server, Pax Runner, Apache Karaf)
  • Web Extender (e.g. Pax Web Extender, Spring Web Extender)
  • Web Container (e.g. Apache Tomcat, Jetty)

To give you a visual representation of my actual understanding of their relationship check out this image:

alt text

As far as I know the OSGi Framework is a implementation of the OSGi specification. The runtime is a distribution which adds additional functionality on top of the OSGi specification like logging for instance. Since there seem to be some differences in the classpath mechanism of OSGi and web containers like Tomcat you need some kind of translator. This part is handled by the "Web Extender".

Would you please clarify this whole thing for me? Am I understanding everything correct?

Answer

Alexander Torstling picture Alexander Torstling · Apr 2, 2010

OSGi is a standard in terms of API and packaging for interacting software modules. This is similar to other API standards like JPA or Java EE.

An OSGi runtime is a server which follows the OSGi standard, it is an implementation of the standard. You mention some common ones: Knopflerfish, Eqinox. These let you run OSGi bundles.

A web container usually refers to an implementation of the web-specific parts of Java EE (servlets). The servlet standard also defines an API and packaging, just like OSGi, only different.

You need a server to run your Java EE web apps. You package your app as a Java Web Archive (WAR), and ask your application server to start it. There are several servers, as you mention, like Tomcat, Jetty, but also bigger servers which cover larger parts of the Java EE standard, like Glassfish and JBoss.

A web extender tries to unify the servlet standard with OSGi. By adding some OSGi-specific data to your already packaged WAR, the WAR will be automatically parsed and started by your OSGi runtime. Your WAR servlets will be published to the OSGi http service by the web extender. With a web extender, you can run both standard OSGi applications as well as WARs using only a OSGi runtime, without the need for a Java EE-compliant server like Tomcat.