Click here to close now.




















Welcome!

Microservices Expo Authors: Liz McMillan, Elizabeth White, Carmen Gonzalez, Yeshim Deniz, Ruxit Blog

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
Puppet Labs is pleased to share the findings from our 2015 State of DevOps Survey. We have deepened our understanding of how DevOps enables IT performance and organizational performance, based on responses from more than 20,000 technical professionals we’ve surveyed over the past four years. The 2015 State of DevOps Report reveals high-performing IT organizations deploy 30x more frequently with 200x shorter lead times. They have 60x fewer failures and recover 168x faster
It’s been proven time and time again that in tech, diversity drives greater innovation, better team productivity and greater profits and market share. So what can we do in our DevOps teams to embrace diversity and help transform the culture of development and operations into a true “DevOps” team? In her session at DevOps Summit, Stefana Muller, Director, Product Management – Continuous Delivery at CA Technologies, answered that question citing examples, showing how to create opportunities for ...
To support developers and operations professionals in their push to implement DevOps principles for their infrastructure environments, ProfitBricks, a provider of cloud infrastructure, is adding support for DevOps tools Ansible and Chef. Ansible is a platform for configuring and managing data center infrastructure that combines multi-node software deployment, ad hoc task execution, and configuration management, and is used by DevOps professionals as they use its playbooks functionality to autom...
SYS-CON Events announced today that G2G3 will exhibit at SYS-CON's @DevOpsSummit Silicon Valley, which will take place on November 3–5, 2015, at the Santa Clara Convention Center in Santa Clara, CA. Based on a collective appreciation for user experience, design, and technology, G2G3 is uniquely qualified and motivated to redefine how organizations and people engage in an increasingly digital world.
All major researchers estimate there will be tens of billions devices - computers, smartphones, tablets, and sensors - connected to the Internet by 2020. This number will continue to grow at a rapid pace for the next several decades. With major technology companies and startups seriously embracing IoT strategies, now is the perfect time to attend @ThingsExpo, November 3-5, 2015, at the Santa Clara Convention Center in Santa Clara, CA. Learn what is going on, contribute to the discussions, and e...
Containers are not new, but renewed commitments to performance, flexibility, and agility have propelled them to the top of the agenda today. By working without the need for virtualization and its overhead, containers are seen as the perfect way to deploy apps and services across multiple clouds. Containers can handle anything from file types to operating systems and services, including microservices. What are microservices? Unlike what the name implies, microservices are not necessarily small,...
Whether you like it or not, DevOps is on track for a remarkable alliance with security. The SEC didn’t approve the merger. And your boss hasn’t heard anything about it. Yet, this unruly triumvirate will soon dominate and deliver DevSecOps faster, cheaper, better, and on an unprecedented scale. In his session at DevOps Summit, Frank Bunger, VP of Customer Success at ScriptRock, will discuss how this cathartic moment will propel the DevOps movement from such stuff as dreams are made on to a prac...
ElasticBox, the agile application delivery manager, announced freely available public boxes for the DevOps community. ElasticBox works with enterprises to help them deploy any application to any cloud. Public boxes are curated reference boxes that represent some of the most popular applications and tools for orchestrating deployments at scale. Boxes are an adaptive way to represent reusable infrastructure as components of code. Boxes contain scripts, variables, and metadata to automate proces...
Docker containerization is increasingly being used in production environments. How can these environments best be monitored? Monitoring Docker containers as if they are lightweight virtual machines (i.e., monitoring the host from within the container), with all the common metrics that can be captured from an operating system, is an insufficient approach. Docker containers can’t be treated as lightweight virtual machines; they must be treated as what they are: isolated processes running on hosts....
SYS-CON Events announced today that DataClear Inc. will exhibit at the 17th International Cloud Expo®, which will take place on November 3–5, 2015, at the Santa Clara Convention Center in Santa Clara, CA. The DataClear ‘BlackBox’ is the only solution that moves your PC, browsing and data out of the United States and away from prying (and spying) eyes. Its solution automatically builds you a clean, on-demand, virus free, new virtual cloud based PC outside of the United States, and wipes it clean...
SYS-CON Events announced today that HPM Networks will exhibit at the 17th International Cloud Expo®, which will take place on November 3–5, 2015, at the Santa Clara Convention Center in Santa Clara, CA. For 20 years, HPM Networks has been integrating technology solutions that solve complex business challenges. HPM Networks has designed solutions for both SMB and enterprise customers throughout the San Francisco Bay Area.
SYS-CON Events announced today the Containers & Microservices Bootcamp, being held November 3-4, 2015, in conjunction with 17th Cloud Expo, @ThingsExpo, and @DevOpsSummit at the Santa Clara Convention Center in Santa Clara, CA. This is your chance to get started with the latest technology in the industry. Combined with real-world scenarios and use cases, the Containers and Microservices Bootcamp, led by Janakiram MSV, a Microsoft Regional Director, will include presentations as well as hands-on...
Microservice architecture is fast becoming a go-to solution for enterprise applications, but it's not always easy to make the transition from an established, monolithic infrastructure. Lightweight and loosely coupled, building a set of microservices is arguably more difficult than building a monolithic application. However, once established, microservices offer a series of advantages over traditional architectures as deployment times become shorter and iterating becomes easier.
The pricing of tools or licenses for log aggregation can have a significant effect on organizational culture and the collaboration between Dev and Ops teams. Modern tools for log aggregation (of which Logentries is one example) can be hugely enabling for DevOps approaches to building and operating business-critical software systems. However, the pricing of an aggregated logging solution can affect the adoption of modern logging techniques, as well as organizational capabilities and cross-team ...
Puppet Labs has announced the next major update to its flagship product: Puppet Enterprise 2015.2. This release includes new features providing DevOps teams with clarity, simplicity and additional management capabilities, including an all-new user interface, an interactive graph for visualizing infrastructure code, a new unified agent and broader infrastructure support.
SYS-CON Events announced today that Pythian, a global IT services company specializing in helping companies leverage disruptive technologies to optimize revenue-generating systems, has been named “Bronze Sponsor” of SYS-CON's 17th Cloud Expo, which will take place on November 3–5, 2015, at the Santa Clara Convention Center in Santa Clara, CA. Founded in 1997, Pythian is a global IT services company that helps companies compete by adopting disruptive technologies such as cloud, Big Data, advance...
In today's digital world, change is the one constant. Disruptive innovations like cloud, mobility, social media, and the Internet of Things have reshaped the market and set new standards in customer expectations. To remain competitive, businesses must tap the potential of emerging technologies and markets through the rapid release of new products and services. However, the rigid and siloed structures of traditional IT platforms and processes are slowing them down – resulting in lengthy delivery ...
The web app is agile. The REST API is agile. The testing and planning are agile. But alas, data infrastructures certainly are not. Once an application matures, changing the shape or indexing scheme of data often forces at best a top down planning exercise and at worst includes schema changes that force downtime. The time has come for a new approach that fundamentally advances the agility of distributed data infrastructures. Come learn about a new solution to the problems faced by software organ...
Any Ops team trying to support a company in today’s cloud-connected world knows that a new way of thinking is required – one just as dramatic than the shift from Ops to DevOps. The diversity of modern operations requires teams to focus their impact on breadth vs. depth. In his session at DevOps Summit, Adam Serediuk, Director of Operations at xMatters, Inc., will discuss the strategic requirements of evolving from Ops to DevOps, and why modern Operations has begun leveraging the “NoOps” approa...
17th Cloud Expo, taking place Nov 3-5, 2015, at the Santa Clara Convention Center in Santa Clara, CA, will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud strategy. Meanwhile, 94% of enterprises ar...