Chapter 66. The OSGi Plugin

Table of Contents

66.1. Usage
66.2. Implicitly applied plugins
66.3. Tasks
66.4. Convention object

The OSGi plugin provides a factory method to create an OsgiManifest object. OsgiManifest extends Manifest. To learn more about generic manifest handling, see Section 48.15.1, “Manifest”. If the Java plugins is applied, the OSGi plugin replaces the manifest object of the default jar with an OsgiManifest object. The replaced manifest is merged into the new one.

The OSGi plugin makes heavy use of the BND tool. A separate plugin implementation is maintained by the BND authors that has more advanced features.

66.1. Usage

To use the OSGi plugin, include the following in your build script:

Example 66.1. Using the OSGi plugin


apply plugin: 'osgi'

66.2. Implicitly applied plugins

Applies the Java base plugin.

66.3. Tasks

The OSGi plugin adds the following tasks to the project:

Table 66.1. OSGi plugin - tasks

Task name Depends on Type Description




Copies all classes from the main source set to a single directory that is processed by BND.

66.4. Convention object

The OSGi plugin adds the following convention object: OsgiPluginConvention

66.4.1. Convention properties

The OSGi plugin does not add any convention properties to the project.

66.4.2. Convention methods

The OSGi plugin adds the following methods. For more details, see the API documentation of the convention object.

Table 66.2. OSGi methods

Method Return Type Description



Returns an OsgiManifest object.

osgiManifest(Closure cl)


Returns an OsgiManifest object configured by the closure.

The classes in the classes dir are analyzed regarding their package dependencies and the packages they expose. Based on this the Import-Package and the Export-Package values of the OSGi Manifest are calculated. If the classpath contains jars with an OSGi bundle, the bundle information is used to specify version information for the Import-Package value. Beside the explicit properties of the OsgiManifest object you can add instructions.

Example 66.2. Configuration of OSGi MANIFEST.MF file


jar {
    manifest { // the manifest of the default jar is of type OsgiManifest
        name = 'overwrittenSpecialOsgiName'
        instruction 'Private-Package',
        instruction 'Bundle-Vendor', 'MyCompany'
        instruction 'Bundle-Description', 'Platform2: Metrics 2 Measures Framework'
        instruction 'Bundle-DocURL', ''
task fooJar(type: Jar) {
    manifest = osgiManifest {
        instruction 'Bundle-Vendor', 'MyCompany'    

The first argument of the instruction call is the key of the property. The other arguments form the value. To learn more about the available instructions have a look at the BND tool.