Das OSGi Framework enRoute ist im September 2015 in Version 1.0 erschienen. enRoute-Erfinder und OSGi-Mastermind Peter Kriens stellt das Projekt in einer zweiteiligen Artikelserie vor. Nachdem sich Teil 1 mit den OSGi Best Practices beschäftigt hat, die enRoute zugrunde liegen, geht Teil 2 nun detailliert auf die Servicestruktur und die Tooling-Umgebung ein.
Nach unserer Einführung im ersten Teil dieser Serie wollen wir uns nun das OSGi-enRoute-Basis-API genauer anschauen. OSGi enRoute stellt ein JAR bereit, das eine minimale Umgebung für die Entwicklung einfacher Webanwendungen definiert (potenziell auch für IoT-Szenarien). Diese Umgebung kann natürlich die Basis für größere Webanwendungen sein, da wir es bei OSGi mit einem Komponentensystem zu tun haben. Das API benötigt Java 8, OSGi R6 und verschiedene Service Contracts aus dem OSGi-R6-Release; zudem werden einige Services vorausgesetzt, die speziell für OSGi enRoute entwickelt wurden.
Alle Service Contracts im OSGi-enRoute-Base-API sind im OSGi-enRoute-Servicekatalog beschrieben [1]. Dieser Katalog sollte Ihre erste Referenz sein, wenn Sie auf einen neuen Service treffen.
Obwohl die OSGi-Spezifikationen sehr gewissenhaft entworfen wurden, liegt ihr Schwerpunkt doch auf Seite der Implementierung einer Spezifikation. Der Servicekatalog ist hingegen auf die Nutzung einer Spezifikation ausgerichtet. Die OSGi-Spezifikationen kommen manchmal etwas formal daher und können für diejenigen, die sie einfach nur einsetzen möchten, etwas zu detailliert sein. Unsere Absicht mit enRoute ist es deshalb, jeden Eintrag in den Servicekatalog mit einer Beispielapplikation und Code-Snippets zu flankieren, die in eigene Anwendungen übernommen werden können. Noch benötigt der Katalog allerdings etwas mehr Arbeit bis zur Fertigstellung.
Aus dem OSGi R6 Compendium haben wir die Services aus Tabelle 1 aufgenommen (in alphabetischer Reihenfolge).
|
org.osgi.service.async |
Verwandelt synchrone Serviceaufrufe auf verteiltem OSGi in einen Promise-basierten Aufruf |
|
org.osgi.service.cm |
Configuration Admin, ein Schlüsselelement von OSGi zur Konfigurierung von Komponenten |
|
org.osgi.service.component |
Declarative-Services-API, wird nur selten benötigt |
|
org.osgi.service.coordinator |
Koordiniert eine Menge von Komponenten, die auf einen geteilten Request reagieren |
|
org.osgi.service.event |
Ein Publish- und Subscribe-Eventmechanismus |
|
org.osgi.service.http |
Ein HTTP-Server, der Servlets verarbeiten kann |
|
org.osgi.service.log |
Aggregiert das Logging; in enRoute ist SLF4J die empfohlene Logging-Lösung, von der sichergestellt wird, dass alles im OSGi Log Service landet |
|
org.osgi.service.metatype |
Typensprache für automatische User Interfaces |
|
org.osgi.service. remoteserviceadmin |
API zur Orchestrierung von verteiltem OSGi |
|
org.osgi.service.url |
Registrierung von URL Stream Handler zur Bereitstellung zusätzlicher URL-Schemata |
|
org.osgi.service.useradmin |
Eine Datenbank von Usern und Gruppen |
|
org.osgi.util.function |
Stellt ein funktionales Java-8-Interface für Funktionen bereit |
|
org.osgi.util.promise |
Ein grundlegender Baustein für asynchrones Processing |
|
org.osgi.util.tracker |
Low-Level-Support für das Tracken von Bundles und Services |
Tabelle 1: enRoute-Services aus OSGi R6 Compendium
Darüberhinaus haben wir eine Reihe neuer Services hinzugefügt, die wichtig für webbasierte Anwendungen sind, aber noch nicht Eingang in das OSGi-Kompendium gefunden haben. Die meisten dieser Services wurden bereits als RFPs eingereicht, um sie über den üblichen OSGi-Spezifikationsprozess zu standardisieren (Tabelle 2).
|
osgi.enroute.authentication.api |
Authentifiziert User derart, dass sie potenziell mit Web-Frontends zusammenarbeiten |
RFP 164 Authentication |
|
osgi.enroute.authorization.api |
Ein API für die Überprüfung, ob gewisse Aktionen auf Ressourcen von gewissen Usern ausgeführt werden können |
RFP 165 Authorization |
|
osgi.enroute.configurer.api |
Ein Extender, der Konfigurationsdaten von Bundles liest |
RFP 168 Configurer |
|
osgi.enroute.dto.api |
Ein mächtiger Datenconverter von DTOs und anderen Typen |
RFP 169 Object Conversion |
|
osgi.enroute.iot.admin.api |
Administriert die Geräte eines IoT-Devices | |
|
osgi.enroute.jsonrpc.api |
Wandelt einen Service in einen JSON-RPC-Server; erlaubt JavaScript, direkt Methoden auf dem Service aufzurufen |
RFP 172 Protocols |
|
osgi.enroute.launch.api |
Support für den Zugriff auf die Launch-Argumente | |
|
osgi.enroute.logger.api |
Ein Administrations-API für die dynamische Kontrolle des Loggings |
RFP 163 Log Update |
|
osgi.enroute.rest.api |
Wandelt einen Service in einen REST-Server, indem die Methodennamen als verb + URL interpretiert werden |
RFP 172 Protocols |
|
osgi.enroute.scheduler.api |
Ein mächtiger Delay- und Scheduler-Service inklusive Promises-Integration |
RFP 166 Scheduling |
Tabelle 2: enRoute-Services außerhalb des OSGi R6 Compendium
Das OSGi-enRoute-Basis-API enthält auch eine Reihe von Annotationen, um Webressourcen für Webanwendungen einzubinden. Diese Annotationen erzeugen die Requirements, die dann im Bundle-Manifest angegeben werden (Tabelle 3).
|
osgi.enroute.eventadminserversentevents.capabilities |
Eine JavaScript Library (und Java-Code) für die Übersetzung von OSGi-Event-Admin-Events in Server-sent Events im Browser; das ist der bevorzugte Weg, um das GUI von Java aus zu aktualisieren. |
|
osgi.enroute.google.angular.capabilities |
Libraries für das populäre JavaScript-Projekt AngularJS. |
|
osgi.enroute.stackexchange.pagedown.capabilities |
Eine Markdown-Komponente. |
|
osgi.enroute.twitter.bootstrap.capabilities |
Die Twitter-Bootstrap-Files. |
Tabelle 3: enRoute-Annotationen
In manchen Fällen ist OSGi so stark mit POJOs verwoben, dass in der Assemblierungsphase keine Abhängigkeiten erkannt werden und benötigte Ressourcen nicht einbezogen werden. Ein gutes Beispiel ist die Declarative Services Runtime. Die meisten Komponenten verfügen über keinerlei Kopplung zum Komponenten-API. In diesen Fällen fügt das Tooling (bnd) den Declarative Services automatisch ein Requirement hinzu, wenn die Komponentenannotationen verwendet werden. In anderen Fällen ist es allerdings nötig, explizit ein Subsystem anzufordern. OSGi enRoute stellt dafür die Subsystemannotationen aus Tabelle 4 bereit.
|
osgi.enroute.http.capabilities |
Wenn das HTTP-Whiteboard-Modell verwendet wird, wird diese Annotation eine Implementierung verlangen. Sie wird üblicherweise auf eine Servlet-Komponente angewandt. |
|
osgi.enroute.webserver.capabilities |
OSGi enRoute enthält ein Default Servlet, das statische Ressourcen von den Bundles liest. Es unterstützt auch das Coalescing einer verlangten Webressource in ein Single Include für die Anwendung. |
Tabelle 4: enRoute-Subsystem-Annotationen
Die OSGi enRoute Base Distro
Es dürfte mittlerweile klar geworden sein, dass das OSGi-enRoute-Base-API lediglich eine Spezifikation ist. Es bleibt das kleine Problem der Implementierungen. Manche OSGi-Mitglieder haben deutlich gemacht, dass sie keine offiziell unterstützte Runtime von OSGi wünschen, sondern stattdessen einen Anwendungsserver mit ihrer eigenen Runtime ausliefern möchten. Das hat das Modell stark in die...

