Click here to close now.

Welcome!

MICROSERVICES Authors: David Sprott, Lori MacVittie, Carmen Gonzalez, Michael Kanasoot, Elizabeth White

Related Topics: MICROSERVICES, Java, XML, AJAX & REA

MICROSERVICES: Article

The OSGi puzzle

Let's discover the OSGi architecture.

OSGi became very popular thanks to its modularity approach and its ability to enforce logical boundaries between modules. When we discover it the first time, the question is where to begin to understand how it works?

To understand OSGi concepts we will try to follow the puzzle approach. The idea is to begin with the trivial part of this technology, and search for other parts related to the found ones. And to assemble the puzzle we will be assisted by JArchitect that will be helpful to detect OSGi internal design.

To be more concrete we analyze with JArchitect an application using OSGi technology, it concern the famous eclipse IDE which use the OSGi container equinox.



Let's begin with the typical OSGi definition:

OSGi reduces complexity by providing a modular architecture for today's large-scale distributed systems as well as small, embedded applications. Building systems from in-house and off-the-shelf modules significantly reduces complexity and thus development and maintenance expenses. The OSGi programming model realizes the promise of component-based systems.

The trivial part of OSGi is modularity, let's discover what's the OSGi modules

OSGI modules are called Bundles and every application therefore consist of at least one bundle.

These bundles are executed inside a container, and as each modular approach where a container manage the modules, the question is which contract must implement every module to be intergated into the container?

Let's take as example the bundle org.eclipse.equinox.jsp.jasper and search for all its implemented interfaces, for that we can execute the following CQLinq request:

from t in Types where t.ParentProject.Name=="org.eclipse.equinox.jsp.jasper_1.0.300.v20110502" let interfaces=t.InterfacesImplemented from i in interfaces select i



The BundleActivator interface from OSGi package is implemented, this interface contains two methods start and stop useful to customizes the starting and stopping of the bundle.

Manifest-Version: 1.0

Bundle-Localization: plugin

Bundle-RequiredExecutionEnvironment: CDC-1.0/Foundation-1.0,J2SE-1.3

Bundle-SymbolicName: org.eclipse.equinox.jsp.jasper

Eclipse-LazyStart: true

Eclipse-SourceReferences: scm:cvs:pserver:dev.eclipse.org:/cvsroot/rt:

 org.eclipse.equinox/server-side/bundles/org.eclipse.equinox.jsp.jaspe

 r;tag=v20110502

Bundle-Activator: org.eclipse.equinox.internal.jsp.jasper.Activator


Another specificity of a bundle is its manifest file, here's a part from the org.eclipse.equinox.jsp.jasper manifest file:

Manifest-Version: 1.0

Bundle-Localization: plugin

Bundle-RequiredExecutionEnvironment: CDC-1.0/Foundation-1.0,J2SE-1.3

Bundle-SymbolicName: org.eclipse.equinox.jsp.jasper

Eclipse-LazyStart: true

Eclipse-SourceReferences: scm:cvs:pserver:dev.eclipse.org:/cvsroot/rt:

 org.eclipse.equinox/server-side/bundles/org.eclipse.equinox.jsp.jaspe

 r;tag=v20110502

Bundle-Activator: org.eclipse.equinox.internal.jsp.jasper.Activator

As we can observe this manifest contains some meta informations needed by the container, like specifying the bundle activator class which implements the BundleActivator interface.

The bundle represent our first piece of the puzzle,and here's a simplified representation of a bundle:



And just to have an idea of all bundles used by eclipse, let's search for all classes implementing BundleActivator interface.

from t in Types where t.Implement ("org.osgi.framework.BundleActivator") select new { t, t.NbBCInstructions }



Who manage the bundle and invoke BundleActivator methods?

To discover that let's search for methods invoking directly or indirectly BundleActivator.start

from m in Methods let depth0 = m.DepthOfIsUsing ("org.eclipse.osgi.framework.internal.core.BundleContextImpl.startActivator(BundleActivator)") where depth0 >= 0 orderby depth0 select new { m, depth0 }



The bundle is activated by the OSGi framework when it's launched. the framework class is started by the equinox container. And to understand better what happen when the container start, here are some actions executed when the container is launched:



When the container is launched, it initialize the OSGi framework, the framework gets all installed bundles, and for each one it create an instance of BundleHost class, and store into a repository the found bundle.

The BundleHost class implement the Bundle interface, which contains methods like start,stop,uninstall and update, these methods are needed to manage the bundle life cycle.

So our second puzzle piece is The OSGi container, it's launched by the Equinoxlauncher, which initialise the framework. The framework class is responsible of loading bundles and activate them.

After discovering some basic concepts about bundle and container, let's go deep inside bundles and discover how they works internally.

Let's take as example the org.eclipse.equinox.http.servlet bundle and search for methods invoked by the start method of its Activator class.



This bundle create a service and register it into the container. A service in OSGi is defined by a standard Java class or interface. Typically a Java interface is used to define the service interface. The service is the preferred method bundles should use to communicate between each other.

Here are some useful scenarios of using services:

  • Export functionality from a bundle to other bundles.
  • Import functionality from other bundles.
  • Register listeners for events from other bundles.


Another remark from the previous dependecy graph is that a service factory is used to create the service instance.

Our third piece of the puzzle is the OSGi services layer, each bundle can use or declare some services , what enforce the component design approach, here's the new representation of the OSGi bundle.



If The bundle use services to communicate with other bundles, how it communicate with other jars?

If we develop a bundle and try to use a class from another jar, we can be surprised that it will not works as expected, the reason is that the ClassLoader is hooked by the OSGi container, to check that let's search which method invoke java.lang.Thread.setContextClassLoader.

from m in Methods where m.IsUsing ("java.lang.Thread.setContextClassLoader(ClassLoader)") select new { m, m.NbBCInstructions }



Many methods invoke it including the EquinoxLauncher. so every time the bundle try to create a class instance, the OSGi container will check if the code is permited to did this action or not, and here come the role of imported and exported package in the manifest file.

Export-Package: org.eclipse.equinox.http.servlet;version="1.1.0"



Import-Package: javax.servlet;version="2.3",javax.servlet.http;version

 ="2.3",org.osgi.framework;version="1.3.0",org.osgi.service.http;versi

 on="[1.2,1.3)" 



The bundle declare explicitly exported and imported package, and to check that , let's search for packages used by org.eclipse.equinox.http.servlet bundle and verify if it use only package imported.

from n in Packages where n.IsUsedBy ("org.eclipse.equinox.http.servlet_1.1.200.v20110502") select new { n, n.NbBCInstructions }



As we can observe all packages used are specified in the manifest file , in the import package section.
The exported package however represent the package that can be used from other bundles. it's represented by the ExportedPackage interface, and we can search for the container classes using this interface.

from t in Types where t.IsUsing ("org.osgi.service.packageadmin.ExportedPackage") select new { t, t.NbBCInstructions }



What interesting with this new capability, is that the bundle will have a well defined boundary, and what it use and what it expose as services is very well specified.

We can enforce the check of using imported packages by using other tools, for example with CQLinq we can write some rules warning each time a project use packages other than specified ones, but it's better to have this check in the execution environement, so the developer can't break this rules.

This capability to treat imported and exported packages is managed by the OSGi modules layer and it was our fourth piece of the puzzle.

Let's come back to the OSGi container and discover which services it provides?

Container services

As we discoverd before the container is launched by the EquinoxLauncher class and the framework class initialise and launch the bundles, to detect which services re provided let's search for all classes used in the framework initalisation method.
from t in Types where t.IsUsedBy ("org.eclipse.osgi.framework.internal.core.Framework.initialize(FrameworkAdaptor)") select new { t, t.NbBCInstructions }

Some classes are already discovered before like BundleRepository,BundleHost,PackageAdminImpl and ServiceRegistry.

What about the other classes:

  • StartLevelManager: Each OSGi Bundle is associated with a start level that enable the server to control the relative starting and stopping order of bundles. Only bundles that have a start level less or equal to the active start level of the server framework must be active. Usually, a bundle with a smaller start level tend to be started earlier.
  • SecurityAdmin: The security layer handles the security aspects by limiting bundle functionality to pre-defined capabilities.
  • EventManager: The Event Admin service provides a publish-subscribe model for handling events. It is realized according to the OSGi Event Admin Service Specification. The Event Admin service dispatches events between Event Publishers and Event Subscribers (Event Handlers) by interposing an event channel. Publishers post events to the channel and the event channel defines which handlers needs to be notified. Thus publishers and handlers have no direct knowledge of each other, which simplifies event management.


The OSGi whole picture
Let's assemble all puzzle pieces described before , and we will have the following OSGi picture:


This architecture has the following interesting benefits:

  • Simple.
  • Reduced Complexity.
  • Easy Deployment.
  • Secure.


What makes it very attractif and Worth a Detour, and you will not waste your time if you study it in depth.

More Stories By Lahlali Issam

Lahlali Issam Lead Developer at JavaDepend, a tool to manage and understand complex Java code. With JavaDepend, software quality can be measured using Code Metrics, visualized using Graphs and Treemaps, and queried using CQL language, a SQL like to query the code base.

@MicroservicesExpo Stories
Cloud computing is changing the way we look at IT costs, according to industry experts on a recent Cloud Luminary Fireside Chat panel discussion. Enterprise IT, traditionally viewed as a cost center, now plays a central role in the delivery of software-driven goods and services. Therefore, companies need to understand their cloud utilization and resulting costs in order to ensure profitability on their business offerings. Led by Bernard Golden, this fireside chat offers valuable insights on ho...
Microservices, for the uninitiated, are essentially the decomposition of applications into multiple services. This decomposition is often based on functional lines, with related functions being grouped together into a service. While this may sound a like SOA, it really isn't, especially given that SOA was an object-centered methodology that focused on creating services around "nouns" like customer and product. Microservices, while certainly capable of being noun-based, are just as likely to be v...
SYS-CON Events announced today the DevOps Foundation Certification Course, being held June ?, 2015, in conjunction with DevOps Summit and 16th Cloud Expo at the Javits Center in New York City, NY. This sixteen (16) hour course provides an introduction to DevOps – the cultural and professional movement that stresses communication, collaboration, integration and automation in order to improve the flow of work between software developers and IT operations professionals. Improved workflows will res...
Chef and Canonical announced a partnership to integrate and distribute Chef with Ubuntu. Canonical is integrating the Chef automation platform with Canonical's Machine-As-A-Service (MAAS), enabling users to automate the provisioning, configuration and deployment of bare metal compute resources in the data center. Canonical is packaging Chef 12 server in upcoming distributions of its Ubuntu open source operating system and will provide commercial support for Chef within its user base.
You hear the terms “subscription economy” and “subscription commerce” all the time. And with good reason. Subscription-based monetization is transforming business as we know it. But what about usage? Where’s the “consumption economy”? Turns out, it’s all around us. When most people think of usage-based billing, the example that probably comes to mind first is metered public utilities — water, gas and electric. Phone services, especially mobile, might come next. Then maybe taxis. And that’s ab...
Learn the top API testing issues that organizations encounter and how automation plus a DevOps team approach can address these top API testing challenges. Ensuring API integrity is difficult in today's complex application cloud, on-premises and hybrid environment scenarios. In this interview with TechTarget, Parasoft solution architect manager Spencer Debrosse shares his experiences about the top API testing issues that organizations encounter and how automation and a DevOps team approach can a...
Containers and microservices have become topics of intense interest throughout the cloud developer and enterprise IT communities. Accordingly, attendees at the upcoming 16th Cloud Expo at the Javits Center in New York June 9-11 will find fresh new content in a new track called PaaS | Containers & Microservices Containers are not being considered for the first time by the cloud community, but a current era of re-consideration has pushed them to the top of the cloud agenda. With the launch ...
An explosive combination of technology trends will be where ‘microservices’ and the IoT Internet of Things intersect, a concept we can describe by comparing it with a previous theme, the ‘X Internet.' The idea of using small self-contained application components has been popular since XML Web services began and a distributed computing future of smart fridges and kettles was imagined long back in the early Internet years.
After what feel like an interminable cycle of media frenzy followed by hype and hysteria cycles, the practical elements of real world cloud implementations are starting to become better documented. But what is really different in the cloud? How do software applications behave, live, interact and interconnect inside the cloud? Where do cloud architectures differ so markedly from their predecessors that we need to learn a new set of mechanics – and, when do we start to refer to software progra...
SOA Software has changed its name to Akana. With roots in Web Services and SOA Governance, Akana has established itself as a leader in API Management and is expanding into cloud integration as an alternative to the traditional heavyweight enterprise service bus (ESB). The company recently announced that it achieved more than 90% year-over-year growth. As Akana, the company now addresses the evolution and diversification of SOA, unifying security, management, and DevOps across SOA, APIs, microser...
It's 2:15pm on a Friday, and I'm sitting in the keynote hall at PyCon 2013 fidgeting through a succession of lightning talks that have very little relevance to my life. Topics like "Python code coverage techniques" (ho-hum) and "Controlling Christmas lights with Python” (yawn - I wonder if there's anything new on Hacker News)...when Solomon Hykes takes the stage, unveils Docker, and the world shifts. If you haven't seen it yet, you should watch the video of Solomon's Pycon The Future of Linux C...
This month I want to revisit supporting infrastructure and datacenter environments. I have touched (some would say rant) upon this topic since my post in April 2014 called "Take a Holistic View of Support". My thoughts and views on this topic have not changed at all: it's critical for any organization to have a holistic, comprehensive strategy and view of how they support their IT infrastructure and datacenter environments. In fact, I believe it's even more critical today then it was a year ago ...
The 16th Cloud Expo has added coverage containers and microservices to its program for New York, to be held June 9-11 at the Jacob Javits Convention Center. Cloud Expo has long been the single, independent show where delegates and technology vendors can meet to experience and discuss the entire world of the cloud. This year will be no different. Containers are an old concept that saw renewed life with the emergence of Docker in 2013. Then late in 2014, CoreOS shook up the cloud-computing w...
OmniTI has expanded its services to help customers automate their processes to deliver high quality applications to market faster. Consistent with its focus on IT agility and quality, OmniTI operates under DevOps principles, exploring the flow of value through the IT delivery process, identifying opportunities to eliminate waste, realign misaligned incentives, and open bottlenecks. OmniTI takes a unique, value-centric approach by plotting each opportunity in an effort-payoff quadrant, then work...
SYS-CON Events announced today that Solgenia will exhibit at SYS-CON's 16th International Cloud Expo®, which will take place on June 9-11, 2015, at the Javits Center in New York City, NY, and the 17th International Cloud Expo®, which will take place on November 3–5, 2015, at the Santa Clara Convention Center in Santa Clara, CA. Solgenia is the global market leader in Cloud Collaboration and Cloud Infrastructure software solutions. Designed to “Bridge the Gap” between Personal and Professional S...
SYS-CON Events announced today that MangoApps will exhibit at SYS-CON's 16th International Cloud Expo®, which will take place on June 9-11, 2015, at the Javits Center in New York City, NY., and the 17th International Cloud Expo®, which will take place on November 3–5, 2015, at the Santa Clara Convention Center in Santa Clara, CA. MangoApps provides private all-in-one social intranets allowing workers to securely collaborate from anywhere in the world and from any device. Social, mobile, and eas...
When it comes to microservices there are myths and uncertainty about the journey ahead. Deploying a “Hello World” app on Docker is a long way from making microservices work in real enterprises with large applications, complex environments and existing organizational structures. February 19, 2015 10:00am PT / 1:00pm ET → 45 Minutes Join our four experts: Special host Gene Kim, Gary Gruver, Randy Shoup and XebiaLabs’ Andrew Phillips as they explore the realities of microservices in today’s IT worl...
The world's leading Cloud event, Cloud Expo has launched Microservices Journal on the SYS-CON.com portal, featuring over 19,000 original articles, news stories, features, and blog entries. DevOps Journal is focused on this critical enterprise IT topic in the world of cloud computing. Microservices Journal offers top articles, news stories, and blog posts from the world's well-known experts and guarantees better exposure for its authors than any other publication. Follow new article posts on T...
Hosted PaaS providers have given independent developers and startups huge advantages in efficiency and reduced time-to-market over their more process-bound counterparts in enterprises. Software frameworks are now available that allow enterprise IT departments to provide these same advantages for developers in their own organization. In his workshop session at DevOps Summit, Troy Topnik, ActiveState’s Technical Product Manager, will show how on-prem or cloud-hosted Private PaaS can enable organ...
Even though it’s now Microservices Journal, long-time fans of SOA World Magazine can take comfort in the fact that the URL – soa.sys-con.com – remains unchanged. And that’s no mistake, as microservices are really nothing more than a new and improved take on the Service-Oriented Architecture (SOA) best practices we struggled to hammer out over the last decade. Skeptics, however, might say that this change is nothing more than an exercise in buzzword-hopping. SOA is passé, and now that people are ...