OSGi

OSGi

OSGi Alliance logo
Year started	1999
Latest version	8.0 October 2020 (2020-10) [1]
Organization	OSGi Alliance
Domain	Java
License	OSGi Specification License, Version 2.0
Website	www.osgi.org

OSGi is an open specification and open source project under the Eclipse Foundation.

It is a continuation of the work done by the OSGi Alliance (formerly known as the Open Services Gateway initiative), which was an open standards organization for software founded in March 1999. The foundation originally specified and maintained the OSGistandard. The alliance transferred its work to the Eclipse Foundation at the end of 2020.

The OSGi specification describes a modular system and a service platform for the Java programming language that implements a complete and dynamic component model, something that does not exist in standalone Java or VM environments. It has a service-oriented architecture based on micro services each implemented as an extended Java class file archive (JAR (file format)).

Description

OSGi is built around a service-oriented architecture. Applications or components, come in the form of bundles for deployment, can be remotely installed, started, stopped, updated, and uninstalled without requiring a reboot. Management of Java packages/classes is specified in great detail. Application life cycle management is implemented via APIs that enable remote downloading of management policies. The service registry enables bundles to detect the addition of new services or the removal of services, and adapt accordingly.

The OSGi specifications have evolved beyond the original focus of service gateways, and are now used in applications ranging from mobile phones to the open-source Eclipse IDE. Other application areas include automobiles, industrial automation, building automation, PDAs, grid computing, entertainment, fleet management and application servers.

In October 2020, the OSGi Alliance announced the transition of the standardization effort to the Eclipse Foundation, subsequent to which it would shut down. ^[2] All artifacts have been transferred to the Eclipse Foundation, where an “OSGi Working Group" continues to maintain and evolve the specification.

Specification process

The OSGi specification is developed by the members in an open process and made available to the public free of charge under the OSGi Specification License. ^[3] The OSGi Alliance has a compliance program that is open to members only. As of November 2010, there are seven certified OSGi framework implementations. ^[4] A separate page lists both certified and non-certified OSGi Specification Implementations, which include OSGi frameworks and other OSGi specifications.

Architecture

OSGi Service Gateway Architecture

OSGi is a Java framework for developing and deploying modular software programs and libraries. Each bundle is a tightly coupled, dynamically loadable collection of classes, jars, and configuration files that explicitly declare their external dependencies (if any).

The framework is conceptually divided into the following areas:

Bundles

Bundles are normal JAR components with extra manifest headers.

Services

The services layer connects bundles in a dynamic way by offering a publish-find-bind model for plain old Java interfaces (POJIs) or plain old Java objects (POJOs).

Services Registry

The application programming interface for management services.

Life-Cycle

The application programming interface for life cycle management (install, start, stop, update, and uninstall) for bundles.

Modules

The layer that defines encapsulation and declaration of dependencies (how a bundle can import and export code).

Security

The layer that handles the security aspects by limiting bundle functionality to pre-defined capabilities.

Execution Environment

Defines what methods and classes are available in a specific platform. There is no fixed list of execution environments, since it is subject to change as the Java Community Process creates new versions and editions of Java. However, the following set is currently supported by most OSGi implementations:

• CDC-1.0/Foundation-1.0
• CDC-1.1/Foundation-1.1
• OSGi/Minimum-1.0
• OSGi/Minimum-1.1
• JRE-1.1
• From J2SE-1.2 up to J2SE-1.6

Bundles

Classification: OSGi

A bundle is a group of Java classes and additional resources equipped with a detailed manifest MANIFEST.MF file on all its contents, as well as additional services needed to give the included group of Java classes more sophisticated behaviors, to the extent of deeming the entire aggregate a component.

Below is an example of a typical MANIFEST.MF file with OSGi Headers:

Bundle-Name:Hello WorldBundle-SymbolicName:org.wikipedia.helloworldBundle-Description:A Hello World bundleBundle-ManifestVersion:2Bundle-Version:1.0.0Bundle-Activator:org.wikipedia.ActivatorExport-Package:org.wikipedia.helloworld;version="1.0.0"Import-Package:org.osgi.framework;version="1.3.0"

The meaning of the contents in the example is as follows: ^[5]

1. Bundle-Name: Defines a human-readable name for this bundle, Simply assigns a short name to the bundle.
2. Bundle-SymbolicName: The only required header, this entry specifies a unique identifier for a bundle, based on the reverse domain name convention (used also by the java packages).
3. Bundle-Description: A description of the bundle's functionality.
4. Bundle-ManifestVersion: Indicates the OSGi specification to use for reading this bundle.
5. Bundle-Version: Designates a version number to the bundle.
6. Bundle-Activator: Indicates the class name to be invoked once a bundle is activated.
7. Export-Package: Expresses which Java packages contained in a bundle will be made available to the outside world.
8. Import-Package: Indicates which Java packages will be required from the outside world to fulfill the dependencies needed in a bundle.

Life-cycle

OSGi Bundle Life-Cycle

A Life Cycle layer adds bundles that can be dynamically installed, started, stopped, updated and uninstalled. Bundles rely on the module layer for class loading but add an API to manage the modules in run time. The life cycle layer introduces dynamics that are normally not part of an application. Extensive dependency mechanisms are used to assure the correct operation of the environment. Life cycle operations are fully protected with the security architecture.

Bundle State	Description
INSTALLED	The bundle has been successfully installed.
RESOLVED	All Java classes that the bundle needs are available. This state indicates that the bundle is either ready to be started or has stopped.
STARTING	The bundle is being started, the BundleActivator.start method has been called but the start method has not yet returned. When the bundle has an activation policy, the bundle will remain in the STARTING state until the bundle is activated according to its activation policy.
ACTIVE	The bundle has been successfully activated and is running; its Bundle Activator start method has been called and returned.
STOPPING	The bundle is being stopped. The BundleActivator.stop method has been called but the stop method has not yet returned.
UNINSTALLED	The bundle has been uninstalled. It cannot move into another state.

Below is an example of a typical Java class implementing the BundleActivator interface:

packageorg.wikipedia;importorg.osgi.framework.BundleActivator;importorg.osgi.framework.BundleContext;publicclassActivatorimplementsBundleActivator{privateBundleContextcontext;@Overridepublicvoidstart(BundleContextcontext)throwsException{System.out.println("Starting: Hello World");this.context=context;}@Overridepublicvoidstop(BundleContextcontext)throwsException{System.out.println("Stopping: Goodbye Cruel World");this.context=null;}}

Services

Standard services

The OSGi Alliance has specified many services. Services are specified by a Java interface. Bundles can implement this interface and register the service with the Service Registry. Clients of the service can find it in the registry, or react to it when it appears or disappears.

The table below shows a description of OSGi System Services:

System Services	Description
Logging	The logging of information, warnings, debug information or errors is handled through the Log Service. It receives log entries and then dispatches these entries to other bundles that subscribed to this information.
Configuration Admin	This service allows an operator to set and get the configuration information of deployed bundles.
Device Access	Facilitates the coordination of automatic detection and attachment of existing devices. This is used for Plug and Play scenarios.
User Admin	This service uses a database with user information (private and public) for authentication and authorization purposes.
IO Connector	The IO Connector Service implements the CDC/CLDC javax.microedition.io package as a service. This service allows bundles to provide new and alternative protocol schemes.
Preferences	Offers an alternative, more OSGi-friendly mechanism to using Java's default Properties for storing preferences.
Component Runtime	The dynamic nature of services—they can come and go at any time—makes writing software harder. The Component Runtime specification can simplify handling these dynamic aspects by providing an XML based declaration of the dependencies.
Deployment Admin	Standardizes access to some of the responsibilities of the management agent.
Event Admin	Provides an inter-bundle communication mechanism based on a publish-and-subscribe model.
Application Admin	Simplifies the management of an environment with many different types of applications that are simultaneously available.

The table below shows a description of OSGi Protocol Services:

Protocol Services	Description
HTTP Service	Allows information to be sent and received from OSGi using HTTP.
UPnP Device Service	Specifies how OSGi bundles can be developed to interoperate with Universal Plug and Play (UPnP) devices.
DMT Admin	Defines an API for managing a device using concepts from the Open Mobile Alliance (OMA) device management specifications.

The table below shows a description of OSGi Miscellaneous Services:

Miscellaneous Services	Description
Wire Admin	Allows the connection between a Producer service and a Consumer service.
XML Parser	The XML Parser service allows a bundle to locate a parser with desired properties and compatibility with JAXP.
Measurement and State	The Measurement and State service allows and simplifies the correct handling of measurements in an OSGi service platform.

Organization

The OSGi Alliance was founded by Ericsson, IBM, Motorola, Sun Microsystems and others in March 1999. Before incorporating as a nonprofit corporation, it was called the Connected Alliance.

Among its members are (as of February 2015 ^[update] ) more than 35 companies from quite different business areas, for example Adobe Systems, Deutsche Telekom, Hitachi, IBM, Liferay, Makewave, NEC, NTT, Oracle, Orange SA, ProSyst, Salesforce, Siemens, Software AG and TIBCO Software. ^[6]

The Alliance has a board of directors that provides the organization's overall governance. OSGi officers have various roles and responsibilities in supporting the alliance. Technical work is conducted within Expert Groups (EGs) chartered by the board of directors, and non-technical work is conducted in various working groups and committees. The technical work conducted within Expert Groups include developing specifications, reference implementations, and compliance tests. These Expert Groups have produced five major releases of the OSGi specifications (As of 2012 ^[update] ).

Dedicated Expert Groups exist for the enterprise, mobile, vehicle and the core platform areas.

The Enterprise Expert Group (EEG) is the newest EG and is addressing Enterprise / Server-side applications. In November 2007 the Residential Expert Group (REG) started to work on specifications to remotely manage residential/home-gateways. In October 2003, Nokia, Motorola, IBM, ProSyst and other OSGi members formed a Mobile Expert Group (MEG) that will specify a MIDP-based service platform for the next generation of smart mobile phones, addressing some of the needs that CLDC cannot manage – other than CDC. MEG became part of OSGi as with R4.

Specification versions

• OSGi Release 1 (R1): May 2000
• OSGi Release 2 (R2): October 2001
• OSGi Release 3 (R3): March 2003
• OSGi Release 4 (R4): October 2005 / September 2006
  • Core Specification (R4 Core): October 2005
  • Mobile Specification (R4 Mobile / JSR-232): September 2006
• OSGi Release 4.1 (R4.1): May 2007 (AKA JSR-291)
• OSGi Release 4.2 (R4.2): September 2009
  • Enterprise Specification (R4.2): March 2010
• OSGi Release 4.3 (R4.3): April 2011
  • Core: April 2011
  • Compendium and Residential: May 2012
• OSGi Release 5 (R5): June 2012
  • Core and Enterprise: June 2012
• OSGi Release 6 (R6): June 2015
  • Core: June 2015
• OSGi Release 7 (R7): April 2018
  • Core and Compendium: April 2018
• OSGi Release 8 (R8): December 2020 ^[7]

Related standards

• MHP / OCAP
• Universal Plug and Play (UPnP)
• DPWS
• ITU-T G.hn
• LonWorks
• CORBA
• CEBus
• EHS (KNX) / CECED CHAIN
• Java Management Extensions

Projects using OSGi

• Adobe Experience Manager – an enterprise Content Management System ^[8]
• Apache Aries – Blueprint Container implementations and extensions of application-focused specifications defined by OSGi Enterprise Expert Group
• Apache Sling – OSGi-based applications layer for JCR content repositories
• Atlassian Confluence and JIRA – the plug-in architecture for this enterprise wiki and issue tracker uses OSGi
• Business Intelligence and Reporting Tools (BIRT) Project – Open source reporting engine
• Cytoscape – an open source bioinformatics software platform (as of version 3.0)
• DataNucleus – open source data services and persistence platform in service-oriented architectures
• DDF – Distributed Data Framework provides free and open-source data integration
• Dotcms – open source Web Content Management
• EasyBeans – open source EJB 3 container
• Eclipse – open source IDE and rich client platform
• iDempiere – is an OSGi implementation of the open source ERP Branch GlobalQSS Adempiere361 originally started by Low Heng Sin ^[9]
• Eclipse Virgo – open source microkernel-based server constructed of OSGi bundles and supporting OSGi applications
• GlassFish (v3) – application server for Java EE
• Fuse ESB – a productized and supported release of ServiceMix 4
• Integrated Genome Browser – an open source, desktop GUI for visualizing, exploring, and analyzing genome data
• IntelliJ – Java IDE and rich client platform with free community edition
• JBoss – Red Hat's JBoss Application Server
• JOnAS 5 – open source Java EE 5 application server
• JOSSO 2 – Atricore's open source standards-based Identity and Access Management Platform
• Liferay Dxp – open source and commercial enterprise Portal platform use OSGi from version 7.x
• Lucee 5 – open source CFML Web Application Server
• NetBeans – open source IDE and rich client platform
• Nuxeo – open source ECM Service Platform
• Open Daylight Project – Project with the goal of accelerating the adoption of software-defined networking
• OpenEJB – open source OSGi-enabled EJB 3.0 container that can be run both in standalone or embedded mode
• openHAB – open source home automation software
• OpenWorm – open source software simulation of C. elegans, via the dedicated Geppetto modular platform
• Akana – API Gateway, Portal and Analytics server from Akana (formerly SOA Software)
• Weblogic – Oracle Weblogic Application Server
• WebSphere – IBM Websphere JEE Application Server
• WebMethods – SoftwareAG WebMethods
• WSO2 Carbon – Base platform for WSO2's enterprise-grade Open source middleware stack
• Pentaho - Business Intelligence (BI) software that provides data integration, OLAP services, reporting, information dashboards, data mining and extract, transform, load (ETL) capabilities.

Current framework implementations

Name	License
Apache Felix	Open source
Apache Karaf	Open source
Concierge OSGi	Open source
Equinox OSGi	Open source
Eclipse Gemini	Open Source
Knopflerfish	Open Source

References

1. "OSGi Alliance | Specifications / HomePage". osgi.org. 2020. Retrieved October 3, 2022.
2. Hargrave, B. J. "Announcement of Transition to Eclipse Foundation".
3. "OSGi Specification License". Archived from the original on 2015-09-14. Retrieved 2012-05-10.
4. "OSGi Alliance | Markets / Certified". Archived from the original on 2008-09-25. Retrieved 2017-06-23.
5. Creating OSGi bundles by Costin Leau
6. "OSGi Alliance | About / Members".
7. Hargrave, B. J. "OSGi Core Release 8 is now final and published".
8. "Forrester Names Web Content Management Leaders". CMSWire. 2018-11-16. Retrieved 5 December 2018.
9. "Adempiere Branch_GlobalQSS_361". adempiere.com/. Retrieved 27 September 2014.

Further reading

• Cummins, Holly; Ward, Tim (March 28, 2013), Enterprise OSGi in Action (1st ed.), Manning Publications, p. 376, ISBN   978-1617290138
• Alves, Alexandre de Castro (July 28, 2011), OSGi in Depth (1st ed.), Manning Publications, p. 325, ISBN   978-1-935182-17-7
• McAffer, Jeff; VanderLei, Paul; Archer, Simon (February 24, 2010), OSGi and Equinox: Creating Highly Modular Java Systems (1st ed.), Addison-Wesley Professional, p. 460, ISBN   978-0-321-58571-4
• Joseph Gédéon, Walid (November 5, 2010), OSGi and Apache Felix 3.0 Beginner's Guide (1st ed.), Packt Publishing, p. 336, ISBN   978-1-84951-138-4
• Walls, Craig (July 2009), Modular Java with OSGi and Spring (1st ed.), Pragmatic Bookshelf, p. 250, ISBN   978-1-934356-40-1, archived from the original on 2011-05-30, retrieved 2009-02-19
• Hall, Richard S; Pauls, Karl; McCulloch, Stuart (September 2009), OSGi in Action (1st ed.), Manning Publications, p. 375, ISBN   978-1-933988-91-7
• Alves, Alexandre de Castro (March 2009), OSGi Application Frameworks (1st ed.), Manning Publications, p. 325, ISBN   978-1-935182-17-7
• Bartlett, Neil (2009-01-10), OSGi In Practice (PDF) (DRAFT ed.), p. 229, archived from the original (PDF) on 2012-02-16, retrieved 2009-06-11
• McAffer, Jeff; VanderLei, Paul; Archer, Simon (September 7, 2009), Equinox and OSGi: The Power Behind Eclipse (1st ed.), Addison-Wesley Professional, p. 480, ISBN   978-0-321-58571-4
• Mak, Gary (2009), Pro SpringSource dm Server, Apress, p. 250, ISBN   978-1-4302-1640-7, archived from the original on 2010-12-05, retrieved 2008-12-28
• Rubio, Daniel (2009-02-12), Pro Spring Dynamic Modules for OSGi Service Platforms (First ed.), Apress, pp.  392, ISBN   978-1-4302-1612-4
• The OSGi Alliance (2003), OSGi Service Platform, Release 3, IOS Press, p. 604, ISBN   1-58603-311-5
• OSGi Service Platform, Core Specification, Release 4, Version 4.1, OSGi Alliance., 2007, p. 228, ISBN   978-90-79350-01-8
• OSGi Service Platform, Core Specification, Release 4, Version 4.2, OSGi Alliance., 2009, p. 332, ISBN   978-90-79350-04-9
• OSGi Service Platform, Service Compendium, Release 4, Version 4.1, OSGi Alliance., 2007, p. 594, ISBN   978-90-79350-02-5
• OSGi Service Platform, Mobile Specification, Release 4, Version 4, OSGi Alliance., 2007, p. 426, ISBN   978-90-79350-03-2
• Kirk Chen, Li Gong. (2001), Programming Open Service Gateways with Java Embedded Server(TM) Technology, Prentice Hall PTR, p. 480, ISBN   0-201-71102-8
• Kayode Odeyemi (2010), Building an OSGI Declarative Service with Maven using Netbeans
• BJ Hargrave (IBM) (2011), OSGi 4.3 Technical Update: What's new?, The Eclipse Foundation, archived from the original on 2011-06-21, retrieved 2011-06-11

External links

• Official website
• Oredev 2008 - Architecture - OSGi Now and Tomorrow
• Eclipse Equinox Article Index - Articles on an open source OSGi implementation