From d0e5f3cbe9eb4532e3d777d319f6c314363e42b8 Mon Sep 17 00:00:00 2001 From: Patrik Nordwall Date: Tue, 12 Nov 2013 16:10:13 +0100 Subject: [PATCH] =doc Add dependency and sample to osgi docs --- akka-docs/rst/additional/osgi.rst | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/akka-docs/rst/additional/osgi.rst b/akka-docs/rst/additional/osgi.rst index 3bedc8c7dd..a87590f341 100644 --- a/akka-docs/rst/additional/osgi.rst +++ b/akka-docs/rst/additional/osgi.rst @@ -1,6 +1,14 @@ Akka in OSGi ============ +In an OSGi environment the ``akka-osgi`` bundle replaces ``akka-actor`` artifact. It includes all classes from ``akka-actor`` and merged ``reference.conf`` files from all akka modules. The dependency is:: + + + com.typesafe.akka + akka-osgi_@binVersion@ + @version@ + + Configuring the OSGi Framework ------------------------------ @@ -8,15 +16,15 @@ To use Akka in an OSGi environment, the ``org.osgi.framework.bootdelegation`` property must be set to always delegate the ``sun.misc`` package to the boot classloader instead of resolving it through the normal OSGi class space. - Activator --------- -To bootstrap Akka inside an OSGi environment, you can use the akka.osgi.AkkaSystemActivator class +To bootstrap Akka inside an OSGi environment, you can use the ``akka.osgi.AkkaSystemActivator`` class to conveniently set up the ActorSystem. .. includecode:: code/osgi/Activator.scala#Activator +The ``AkkaSystemActivator`` class is included in the ``akka-osgi`` artifact. Blueprint --------- @@ -25,3 +33,17 @@ For the Apache Aries Blueprint implementation, there's also a namespace handler is http://akka.io/xmlns/blueprint/v1.0.0 and it can be used to set up an ActorSystem. .. includecode:: code/osgi/blueprint.xml + +The blueprint is included in the ``akka-osgi-aries`` artifact:: + + + com.typesafe.akka + akka-osgi-aries_@binVersion@ + @version@ + + +Sample +------ + +A complete sample project is provided in `akka-sample-osgi-dining-hakkers <@github@/akka-samples/akka-sample-osgi-dining-hakkers>`_. +