domino

Type Members

abstract class DominoActivator extends OsgiContext with CapsuleConvenience with BundleWatching with ConfigurationWatching with ServiceConsuming with ServiceProviding with ServiceWatching

This is the main entry point to the Domino DSL.

By having your bundle activator extend from this class, you get full access to the Domino DSL. In most cases DominoActivator is all you need because it mixes in all the other functionality.

Note that if you use watchServices or watchBundles, you might additionally want to import the relevant watcher events.

Example 1: Wait for a service

package org.example.domino_test_one

import domino.DominoActivator
import org.osgi.service.http.HttpService

class MyService(httpService: HttpService)

class Activator extends DominoActivator {
  whenBundleActive {
    // Make MyService available as long as HttpService is present
    whenServicePresent[HttpService] { httpService =>
      val myService = new MyService(httpService)
      myService.providesService[MyService]
    }
  }
}

Example 2: Listen for configuration changes

package org.example.domino_test_two

import domino.DominoActivator

class KeyService(key: String)

class Activator extends DominoActivator {
  whenBundleActive {
    // Reregister KeyService whenever configuration changes
    whenConfigurationActive("my_service") { conf =>
      val key = conf.get("key") map { _.asInstanceOf[String] } getOrElse "defaultKey"
      new KeyService(key).providesService[KeyService]
    }
  }
}

Note: I suggest extending from this class instead of mixing in the subpackage traits. Then you don't need to recompile your bundle if minor internal changes are made to Domino. This results in greater upwards compatibility.

trait DominoImplicits extends AnyRef

Provides common implicit conversions.
Provides common implicit conversions. This is used by the other traits.
trait EmptyBundleActivator extends BundleActivator

A bundle activator which contains empty start and stop methods.
A bundle activator which contains empty start and stop methods. This is the basis for the trait OsgiContext which hooks into the start and stop methods.

See also
Stackable Trait Pattern
trait OsgiContext extends DynamicCapsuleContext with EmptyBundleActivator

Provides the basis for the Domino DSL by binding the bundle lifecycle to a capsule scope.
Provides the basis for the Domino DSL by binding the bundle lifecycle to a capsule scope.

See also
domino.capsule
class RichServiceReference[S <: AnyRef] extends AnyRef

Wrapper for a service reference which adds methods to resolve the corresponding service.

Value Members

object DominoUtil

Contains utility methods used throughout Domino.
package bundle_watching

Contains functionality related to watching OSGi bundles coming and going.
package capsule

Contains a basic API and default implementation for building, using and extending a capsule-based DSL.
Contains a basic API and default implementation for building, using and extending a capsule-based DSL.
A capsule-based DSL is a generalization of the DSL used in the project "Domino". Here's an illustrative example how a capsuled-based DSL might look like:
```
// Somewhere in your code
whenTurnedOn {
  whenDevicePluggedIn {
    lightLED()
  }
}
```
The documentation distinguishes between 3 types of API clients: End users, capsule providers and context providers. The majority of developers will just come into contact with this API as end users.
package configuration_watching

Contains functionality related to watching OSGi configuration changes.
package internal
package logging

Contains functionality related to OSGi logging.
package scala_logging

Contains a simple Scala API for logging along with a Java Logging API implementation.
Contains a simple Scala API for logging along with a Java Logging API implementation.
The generic logging interface is provided by the Logger trait. Implementations for various logging frameworks such as SLF4J or OSGi LogService are provided in separate modules.
See JavaUtilLogging for a convenient way to use Java Logging API.
package scala_osgi_metatype

Contains Scala interfaces, adapters and builders for easily building OSGi Metatype descriptions.
Contains Scala interfaces, adapters and builders for easily building OSGi Metatype descriptions. OSGi Metatype descriptions are very well suited for quickly providing administration user interfaces.
You probably want to check out the builders.

Note
I created totally new Scala interfaces and adapters instead of directly implementing the Java interfaces of the OSGi Metatype API in order to prevent name clashes and confusion about what method to call. Scala Swing does it the same way, I guess for the same reasons.
package service_consuming

Contains functionality related to acquiring OSGi services.
package service_providing

Contains functionality related to registering objects in the OSGi service registry.
package service_watching

Contains functionality related to watching OSGi services coming and going.

package domino

Type Members

abstract class DominoActivator extends OsgiContext with CapsuleConvenience with BundleWatching with ConfigurationWatching with ServiceConsuming with ServiceProviding with ServiceWatching

Example 1: Wait for a service

Example 2: Listen for configuration changes

trait DominoImplicits extends AnyRef

trait EmptyBundleActivator extends BundleActivator

trait OsgiContext extends DynamicCapsuleContext with EmptyBundleActivator

class RichServiceReference[S <: AnyRef] extends AnyRef

Value Members

object DominoUtil

package bundle_watching

package capsule

package configuration_watching

package internal

package logging

package scala_logging

package scala_osgi_metatype

package service_consuming

package service_providing

package service_watching

Inherited from AnyRef

Inherited from Any

Ungrouped