Welcome!

XML Authors: Yeshim Deniz, Lori MacVittie, Carmen Gonzalez, Pat Romanski, Peter Silva

Related Topics: Java, XML, Wireless, SOA & WOA, Websphere, Weblogic, AJAX & REA

Java: 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.


@ThingsExpo Stories

SUNNYVALE, Calif., Oct. 20, 2014 /PRNewswire/ -- Spansion Inc. (NYSE: CODE), a global leader in embedded systems, today added 96 new products to the Spansion® FM4 Family of flexible microcontrollers (MCUs). Based on the ARM® Cortex®-M4F core, the new MCUs boast a 200 MHz operating frequency and support a diverse set of on-chip peripherals for enhanced human machine interfaces (HMIs) and machine-to-machine (M2M) communications. The rich set of periphera...

The Internet of Things (IoT) is making everything it touches smarter – smart devices, smart cars and smart cities. And lucky us, we’re just beginning to reap the benefits as we work toward a networked society. However, this technology-driven innovation is impacting more than just individuals. The IoT has an environmental impact as well, which brings us to the theme of this month’s #IoTuesday Twitter chat. The ability to remove inefficiencies through connected objects is driving change throughout every sector, including waste management. BigBelly Solar, located just outside of Boston, is trans...
SYS-CON Events announced today that Matrix.org has been named “Silver Sponsor” of Internet of @ThingsExpo, which will take place on November 4–6, 2014, at the Santa Clara Convention Center in Santa Clara, CA. Matrix is an ambitious new open standard for open, distributed, real-time communication over IP. It defines a new approach for interoperable Instant Messaging and VoIP based on pragmatic HTTP APIs and WebRTC, and provides open source reference implementations to showcase and bootstrap the new standard. Our focus is on simplicity, security, and supporting the fullest feature set.
Predicted by Gartner to add $1.9 trillion to the global economy by 2020, the Internet of Everything (IoE) is based on the idea that devices, systems and services will connect in simple, transparent ways, enabling seamless interactions among devices across brands and sectors. As this vision unfolds, it is clear that no single company can accomplish the level of interoperability required to support the horizontal aspects of the IoE. The AllSeen Alliance, announced in December 2013, was formed with the goal to advance IoE adoption and innovation in the connected home, healthcare, education, aut...
SYS-CON Events announced today that Red Hat, the world's leading provider of open source solutions, will exhibit at Internet of @ThingsExpo, which will take place on November 4–6, 2014, at the Santa Clara Convention Center in Santa Clara, CA. Red Hat is the world's leading provider of open source software solutions, using a community-powered approach to reliable and high-performing cloud, Linux, middleware, storage and virtualization technologies. Red Hat also offers award-winning support, training, and consulting services. As the connective hub in a global network of enterprises, partners, a...
The only place to be June 9-11 is Cloud Expo & @ThingsExpo 2015 East at the Javits Center in New York City. Join us there as delegates from all over the world come to listen to and engage with speakers & sponsors from the leading Cloud Computing, IoT & Big Data companies. Cloud Expo & @ThingsExpo are the leading events covering the booming market of Cloud Computing, IoT & Big Data for the enterprise. Speakers from all over the world will be hand-picked for their ability to explore the economic strategies that utility/cloud computing provides. Whether public, private, or in a hybrid form, clo...
Software AG helps organizations transform into Digital Enterprises, so they can differentiate from competitors and better engage customers, partners and employees. Using the Software AG Suite, companies can close the gap between business and IT to create digital systems of differentiation that drive front-line agility. We offer four on-ramps to the Digital Enterprise: alignment through collaborative process analysis; transformation through portfolio management; agility through process automation and integration; and visibility through intelligent business operations and big data.
The Transparent Cloud-computing Consortium (abbreviation: T-Cloud Consortium) will conduct research activities into changes in the computing model as a result of collaboration between "device" and "cloud" and the creation of new value and markets through organic data processing High speed and high quality networks, and dramatic improvements in computer processing capabilities, have greatly changed the nature of applications and made the storing and processing of data on the network commonplace.
Be Among the First 100 to Attend & Receive a Smart Beacon. The Physical Web is an open web project within the Chrome team at Google. Scott Jenson leads a team that is working to leverage the scalability and openness of the web to talk to smart devices. The Physical Web uses bluetooth low energy beacons to broadcast an URL wirelessly using an open protocol. Nearby devices can find all URLs in the room, rank them and let the user pick one from a list. Each device is, in effect, a gateway to a web page. This unlocks entirely new use cases so devices can offer tiny bits of information or simple i...
Things are being built upon cloud foundations to transform organizations. This CEO Power Panel at 15th Cloud Expo, moderated by Roger Strukhoff, Cloud Expo and @ThingsExpo conference chair, will address the big issues involving these technologies and, more important, the results they will achieve. How important are public, private, and hybrid cloud to the enterprise? How does one define Big Data? And how is the IoT tying all this together?
The Internet of Things (IoT) is going to require a new way of thinking and of developing software for speed, security and innovation. This requires IT leaders to balance business as usual while anticipating for the next market and technology trends. Cloud provides the right IT asset portfolio to help today’s IT leaders manage the old and prepare for the new. Today the cloud conversation is evolving from private and public to hybrid. This session will provide use cases and insights to reinforce the value of the network in helping organizations to maximize their company’s cloud experience.
TechCrunch reported that "Berlin-based relayr, maker of the WunderBar, an Internet of Things (IoT) hardware dev kit which resembles a chunky chocolate bar, has closed a $2.3 million seed round, from unnamed U.S. and Switzerland-based investors. The startup had previously raised a €250,000 friend and family round, and had been on track to close a €500,000 seed earlier this year — but received a higher funding offer from a different set of investors, which is the $2.3M round it’s reporting."
The Industrial Internet revolution is now underway, enabled by connected machines and billions of devices that communicate and collaborate. The massive amounts of Big Data requiring real-time analysis is flooding legacy IT systems and giving way to cloud environments that can handle the unpredictable workloads. Yet many barriers remain until we can fully realize the opportunities and benefits from the convergence of machines and devices with Big Data and the cloud, including interoperability, data security and privacy.
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. Over the summer Gartner released its much anticipated annual Hype Cycle report and the big news is that Internet of Things has now replaced Big Data as the most hyped technology. Indeed, we're hearing more and more about this fascinating new technological paradigm. Every other IT news item seems to be about IoT and its implications on the future of digital busines...
Cultural, regulatory, environmental, political and economic (CREPE) conditions over the past decade are creating cross-industry solution spaces that require processes and technologies from both the Internet of Things (IoT), and Data Management and Analytics (DMA). These solution spaces are evolving into Sensor Analytics Ecosystems (SAE) that represent significant new opportunities for organizations of all types. Public Utilities throughout the world, providing electricity, natural gas and water, are pursuing SmartGrid initiatives that represent one of the more mature examples of SAE. We have s...
The Internet of Things needs an entirely new security model, or does it? Can we save some old and tested controls for the latest emerging and different technology environments? In his session at Internet of @ThingsExpo, Davi Ottenheimer, EMC Senior Director of Trust, will review hands-on lessons with IoT devices and reveal privacy options and a new risk balance you might not expect.
IoT is still a vague buzzword for many people. In his session at Internet of @ThingsExpo, Mike Kavis, Vice President & Principal Cloud Architect at Cloud Technology Partners, will discuss the business value of IoT that goes far beyond the general public's perception that IoT is all about wearables and home consumer services. The presentation will also discuss how IoT is perceived by investors and how venture capitalist access this space. Other topics to discuss are barriers to success, what is new, what is old, and what the future may hold.
Swiss innovators dizmo Inc. launches its ground-breaking software, which turns any digital surface into an immersive platform. The dizmo platform seamlessly connects digital and physical objects in the home and at the workplace. Dizmo breaks down traditional boundaries between device, operating systems, apps and software, transforming the way users work, play and live. It supports orchestration and collaboration in an unparalleled way enabling any data to instantaneously be accessed on any surface, anywhere and made interactive. Dizmo brings fantasies as seen in Sci-fi movies such as Iro...
There’s Big Data, then there’s really Big Data from the Internet of Things. IoT is evolving to include many data possibilities like new types of event, log and network data. The volumes are enormous, generating tens of billions of logs per day, which raise data challenges. Early IoT deployments are relying heavily on both the cloud and managed service providers to navigate these challenges. In her session at 6th Big Data Expo®, Hannah Smalltree, Director at Treasure Data, to discuss how IoT, Big Data and deployments are processing massive data volumes from wearables, utilities and other mach...
This Internet of Nouns trend is still in the early stages and many of our already connected gadgets do provide human benefits over the typical infotainment. Internet of Things or IoT. You know, where everyday objects have software, chips, and sensors to capture data and report back. Household items like refrigerators, toilets and thermostats along with clothing, cars and soon, the entire home will be connected. Many of these devices provide actionable data - or just fun entertainment - so people can make decisions about whatever is being monitored. It can also help save lives.