Welcome!

Microservices Expo Authors: Anders Wallgren, Liz McMillan, AppDynamics Blog, Automic Blog, Jason Bloomberg

Related Topics: Microservices Expo, Java IoT, Industrial IoT, IoT User Interface

Microservices Expo: 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
If there is anything we have learned by now, is that every business paves their own unique path for releasing software- every pipeline, implementation and practices are a bit different, and DevOps comes in all shapes and sizes. Software delivery practices are often comprised of set of several complementing (or even competing) methodologies – such as leveraging Agile, DevOps and even a mix of ITIL, to create the combination that’s most suitable for your organization and that maximize your busines...
In the world of DevOps there are ‘known good practices’ – aka ‘patterns’ – and ‘known bad practices’ – aka ‘anti-patterns.' Many of these patterns and anti-patterns have been developed from real world experience, especially by the early adopters of DevOps theory; but many are more feasible in theory than in practice, especially for more recent entrants to the DevOps scene. In this power panel at @DevOpsSummit at 18th Cloud Expo, moderated by DevOps Conference Chair Andi Mann, panelists will dis...
In a crowded world of popular computer languages, platforms and ecosystems, Node.js is one of the hottest. According to w3techs.com, Node.js usage has gone up 241 percent in the last year alone. Retailers have taken notice and are implementing it on many levels. I am going to share the basics of Node.js, and discuss why retailers are using it to reduce page load times and improve server efficiency. I’ll talk about similar developments such as Docker and microservices, and look at several compani...
The goal of any tech business worth its salt is to provide the best product or service to its clients in the most efficient and cost-effective way possible. This is just as true in the development of software products as it is in other product design services. Microservices, an app architecture style that leans mostly on independent, self-contained programs, are quickly becoming the new norm, so to speak. With this change comes a declining reliance on older SOAs like COBRA, a push toward more s...
From the conception of Docker containers to the unfolding microservices revolution we see today, here is a brief history of what I like to call 'containerology'. In 2013, we were solidly in the monolithic application era. I had noticed that a growing amount of effort was going into deploying and configuring applications. As applications had grown in complexity and interdependency over the years, the effort to install and configure them was becoming significant. But the road did not end with a ...
Many private cloud projects were built to deliver self-service access to development and test resources. While those clouds delivered faster access to resources, they lacked visibility, control and security needed for production deployments. In their session at 18th Cloud Expo, Steve Anderson, Product Manager at BMC Software, and Rick Lefort, Principal Technical Marketing Consultant at BMC Software, will discuss how a cloud designed for production operations not only helps accelerate developer...
I have an article in the recently released “DZone Guide to Building and Deploying Applications on the Cloud” entitled “Fullstack Engineering in the Age of Hybrid Cloud”. In this article I discuss the need and skills of a Fullstack Engineer with relation to troubleshooting and repairing complex, distributed hybrid cloud applications. My recent experiences with troubleshooting issues with my Docker WordPress container only reinforce the details I wrote about in this piece. Without my comprehensive...
Digital means customer preferences and behavior are driving enterprise technology decisions to be sure, but let’s not forget our employees. After all, when we say customer, we mean customer writ large, including partners, supply chain participants, and yes, those salaried denizens whose daily labor forms the cornerstone of the enterprise. While your customers bask in the warm rays of your digital efforts, are your employees toiling away in the dark recesses of your enterprise, pecking data into...
Admittedly, two years ago I was a bulk contributor to the DevOps noise with conversations rooted in the movement around culture, principles, and goals. And while all of these elements of DevOps environments are important, I’ve found that the biggest challenge now is a lack of understanding as to why DevOps is beneficial. It’s getting the wheels going, or just taking the next step. The best way to start on the road to change is to take a look at the companies that have already made great headway ...
Small teams are more effective. The general agreement is that anything from 5 to 12 is the 'right' small. But of course small teams will also have 'small' throughput - relatively speaking. So if your demand is X and the throughput of a small team is X/10, you probably need 10 teams to meet that demand. But more teams also mean more effort to coordinate and align their efforts in the same direction. So, the challenge is how to harness the power of small teams and yet orchestrate multiples of them...
Much of the value of DevOps comes from a (renewed) focus on measurement, sharing, and continuous feedback loops. In increasingly complex DevOps workflows and environments, and especially in larger, regulated, or more crystallized organizations, these core concepts become even more critical. In his session at @DevOpsSummit at 18th Cloud Expo, Andi Mann, Chief Technology Advocate at Splunk, will show how, by focusing on 'metrics that matter,' you can provide objective, transparent, and meaningfu...
You deployed your app with the Bluemix PaaS and it's gaining some serious traction, so it's time to make some tweaks. Did you design your application in a way that it can scale in the cloud? Were you even thinking about the cloud when you built the app? If not, chances are your app is going to break. Check out this webcast to learn various techniques for designing applications that will scale successfully in Bluemix, for the confidence you need to take your apps to the next level and beyond.
SYS-CON Events announced today that Peak 10, Inc., a national IT infrastructure and cloud services provider, will exhibit at SYS-CON's 18th International Cloud Expo®, which will take place on June 7-9, 2016, at the Javits Center in New York City, NY. Peak 10 provides reliable, tailored data center and network services, cloud and managed services. Its solutions are designed to scale and adapt to customers’ changing business needs, enabling them to lower costs, improve performance and focus inter...
With DevOps becoming more well-known and established practice in nearly every industry that delivers software, it is important to continually reassess its efficacy. This week’s top 10 includes a discussion on how the quick uptake of DevOps adoption in the enterprise has posed some serious challenges. Additionally, organizations who have taken the DevOps plunge must find ways to find, hire and keep their DevOps talent in order to keep the machine running smoothly.
Wow, if you ever wanted to learn about Rugged DevOps (some call it DevSecOps), sit down for a spell with Shannon Lietz, Ian Allison and Scott Kennedy from Intuit. We discussed a number of important topics including internal war games, culture hacking, gamification of Rugged DevOps and starting as a small team. There are 100 gold nuggets in this conversation for novices and experts alike.
The notion of customer journeys, of course, are central to the digital marketer’s playbook. Clearly, enterprises should focus their digital efforts on such journeys, as they represent customer interactions over time. But making customer journeys the centerpiece of the enterprise architecture, however, leaves more questions than answers. The challenge arises when EAs consider the context of the customer journey in the overall architecture as well as the architectural elements that make up each...
Much of the discussion around cloud DevOps focuses on the speed with which companies need to get new code into production. This focus is important – because in an increasingly digital marketplace, new code enables new value propositions. New code is also often essential for maintaining competitive parity with market innovators. But new code doesn’t just have to deliver the functionality the business requires. It also has to behave well because the behavior of code in the cloud affects performan...
In 2006, Martin Fowler posted his now famous essay on Continuous Integration. Looking back, what seemed revolutionary, radical or just plain crazy is now common, pedestrian and "just what you do." I love it. Back then, building and releasing software was a real pain. Integration was something you did at the end, after code complete, and we didn't know how long it would take. Some people may recall how we, as an industry, spent a massive amount of time integrating code from one team with another...
As the software delivery industry continues to evolve and mature, the challenge of managing the growing list of the tools and processes becomes more daunting every day. Today, Application Lifecycle Management (ALM) platforms are proving most valuable by providing the governance, management and coordination for every stage of development, deployment and release. Recently, I spoke with Madison Moore at SD Times about the changing market and where ALM is headed.
Struggling to keep up with increasing application demand? Learn how Platform as a Service (PaaS) can streamline application development processes and make resource management easy.