README.md

Gradle plugin for OSGi Declarative Services

master

Description

Easy to use gradle plugin to generate Declarative Services XML files based on the OSGi Service Component Annotations.

Maven coordinates

Group ID	Artifact ID	Version
org.jayware	gradle-osgi-ds	0.5.5

Usage

Example Gradle script

plugins {
    id 'org.jayware.osgi-ds' version '0.5.5'
}

apply plugin: 'java'
apply plugin: 'osgi'

apply plugin: 'osgi-ds'


dependencies {
    compileOnly 'org.osgi:org.osgi.service.component.annotations:1.3.0'
}

jar {
    manifest {
        instruction "Service-Component", "OSGI-INF/*.xml"
    }
}

Example OSGi Service

package example.api;

public interface Fubar
{
    void sayHello();
}

package example.impl;

import example.api.AnotherService;
import example.api.Fubar;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;

@Component(service = Fubar.class, name = "MySuperService", immediate = true)
public class FubarServiceImpl
implements Fubar
{
    private AnotherService anotherService;

    @Activate
    public void turnOn()
    {
        System.out.println("FubarService activated!");
    }

    @Override
    public void sayHello()
    {
        System.out.println("Hello World!");

        anotherService.doSomething();
    }

    @Reference
    public void bind(AnotherService service)
    {
        anotherService = service;
    }

    public void unbind(AnotherService service)
    {
        anotherService = null;
    }
}

Resulting DS file

<?xml version="1.0" encoding="UTF-8"?>
<scr:component xmlns:scr="http://www.osgi.org/xmlns/scr/v1.1.0" immediate="true" name="MySuperService" activate="turnOn">
    <service servicefactory="false">
        <provide interface="example.api.Fubar"/>
    </service>
    <reference name="" interface="example.api.AnotherService" cardinality="1..1" policy="static" bind="bind" unbind="unbind"/>
    <implementation class="example.impl.FubarServiceImpl"/>
</scr:component>

Contributions

All contributions are welcome: ideas, patches, documentation, bug reports, complaints.