OSGI BASICS

S Y S T E M I N T E G R AT I O N W I T H J B O S S

Mar tin Basovnik

OSGI TECHNOLOGY
Open Services Gateway initiative (obsolete)
Set of specifications (last v6, 2014)
Managed by OSGi Alliance
Modular system and a service platform for the Java
programming language
Implements a complete and dynamic component model
Applications or components, coming in the form of bundles
Bundles have lifecycle
"Service Oriented Architecture" in JVM
Enterprise ready system (web bundles)
OSGI ARCHITECTURE
Key layers
Modules
Life Cycle
Services
Execution Environment
Defines what methods and classes are available in a specific platform.
OSGI USAGE
Main implementations
Apache Felix
Eclipse Equinox (reference implementation)
Knopflerfish
Usage
Middleware products
Apache Karaf
JBoss Fuse
JBoss EAP - Red Hat's JBoss Application Server
GlassFish (v3) - Application server for Java EE
Weblogic - Oracle Weblogic Application Server
WebSphere - IBM Websphere JEE Application Server
Liferay - Free and open source enterprise por tal platform
IDE (Integrated Development Environment)
Eclipse
Netbeans
IntelliJ
APACHE KARAF CONTAINER
Small OSGi based runtime
Lightweight container
Various components and applications can be deployed ( jar, war)
Based on Apache Felix
Features:
Hot deployment ([home]/deploy)
Dynamic configuratio ([home]/etc)
Logging System (centralised, Log4J)
Provisioning (mvn, http, file etc.)
Extensible Shell console
Remote access (ssh)
Security framework (JAAS)
Managing multiple instances
APACHE KARAF (2)
S C R E E N S H OT
BUNDLE
Basic module in OSGi container
= JAR archive + OSGI metadata
OSGi metadata
Proper ties in META-INF/MANIFEST.MF file
Bundle unique static identification
Symbolic name + version
MANIFEST HEADERS
Non-OSGi headers
Manifest-Version, Build-Jdk, Build-By, Main-Class
OSGI headers
Mandatory
Bundle-SymbolicName
Bundle-Version
Bundle-ManifestVersion (the only value is "2")
Optional
Human readable
Bundle-Name
Bundle-Description
Bundle-Vendor
Lifecycle
Bundle-Activator
Modules
Export-Package
Import-Package
Bundle-ClassPath (default value is ".")
MANIFEST EXAMPLE
Bundle-Name: Hello World
Bundle-SymbolicName: org.wikipedia.helloworld
Bundle-Description: A Hello World bundle
Bundle-ManifestVersion: 2
Bundle-Version: 1.0.0
Bundle-Activator: org.wikipedia.Activator
Export-Package: org.wikipedia.helloworld;version="1.0.0"
Import-Package: org.osgi.framework;version="1.3.0"
OSGI PACKAGES
Export package
Provided package for other bundles
Proper ty "version" - single value
Import package
Missing package
Proper ty "version" - interval (always!)
no version → 0.0.0 <= x <= max
"1.2" → 1.2.0 <= x <= max
"[2.1, 3)" → 2.1 <= x < 3

Question: Is it possible to to require only single version?

MANIFEST GENERATOR
BND tool
Simplifies bundle creation
Generates OSGi metadata semi-automatically
Syntactic sugars
Impor t-Package: com.library.*; version = 1.21
Maven bundle plugin
Uses BND tool internally

<plugin>
<groupId>org.apache.felix</groupId>
<ar tifactId>maven-bundle-plugin</ar tifactId>
<extensions>true</extensions>
<configuration>
<instructions>
<Bundle-Activator>org.wikipedia.Activator</Bundle-Activator>
</instructions>
</configuration>
</plugin>
IMPORT PACK. PRIORITIES
RESOLVED bundle state has precedence before INSTALLED
Greater versions have precedence
Property match (e.g. vendor="sun")
Directive "uses:=<package-name>"

Question: Why HTTP client will not be resolved if other

bundles are resolved?
OSGI CLASSLOADING
Every bundle has its own classloader
Classloader's structure is Map
One item for each imported package
key - Package name
value - Another classloder
There is no delegation of requests to parent classloaders
Class searching
1. java.*
2. Import packages (Import-Package)
3. Own packages (Bundle-ClassPath)
OSGI LIFECYCLE

Demo 1 : Bundle events

BUNDLE ACTIVATORS
Connected with states STARTING and STOPPING
Activators implement interface
org.osgi.framework.BundleActivator
OSGi header "Bundle-Activator" in MANIFEST.MF
Often used for OSGi services registrations

public interface BundleActivator {

public void start(BundleContext context) throws Exception;
public void stop(BundleContext context) throws Exception;
}
OSGI SERVICES
"SOA" in JVM
Advantages
Less coupling
Multiple implementations
Every service has contract (one or more interfaces)
Service registration
Activator
Component framework
Service discovery
Contract + service properties (LDAP syntax)
Service priority
1. Atribute "service.ranking"
2. Attribute "service.id"
SERVICE REGISTRATION
public class Activator implements BundleActivator {

private ServiceRegistration registration;

public void star t(BundleContext ctx) {

Dictionary props = new Proper ties();
props.put("service.ranking", 1);
registration = ctx.registerService(Foo.class.getName(),
new FooImpl(), props);
}

public void stop(BundleContext ctx) {

registration.unregister();
}
}
LISTENERS
Bundle listener
Tracks bundle events (STARTED, STOPPED, UPDATED, ...)
Used in BundleTracker (advanced bundle monitoring)

p u b l i c i n t e r f a c e B u n d l e L i s t e n e r ex t e n d s Eve n t L i s t e n e r {

p u b l i c vo i d b u n d l e C h a n g e d ( B u n d l e Eve n t e ve n t ) ;
}

Service listener
Tracks service events (REGISTERED, MODIFIED, ...)
Used in ServiceTracker (advanced service monitoring)

p u b l i c i n t e r f a c e S e r v i c e L i s t e n e r ex t e n d s Eve n t L i s t e n e r {

p u b l i c vo i d s e r v i c e C h a n g e d ( S e r v i c e Eve n t e ve n t ) ;
}

Demo 2 : Paint application (OSGi in Action)

COMPONENT FRAMEWORKS
Simplifies creation of logical components (e.g. OSGi service, java
beans, ...)
Frameworks are based on OSGi listeners
Component definition
XML descriptor
Declarative Services, Blueprint, Spring DS
Java annotations
Apache Felix iPojo
BLUEPRINT
Specification of OSGi component framework
Specification managed by OSGi Aliance
Uses dependency injection
Designed to deal with the dynamic nature of OSGi
Services can become available and unavailable at any time.
Uses proxy objects
Each bundle has own Blueprint container
Uses OSGi extender pattern
Extension definition
1. OSGI-INF/blueprint/*.xml
2. "Bundle-Blueprint" property in MANIFEST.MF
Implementations
Apache Aries
Eclipse Gemini (reference implementation)
BLUEPRINT DESCRIPTOR
XML elements
Main
<bean>, <service>, <reference>, <reference-list>
Other
<value>, <ref>, <idref>, <map>, <props>, <list>, <array>, ...

< ? x m l ve r s i o n = " 1 . 0 " e n c o d i n g = " U T F - 8 " ? >

< b l u e p r i n t x m l n s : xs i = " h t t p : / / w w w.w3 .o rg / 2 0 0 1 /X M L S c h e m a - i n s t a n c e "
x m l n s = " h t t p : / / w w w.o s g i .o rg /x m l n s / b l u e p r i n t / v 1 . 0 . 0 " >

< re fe re n c e i d = " b a z Re f " i n t e r f a c e = " B a z " / >

< b e a n i d = " b a r I m p l Re f " c l a s s = " B a r I m p l " >

< p ro p e r t y n a m e = " b a z " re f = " b a z Re f " / >
</bean>

< s e r v i c e i n t e r f a c e = " Fo o " re f = " b a r I m p l Re f " ra n k i n g = " 1 " >

< s e r v i c e - p ro p e r t i e s >
< e n t r y ke y = " p ro p " va l u e = " fo o b a r " / >
< / s e r v i c e - p ro p e r t i e s >
</service>
</blueprint>
SPRING DM
Spring DM = Spring Dynamic Modules
An open source project in the Spring portfolio
Allows to implement Spring Applications on top of an OSGi framework
Connects the benefits of both technologies
Spring - Component management, AOP, Dependency Injection, ...
OSGi - Dynamic environment
Each bundle has own Spring container
Spring beans can be exported as OSGi services
Uses OSGi extender pattern
Extension definition
META-INF/spring/*.xml
"Spring-Context" property in MANIFEST.MF
SPRING DESCRIPTOR
< ? x m l ve r s i o n = " 1 . 0 " e n c o d i n g = " U T F - 8 " ? >
< b e a n s x m l n s = " h t t p : / / w w w. s p r i n g f ra m e w o r k .o rg /s c h e m a / b e a n s "
x m l n s : xs i = " h t t p : / / w w w.w3 .o rg / 2 0 0 1 /X M L S c h e m a - i n s t a n c e "
x m l n s : o s g i = " h t t p : / / w w w. s p r i n g f ra m e w o r k .o rg /s c h e m a /o s g i " >

< o s g i : re fe re n c e i d = " b a z Re f " i n t e r f a c e = " B a z " / >

< b e a n i d = " b a r I m p l Re f " c l a s s = " B a r I m p l " >

< p ro p e r t y n a m e = " b a z " re f = " b a z Re f " / >
</bean>

< o s g i : s e r v i c e i n t e r f a c e = " Fo o " re f = " s i m p l e S e r v i c e " ra n k i n g = " 3 " >

< o s g i : s e r v i c e - p ro p e r t i e s >
< e n t r y ke y = " p ro p " va l u e = " fo o b a z " / >
< / o s g i : s e r v i c e - p ro p e r t i e s >
</osgi:service>

</beans>
OSGI ENTERPRISE
Web applications
web.xml
Web-ContextPath in MANIFEST.MF
Dependency Injection
Blueprint
Spring
JNDI
osgi:service/<interface>[/<proper ties>]
Service proper ty "osgi.jndi.service.name" for custom JNDI names
osgi:service/<jndi-name>
JPA, JDBC
problems with dynamic classpath
solution: OSGi services (Datasources, EntityManagers)
persistence.xml ("Meta-Persistence" in MANIFEST.MF)
container/aplication managed
JTA
container/aplication managed
OSGI ENTERPRISE (2)
Blueprint + JPA + Transactions

< b l u e p r i n t x m l n s = " h t t p : / / w w w.o s g i .o rg /x m l n s / b l u e p r i n t / v 1 . 0 . 0 "

x m l n s : j p a = " h t t p : / /a r i e s . a p a c h e .o rg /x m l n s / j p a / v 1 . 0 . 0 "
x m l n s : t x = " h t t p : / /a r i e s . a p a c h e .o rg /x m l n s / t ra n s a c t i o n s / v 1 . 0 . 0 " >

< b e a n i d = " i nve n t o r y " c l a s s = " f a n cy fo o d s . p e r s i s t e n c e . I nve n t o r y I m p l " >

< t x : t ra n s a c t i o n m e t h o d = " * " va l u e = " Re q u i re d " / >
< j p a : c o n t ex t p ro p e r t y = " e n t i t y M a n a g e r " u n i t n a m e = " f a n cy fo o d s " / >
</bean>

< s e r v i c e re f = " i nve n t o r y " i n t e r f a c e = " f a n cy fo o d s . fo o d . I nve n t o r y " / >

</blueprint>
OSGI ENTERPRISE (3)
Enterprise archives
Java EE
EAR archives (Enterprise archives)
OSGi
ESA
Enterprise Subsystem Archives
no application.xml but SUBSYSTEM.MF
Dependencies do not have to be contained in archive
EBA
Enterprise Bundle Archive
similar to ESA (from Aries)
Features
XML descriptor (from Apache)
REFERENCES
OSGi in Action - Richard S. Hall, Karl Pauls, Stuart McCulloch, David
Savage
Enterprise OSGi in Action - Holly Cummins, Timothy Ward
Spring in Action - Craig Walls
Spring Dynamic Modules in Action - Arnaud Cogoluegnes, Thierry
Templier, Andy Piper
http://www.osgi.org/Specifications
THANK YOU!