Plugin for sbt to to create OSGi bundles.
sbt-osgi is a plugin for sbt. In order to install sbt, please refer to the sbt documentation(0.13, 1.x). 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
- sbt-osgi 0.9 → sbt 0.13 / sbt 1.x
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.9.4")
If you want to use the latest and greatest features, you can instead have sbt depend on and locally build the current source snapshot by adding the following to your plugin definition file.
Example <PROJECT_ROOT>/project/plugins.sbt
:
lazy val plugins = (project in file("."))
.dependsOn(sbtOsgi)
// Other stuff
def sbtOsgi = uri("git://github.com/sbt/sbt-osgi.git")
As, since version 0.8.0
, sbt-osgi uses the sbt 0.13.5 Autoplugin feature, it can be enabled for individual projects like any other sbt Autoplugin. For more information on enabling and disabling plugins, refer to the sbt plugins tutorial.
To enable sbt-osgi for a specific Project, use the project instance enablePlugins(Plugins*)
method providing it with SbtOsgi
as a parameter value. If using only '.sbt' definition files with only the implicitly declared root project with sbt 0.13.5 you will be required to obtain a reference to the project by explicitly declaring it in your build file. This may easily be done using the project
macro, as shown in the example below. If using sbt 0.13.6 or greater, enablePlugins(Plugins*)
is directly available in .sbt
files.
Example <PROJECT_ROOT>/build.sbt
:
// sbt 0.13.5
lazy val fooProject = (project in file(".")) // Obtain the root project reference
.enablePlugins(SbtOsgi) // Enables sbt-osgi for this project. This will automatically append
// the plugin's default settings to this project thus providing the
// `osgiBundle` task.
// sbt 0.13.6+
enablePlugins(SbtOsgi) // No need to obtain root project reference on single project builds for sbt 0.13.6+
Example <PROJECT_ROOT>/project/Build.scala
:
import sbt._
import com.typesafe.sbt.SbtOsgi.autoImport._ // The autoImport object contains everything which would normally be
// imported automatically in '*.sbt' project definition files.
object Build extends sbt.Build {
lazy val fooProject = Project("foo-project", file("."))
.enablePlugins(SbtOsgi) // Enables sbt-osgi for this project. This will automatically append
// the plugin's default settings to this project thus providing the
// `osgiBundle` task.
}
To also override the default publish behaviour, also add the osgiSettings
settings to your project via your preferred method.
Example <PROJECT_ROOT>/build.sbt
:
// Other settings
osgiSettings
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
sbt-osgi can be configured with the following settings:
bundleActivator
: value forBundle-Activator
header, default isNone
bundleRequiredExecutionEnvironment
: value forBundle-RequiredExecutionEnvironment
header, default is an empty string.bundleSymbolicName
: value forBundle-SymbolicName
header, default isorganization
plusname
bundleVersion
: value forBundle-Version
header, default isversion
dynamicImportPackage
: values forDynamic-ImportPackage
header, default is the empty sequenceexportPackage
: values forExport-Package
header, default is the empty sequenceimportPackage
: values forImport-Package
header, default is*
fragmentHost
: value forFragment-Host
header, default isNone
privatePackage
: values forPrivate-Package
header, default isOsgiKeys.bundleSymbolicName
plus.*
requireBundle
: values forRequire-Bundle
header, default is the empty sequenceadditionalHeaders
: map of additional headers to be passed to BND, default is the empty sequenceembeddedJars
: list of dependencies to embed inside the bundle which are automatically added toBundle-Classpath
explodedJars
: list of jarfiles to explode into the bundlerequireCapability
: value forRequire-Capability
header, defaults toosgi.ee;filter:="(&(osgi.ee=JavaSE)(version=*PROJECT JAVAC VERSION*))"
failOnUndecidedPackage
: allows failing the build when a package is neither exported nor private (instead of silently dropping it),false
by default to be compatible with previous behaviour
Example build.sbt
:
organization := "com.typesafe.sbt"
name := "osgi.demo"
version := "1.0.0"
enablePlugins(SbtOsgi)
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")
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.
This code is open source software licensed under the Apache 2.0 License.