sbt-osgi

Plugin for sbt to to create OSGi bundles.

Installing sbt-osgi

sbt-osgi is a plugin for sbt. In order to install sbt, please refer to the sbt documentation. Please make sure that you are using a suitable version of sbt:

• sbt-osgi 0.5 → sbt 0.12
• sbt-osgi 0.7 → sbt 0.13

As sbt-osgi is a plugin for sbt, it is installed like any other sbt plugin, that is by mere configuration: just add sbt-osgi to your global or local plugin definition. Global plugins are defined in ~/.sbt/<SBT_VERSION>/plugins/plugins.sbt and local plugins are defined in project/plugins.sbt in your project.

In order to add sbt-osgi as a plugin, just add the below setting to the relevant plugin definition, paying attention to blank lines between settings:

// Other stuff

addSbtPlugin("com.typesafe.sbt" % "sbt-osgi" % "0.7.0")

If you want to use the latest and greates features, you can also give the latest snapshot release a try:

// Other stuff

resolvers += Classpaths.sbtPluginSnapshots

addSbtPlugin("com.typesafe.sbt" % "sbt-osgi" % "0.8.0-SNAPSHOT")

Using sbt-osgi

Add the below line to your sbt build definition, which adds the task osgiBundle which creates an OSGi bundle for your project and also changes the publish task to publish an OSGi bundle instead of a raw JAR archive. Again, pay attention to the blank line between settings:

// Other stuff

osgiSettings

If you just want osgiBundle, i.e. don't want to change the behavior of publish:

// Other stuff

defaultOsgiSettings

Settings

sbt-osgi can be configured with the following settings:

• bundleActivator: value for Bundle-Activator header, default is None
• bundleSymbolicName: value for Bundle-SymbolicName header, default is organization plus name
• bundleVersion: value for Bundle-Version header, default is version
• dynamicImportPackage: values for Dynamic-ImportPackage header, default is the empty sequence
• exportPackage: values for Export-Package header, default is the empty sequence
• importPackage: values for Import-Package header, default is *
• fragmentHost: value for Fragment-Host header, default is None
• privatePackage: values for Private-Package header, default is OsgiKeys.bundleSymbolicName plus .*
• requireBundle: values for Require-Bundle header, default is the empty sequence
• additionalHeaders: map of additional headers to be passed to BND, default is the empty sequence
• embeddedJars: list of dependencies to embed inside the bundle which are automatically added to Bundle-Classpath

Example build.sbt:

organization := "com.typesafe.sbt"

name := "osgi.demo"

version := "1.0.0"

libraryDependencies += "org.osgi" % "org.osgi.core" % "4.3.0" % "provided"

osgiSettings

OsgiKeys.exportPackage := Seq("com.typesafe.sbt.osgidemo")

OsgiKeys.bundleActivator := Option("com.typesafe.sbt.osgidemo.internal.Activator")

Contribution policy

Contributions via GitHub pull requests are gladly accepted from their original author. Before we can accept pull requests, you will need to agree to the Typesafe Contributor License Agreement online, using your GitHub account - it takes 30 seconds.

License

This code is open source software licensed under the Apache 2.0 License.