OSGi : Develop Simple Apps

From CDOT Wiki
Revision as of 15:15, 22 January 2011 by Jordan.anastasiade (talk | contribs)
Jump to: navigation, search

OSGi Activities

Start the lab activities in the order defined below:

  1. Check out the Service Interface
  2. Check out the Service Provider
  3. Check out the Service Consumer

Steps for Building Bundels

1. Study the Interfaces

2. Define the Bundle Service Provider

2.1 Define the Generic Bundle Service Provider
2.1.1 Define the Java Interface that exposes the services

Let us suppose that you want to define a service that allows the user to find a book from the book isbn. Then the interface should look similare with this one:

package cs.ecl.osgi.simple.bookfinder;

public interface BookFinder {
	Book findBook(int isbn) throws BookNotFoundException;

Define in the same bundle the classes that you need such as: Book and BookNotFoundException

package cs.ecl.osgi.simple.bookfinder;

public class Book {
	private int isbn;
	private String title;
	public Book(int isbn, String title) {
		this.isbn = isbn;
		this.title = title;

	public String getTitle() {
		return title;

	public void setTitle(String title) {
		this.title = title;

	public int getIsbn() {
		return isbn;

	public void setIsbn(int isbn) {
		this.isbn = isbn;

package cs.ecl.osgi.simple.bookfinder;

public class BookNotFoundException extends Exception {
	private static final long serialVersionUID = -6184839510952070091L;

	public BookNotFoundException() {

	public BookNotFoundException(String arg0) {

Define in the MANIFEST.MF that cs.ecl.osgi.simple.bookfinder is the Exported-Package

Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: Bookfinder
Bundle-SymbolicName: cs.ecl.osgi.simple.bookfinder
Bundle-Version: 1.0.0.qualifier
Bundle-RequiredExecutionEnvironment: JavaSE-1.6
Bundle-Vendor: Seneca College - Eclipse Course
Export-Package: cs.ecl.osgi.simple.bookfinder
2.2 Define a Concrete Bundle Provider
2.2.1 Define the Activator class
package cs.ecl.osgi.simple.bookfinderservice;

import org.osgi.framework.BundleActivator;
import org.osgi.framework.BundleContext;

import cs.ecl.osgi.simple.bookfinder.BookFinder;
import cs.ecl.osgi.simple.bookfinderservice.internals.BookFinderImplementation;

public class Activator implements BundleActivator {

	private static BundleContext context;

	static BundleContext getContext() {
		return context;
	public void start(BundleContext bundleContext) throws Exception {
		Activator.context = bundleContext;
		BookFinder bookService = new BookFinderImplementation();
		context.registerService(BookFinder.class.getName(), bookService, null);
		System.out.println(" Bookfinder service registered ");
	public void stop(BundleContext bundleContext) throws Exception {
		Activator.context = null;
		System.out.println(" Bookfinder service stopped ");
2.2.1 Define the internal implementation class (This class will not be exposed to the outside world)
package cs.ecl.osgi.simple.bookfinderservice.internals;

import cs.ecl.osgi.simple.bookfinder.Book;
import cs.ecl.osgi.simple.bookfinder.BookFinder;
import cs.ecl.osgi.simple.bookfinder.BookNotFoundException;

public class BookFinderImplementation implements BookFinder {
	private static final Book[] BOOKS = new Book[] {
			new Book(1234, "Java Programming Language"), 
			new Book(5678, "OSGi") };

	public Book findBook(int isbn) throws BookNotFoundException {
		Book found = null;

		for (Book b : BOOKS)
			if (b.getIsbn() == isbn) {
				found = b;
		if (found == null)
			throw new BookNotFoundException("No book with isbn = " + isbn);

		return found;
//This could be any implementation: database, file system, distributed, etc.