Welcome!

Microservices Expo Authors: Dan Blacharski, Elizabeth White, XebiaLabs Blog, Kong Yang, Carmen Gonzalez

Related Topics: Java IoT, Industrial IoT, Mobile IoT, Microservices Expo, IBM Cloud, Weblogic, Machine Learning

Java IoT: Article

Component Models in Java | Part 2

OSGi Component Model

OSGi is the latest component model to join the bandwagon of component models, which provides a platform for component oriented development and assembly. OSGi framework is a standards based platform whose specifications are provided by the OSGi Alliance (www.osgi.org, formerly OSGi was referred as Open Services Gateway Initiative). OSGi Alliance is an industry backed nonprofit organization which was founded in March 1999. The OSGi specification has gone through many releases and the current major version in use is 4 and version 5 has been introduced recently.

The OSGi defines a dynamic module system for Java. This offers help for Java's modularity problems by providing better control to the code structure, manage the lifecycle of the code and a complete loosely coupled approach that is much needed for component-oriented development.

The OSGi specification consists of two parts:

  • OSGi Framework
  • OSGi Standard services

The OSGi framework is the OSGi runtime environment that provides all the functionality as per the specifications. Applications are deployed and executed in the OSGi framework. The OSGi framework provides an API for the development of components. There are a number of framework implementations and some of the popular ones are Eclipse Equinox, Apache Felix and Knoplerfish. OSGi standard services define reusable services that should be provided as part of the development platform implementation. There are three conceptual layers in OSGi framework:

  • Module layer - Responsible for packaging and sharing code
  • Lifecycle layer - Responsible for managing the lifecycle of deployed module during runtime
  • Service layer - Responsible for dynamic service publication, searching and binding

OSGi Bundle
An OSGi bundle is a deployment module in the form of a JAR file. A module in OSGi parlance is known as a bundle. Bundles contain class files and resource files, similar to the regular JAR file in Java, but in addition they contain manifest information that contains metadata about the bundle. Apart from the regular JAR file's manifest contents, a bundle's manifest file has OSGi specific information such as module name, version number, dependencies, etc., thus giving better modularity and easy maintainability. Bundles are more powerful than JAR files in enforcing module boundaries, because a bundle needs to explicitly define what portion of its internal code is externally visible. Similarly, a bundle must explicitly declare any external dependencies that it has with the code exposed by other bundles. A bundle must have a unique identity - Bundle Name and Version.

The OSGi framework matches the exports and imports of deployed bundles to dynamically wire the entire application. This process of bundle resolution ensures consistency among the different bundles in terms of versions and other constraints. An application in OSGi is nothing but a collection of bundles with explicitly defined dependencies. A bundle is deployed in OSGi framework once it is developed.

OSGi Service Registry
The OSGi Service registry promotes service oriented programming. The service registry provides service publication service discovery and service binding. The bundles deployed in the OSGi framework can leverage the service registry later for publishing and consuming services. A bundle providing a service publishes the service in the OSGi Service Registry. A service is defined by a Java Interface, which represents a conceptual contract between the provider and consumer. A potential consumer can use the registry to search for providers of a particular service. Once if finds a service provider, it can bind and use the service. Services layer in OSGi facilitates one more level of dynamism other than bundles. Just as bundles can be added and removed in a running application, the Services can appear and go dynamically in a runtime application.

OSGi Component
As discussed earlier, a bundle is the deployment unit in OSGi component model. A bundle is a JAR file that contains:

  • Class files
  • Resource files
  • Manifest file (with additional metadata)

The class files are typically the interface and the implementation which constitutes the component. The manifest will have additional metadata as shown below:

Manifest-Version: 1.0

Bundle-ManifestVersion: 2

Bundle-Name: com.demo.helloWorld

Bundle-SymbolicName: com.demo.helloWorld

Bundle-Version: 1.0.0.qualifier

Bundle-Activator: com.demo.Activator

Bundle-Vendor: PIRAM

Bundle-RequiredExecutionEnvironment: JavaSE-1.7

Import-Package: org.osgi.framework;version="1.3.0"

Bundle-ActivationPolicy: lazy

The OSGi Framework provides an inbuilt API called BundleActivator which helps the bundle to hook its own lifecycle management. The BundleActivator interface has two methods - start() and stop() which are invoked when the bundle is started and stopped respectively. Any bundle can implement this interface to check its own life cycle. The bundle could perform actions as specified in the start and stop methods of the Activator class. The use of bundle as a component for building application on the OSGi framework does not just depend on the bundle doing the work whenever it is started or stopped. The bundle needs to be able to expose certain functionality as provided interfaces and it needs to consume functionalities as per the require interfaces. Thus a collection of bundles made into an assembly should be able to work together to form a system. Generally the provided interface will be created as a separate bundle and the implementations can be wired dynamically by the OSGi runtime from the implementation bundles. There can be more than one implementation, the wiring happens depending on the runtime.

Example to understand OSGi Component Model
The OSGi component model can be understood with the same shopping Cart example discussed in the earlier models.

Figure 3: OSGi Component Model - Cart Component Example

The Cart application in this example is created with the following bundles for better modularity and maintainability.

  1. Interface Bundle (com.online.shopping)
  2. Implementation Bundle (CartImpl)
  3. Client Bundle (CartClient)

The Cart component is comprised of interface bundle and implementation bundle. The interface bundle (com.online.shopping) defines an interface ICart. This interface will be used by the implementation bundle to invoke the exposed services. The client bundle will use the interface for invoking the required services which gets bounded to the implementation bundle by the service registry.

Interface Bundle
The interface bundle contains the interface ICart for the Cart component and is defined as below:

package com.online.shopping;

import java.util.Collection;

public interface ICart {
public void addItem(Product product, int quantity);
public Collection<Product> listItems();    
public double getTotalPrice();
public void clearCart();
}

This bundle has ONLY the interface and its helper class and it exports the com.online.shopping package as shown in the manifest file below:

Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: CartIntf
Bundle-SymbolicName: CartIntf
Bundle-Version: 1.0.0.qualifier
Bundle-ActivationPolicy: lazy
Bundle-RequiredExecutionEnvironment: JavaSE-1.6
Import-Package: org.osgi.framework;version="1.3.0"
Export-Package: com.online.shopping

The structure of the bundle jar file is as below:

Figure 4: Structure of Interface Bundle

Implementation Bundle
ICart interface is implemented by the class CartImpl, whose code as demonstrated below:

package com.online.shopping.impl;

import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

import com.online.shopping.ICart;
import com.online.shopping.Product;

public class CartImpl implements ICart {
Map<Product, Integer> items = new HashMap<Product, Integer>();      

@Override
public void addItem(Product product, int quantity) {
if(items.containsKey(product)) {
quantity +=items.get(product);
}
items.put(product, quantity);
}

@Override

public Collection<Product> listItems() {

return items.keySet();

}

@Override
public double getTotalPrice() {
double totalPrice = 0;
for(Product product: items.keySet()) {
totalPrice+=product.getPrice()* items.get(product);           
}
return totalPrice;
}

@Override
public void clearCart() {
items.clear();
}

}

The CartImpl is the class in the implementation bundle that implements the ICart interface and provides the ICart service implementation. In the implementation bundle, the interface com.online.shopping.ICart is not added to the CLASSPATH, but imported by the OSGi framework. This bundle imports the interface bundle as explained in the MANIFEST.MF below:

Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: CartImpl
Bundle-SymbolicName: CartImpl
Bundle-Version: 1.0.0.qualifier
Bundle-RequiredExecutionEnvironment: JavaSE-1.6
Import-Package: com.online.shopping,
org.osgi.framework;version="1.6.0"
Service-Component: META-INF/component.xml

The implementation bundle is exposed as a declarative service component. From the manifest file, it is evident that the bundle is not exported as a package, but it is exposed as a service with the entry - Service-Component that this is exposed as a component and the component description is available in component.xml. With the help of such XML files, components declare their provided services. The OSGi framework helps to publish the CartImpl as a service in the OSGi service registry. The component.xml is as below:

<?xml version="1.0" encoding="UTF-8"?>
<scr:component xmlns:scr="http://www.osgi.org/xmlns/scr/v1.1.0" name="CartImpl">
<implementation class="com.online.shopping.impl.CartImpl"/>
<service>
<provide interface="com.online.shopping.ICart"/>
</service>
</scr:component>

The ICart is exposed as a service and the service is implemented by the CartImpl implementation class. Looking at the component.xml, it is clear that the component provides the ICart service. The component declares the implementation class and the provided interface. The declarative services in the OSGi framework publish the service at the execution time after the bundle is activated. The structure of the JAR file of the bundle is as follows:

Figure 5: Structure of Implementation Bundle

Client Bundle
The client bundle is supposed to consume the services exposed by the ICart service implementation and consume it. The client bundle is another component that imports the com.online.shopping package and consumes the service through OSGi service registry. The client bundle's manifest looks as below:

Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: CartClient
Bundle-SymbolicName: CartClient
Bundle-Version: 1.0.0.qualifier
Bundle-RequiredExecutionEnvironment: JavaSE-1.6
Import-Package: com.online.shopping,
org.osgi.framework;version="1.6.0",
org.osgi.service.component;version="1.1.0"
Service-Component: META-INF/component.xml

The client is also a component which consumes the services provided by the ICart component.

Figure 6: Structure of Client Bundle

The component.xml in client bundle has reference to the ICart service interface.

<?xml version="1.0" encoding="UTF-8"?>
<scr:component xmlns:scr="http://www.osgi.org/xmlns/scr/v1.1.0" name="CartClient">
<implementation class="com.client.CartClient"/>
<reference bind="gotService" cardinality="1..1" interface="com.online.shopping.ICart" name="ICart" policy="dynamic" unbind="lostService"/>
</scr:component>

Apart from the interface reference, the component.xml also refers to some methods called ‘gotService' and ‘lostService' during binding and unbinding of service references. These are the methods defined in the client class which will be invoked with the associated service references into the service object. This allows the component to find out the services without retrieving them. The declarative specifications in OSGi framework defines the methods where the service reference will be injected. The component service policy may be static or dynamic. In static policy, the service reference is injected once and not changed until the component is deactivated. Where as in the dynamic policy, the component is notified whenever the service comes or goes utilizing the true dynamism. In the example, it is dynamic. The client invokes the ICart service as follows:

package com.client;

import java.util.Collection;

import org.osgi.framework.ServiceReference;
import org.osgi.service.component.ComponentContext;

import com.online.shopping.ICart;
import com.online.shopping.Product;

public class CartClient {

ComponentContext context;
ServiceReference reference;
ICart cart;

public void activate(ComponentContext context) {
System.out.println("Activate Component");

if(reference!= null) {
cart = (ICart)context.locateService("ICart", reference);

Product product = new Product();
product.setName("OSGi");
product.setPrice(550.00);
cart.addItem(product, 20);

Product newProduct = new Product();
newProduct.setName("Enterprise OSGi");
newProduct.setPrice(400.00);
cart.addItem(newProduct, 10);

Collection<Product> productItems = cart.listItems();
for(Product items: productItems) {
System.out.println(items.getName()+"******"+ items.getPrice());             
}            

System.out.println("Total Price of Cart Items: "+cart.getTotalPrice());

cart.clearCart();
}

}

public void gotService(ServiceReference reference) {
System.out.println("Bind Service");
this.reference = reference;
}

public void lostService(ServiceReference reference) {
System.out.println("unbind Service");
this.reference = null;           
}

}

The client has defined three methods:

  • activate - part of declarative services API. This method is invoked when this component is activated. The ComponentContext is used to locate the ICart with the injected service reference.
  • gotService - user defined method as available in the component.xml, this method is invoked with the service reference (using dependency injection) when the service object is binded.
  • lostService - user defined method as mentioned in the client component.xml, this method is invoked with the injected service reference when the service object is unbinded.

Figure 7: Cart Component Bundles Deployment in OSGi Container

The client is not even aware of the implementation bundle. If there are multiple implementations available for the same service, the service is bounded dynamically by the environment. If there is any change in the implementation, only the implementation bundle will undergo change. A revised bundle can provide additional services which can be consumed by clients. So replacing components is easier and will not affect any other component. This way, OSGi gives good modularity by de-coupling components and a pluggable dynamic service model which are much needed features of a component model.

More Stories By Piram Manickam

Piram Manickam works at Infosys Limited. He would like to acknowledge and thank Sangeetha S, a beloved colleague and friend, for her invaluable contributions in this work.

More Stories By Subrahmanya SV

Subrahmanya SV works at Infosys Limited. He would like to acknowledge and thank Sangeetha S, a beloved colleague and friend, for her invaluable contributions in this work.

More Stories By S Sangeetha

S Sangeetha is a Senior Technical Architect at the E-Commerce Research Labs at Infosys Limited. She has over 15 years of experience in architecture, design and development of enterprise Java applications. She is also involved in enhancing the technical skills of Architects at Infosys. She has co-authored a book on ‘J2EE Architecture’ and also has written numerous articles on Java for various online Java forums like JavaWorld, java.net, DevX.com and internet.com. She can be reached at [email protected]

Comments (0)

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


@MicroservicesExpo Stories
When you decide to launch a startup company, business advisors, counselors, bankers and armchair know-it-alls will tell you that the first thing you need to do is get funding. While there is some validity to that boilerplate piece of wisdom, the availability of and need for startup funding has gone through a dramatic transformation over the past decade, and the next few years will see even more of a shift. A perfect storm of events is causing this seismic shift. On the macroeconomic side this ...
Cloud promises the agility required by today’s digital businesses. As organizations adopt cloud based infrastructures and services, their IT resources become increasingly dynamic and hybrid in nature. Managing these require modern IT operations and tools. In his session at 20th Cloud Expo, Raj Sundaram, Senior Principal Product Manager at CA Technologies, will discuss how to modernize your IT operations in order to proactively manage your hybrid cloud and IT environments. He will be sharing be...
Back in February of 2017, Andrew Clay Schafer of Pivotal tweeted the following: “seriously tho, the whole software industry is stuck on deployment when we desperately need architecture and telemetry.” Intrigue in a 140 characters. For me, I hear Andrew saying, “we’re jumping to step 5 before we’ve successfully completed steps 1-4.”
Enterprise architects are increasingly adopting multi-cloud strategies as they seek to utilize existing data center assets, leverage the advantages of cloud computing and avoid cloud vendor lock-in. This requires a globally aware traffic management strategy that can monitor infrastructure health across data centers and end-user experience globally, while responding to control changes and system specification at the speed of today’s DevOps teams. In his session at 20th Cloud Expo, Josh Gray, Chie...
To more closely examine the variety of ways in which IT departments around the world are integrating cloud services, and the effect hybrid IT has had on their organizations and IT job roles, SolarWinds recently released the SolarWinds IT Trends Report 2017: Portrait of a Hybrid Organization. This annual study consists of survey-based research that explores significant trends, developments, and movements related to and directly affecting IT and IT professionals.
In his general session at 19th Cloud Expo, Manish Dixit, VP of Product and Engineering at Dice, discussed how Dice leverages data insights and tools to help both tech professionals and recruiters better understand how skills relate to each other and which skills are in high demand using interactive visualizations and salary indicator tools to maximize earning potential. Manish Dixit is VP of Product and Engineering at Dice. As the leader of the Product, Engineering and Data Sciences team at D...
NHK, Japan Broadcasting, will feature the upcoming @ThingsExpo Silicon Valley in a special 'Internet of Things' and smart technology documentary that will be filmed on the expo floor between November 3 to 5, 2015, in Santa Clara. NHK is the sole public TV network in Japan equivalent to the BBC in the UK and the largest in Asia with many award-winning science and technology programs. Japanese TV is producing a documentary about IoT and Smart technology and will be covering @ThingsExpo Silicon Val...
Cloud Expo, Inc. has announced today that Aruna Ravichandran, vice president of DevOps Product and Solutions Marketing at CA Technologies, has been named co-conference chair of DevOps at Cloud Expo 2017. The @DevOpsSummit at Cloud Expo New York will take place on June 6-8, 2017, at the Javits Center in New York City, New York, and @DevOpsSummit at Cloud Expo Silicon Valley will take place Oct. 31-Nov. 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
Is your application too difficult to manage? Do changes take dozens of developers hundreds of hours to execute, and frequently result in downtime across all your site’s functions? It sounds like you have a monolith! A monolith is one of the three main software architectures that define most applications. Whether you’ve intentionally set out to create a monolith or not, it’s worth at least weighing the pros and cons of the different architectural approaches and deciding which one makes the most s...
Developers want to create better apps faster. Static clouds are giving way to scalable systems, with dynamic resource allocation and application monitoring. You won't hear that chant from users on any picket line, but helping developers to create better apps faster is the mission of Lee Atchison, principal cloud architect and advocate at New Relic Inc., based in San Francisco. His singular job is to understand and drive the industry in the areas of cloud architecture, microservices, scalability ...
This recent research on cloud computing from the Register delves a little deeper than many of the "We're all adopting cloud!" surveys we've seen. They found that meaningful cloud adoption and the idea of the cloud-first enterprise are still not reality for many businesses. The Register's stats also show a more gradual cloud deployment trend over the past five years, not any sort of explosion. One important takeaway is that coherence across internal and external clouds is essential for IT right n...
Today we can collect lots and lots of performance data. We build beautiful dashboards and even have fancy query languages to access and transform the data. Still performance data is a secret language only a couple of people understand. The more business becomes digital the more stakeholders are interested in this data including how it relates to business. Some of these people have never used a monitoring tool before. They have a question on their mind like “How is my application doing” but no id...
In large enterprises, environment provisioning and server provisioning account for a significant portion of the operations team's time. This often leaves users frustrated while they wait for these services. For instance, server provisioning can take several days and sometimes even weeks. At the same time, digital transformation means the need for server and environment provisioning is constantly growing. Organizations are adopting agile methodologies and software teams are increasing the speed ...
In his session at 20th Cloud Expo, Scott Davis, CTO of Embotics, will discuss how automation can provide the dynamic management required to cost-effectively deliver microservices and container solutions at scale. He will discuss how flexible automation is the key to effectively bridging and seamlessly coordinating both IT and developer needs for component orchestration across disparate clouds – an increasingly important requirement at today’s multi-cloud enterprise.
Keeping pace with advancements in software delivery processes and tooling is taxing even for the most proficient organizations. Point tools, platforms, open source and the increasing adoption of private and public cloud services requires strong engineering rigor – all in the face of developer demands to use the tools of choice. As Agile has settled in as a mainstream practice, now DevOps has emerged as the next wave to improve software delivery speed and output. To make DevOps work, organization...
Software as a service (SaaS), one of the earliest and most successful cloud services, has reached mainstream status. According to Cisco, by 2019 more than four-fifths (83 percent) of all data center traffic will be based in the cloud, up from 65 percent today. The majority of this traffic will be applications. Businesses of all sizes are adopting a variety of SaaS-based services – everything from collaboration tools to mission-critical commerce-oriented applications. The rise in SaaS usage has m...
The proper isolation of resources is essential for multi-tenant environments. The traditional approach to isolate resources is, however, rather heavyweight. In his session at 18th Cloud Expo, Igor Drobiazko, co-founder of elastic.io, drew upon his own experience with operating a Docker container-based infrastructure on a large scale and present a lightweight solution for resource isolation using microservices. He also discussed the implementation of microservices in data and application integrat...
We'd all like to fulfill that "find a job you love and you'll never work a day in your life" cliché. But in reality, every job (even if it's our dream job) comes with its downsides. For you, the constant fight against shadow IT might get on your last nerves. For your developer coworkers, infrastructure management is the roadblock that stands in the way of focusing on coding. As you watch more and more applications and processes move to the cloud, technology is coming to developers' rescue-most r...
2016 has been an amazing year for Docker and the container industry. We had 3 major releases of Docker engine this year , and tremendous increase in usage. The community has been following along and contributing amazing Docker resources to help you learn and get hands-on experience. Here’s some of the top read and viewed content for the year. Of course releases are always really popular, particularly when they fit requests we had from the community.
Even for the most seasoned IT pros, the cloud is complicated. It can be difficult just to wrap your head around the many terms and acronyms that make up the cloud dictionary-not to mention actually mastering the technology. Unfortunately, complicated cloud terms are often combined to the point that their meanings are lost in a sea of conflicting opinions. Two terms that are used interchangeably (but shouldn't be) are hybrid cloud and multicloud. If you want to be the cloud expert your company ne...