Generate SPI-files and OSGi 'Service Loader Mediator' capabilities

... using bnd-annotation for all SLF4JServiceProvider implementations, which are loaded using the ServiceLoader mechanism. Signed-off-by: Hannes Wellmann <wellmann.hannes1@gmx.net>
qos-ch · Dec 18, 2022 · 7ecfc23 · 7ecfc23
1 parent 22e94d6
commit 7ecfc23
Show file tree

Hide file tree

Showing 15 changed files with 26 additions and 76 deletions.
diff --git a/pom.xml b/pom.xml
@@ -95,6 +95,12 @@
       <version>${junit.version}</version>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>biz.aQute.bnd</groupId>
+      <artifactId>biz.aQute.bnd.annotation</artifactId>
+      <version>${bnd.version}</version>
+      <scope>provided</scope>
+    </dependency>
   </dependencies>
 
   <dependencyManagement>

diff --git a/slf4j-api/pom.xml b/slf4j-api/pom.xml
@@ -59,9 +59,6 @@
         <configuration>
           <bnd><![CDATA[
             Import-Package: org.slf4j.spi;version="${range;[===,+);${version;===;${maven_version;${project.version}}}}"
-            Require-Capability: \
-              osgi.extender;filter:="(&(osgi.extender=osgi.serviceloader.processor)(version>=1.0.0)(!(version>=2.0.0)))",\
-              osgi.serviceloader;filter:="(osgi.serviceloader=org.slf4j.spi.SLF4JServiceProvider)";osgi.serviceloader="org.slf4j.spi.SLF4JServiceProvider"
           ]]></bnd>
         </configuration>
       </plugin>

diff --git a/slf4j-api/src/main/java/org/slf4j/LoggerFactory.java b/slf4j-api/src/main/java/org/slf4j/LoggerFactory.java
@@ -46,7 +46,7 @@
 import org.slf4j.helpers.Util;
 import org.slf4j.spi.SLF4JServiceProvider;
 
-import javax.accessibility.AccessibleComponent;
+import aQute.bnd.annotation.spi.ServiceConsumer;
 
 /**
  * The <code>LoggerFactory</code> is a utility class producing Loggers for
@@ -66,6 +66,7 @@
  * @author Ceki G&uuml;lc&uuml;
  * 
  */
+@ServiceConsumer(SLF4JServiceProvider.class)
 public final class LoggerFactory {
 
     static final String CODES_PREFIX = "https://www.slf4j.org/codes.html";

diff --git a/slf4j-jdk14/pom.xml b/slf4j-jdk14/pom.xml
@@ -35,24 +35,4 @@
     </dependency>
   </dependencies>
 
-  <build>
-    <plugins>
-
-      <plugin>
-        <groupId>biz.aQute.bnd</groupId>
-        <artifactId>bnd-maven-plugin</artifactId>
-        <configuration>
-          <bnd><![CDATA[
-            Provide-Capability: \
-              osgi.service;objectClass:List<String>="org.slf4j.spi.SLF4JServiceProvider";type=jul;effective:=active,\
-              osgi.serviceloader;osgi.serviceloader="org.slf4j.spi.SLF4JServiceProvider";register:="org.slf4j.jul.JULServiceProvider";type=jul
-            Require-Capability: \
-              osgi.extender;filter:="(&(osgi.extender=osgi.serviceloader.registrar)(version>=1.0.0)(!(version>=2.0.0)))"
-          ]]></bnd>
-        </configuration>
-      </plugin>
-
-    </plugins>
-  </build>
-
 </project>
diff --git a/slf4j-jdk14/src/main/java/org/slf4j/jul/JULServiceProvider.java b/slf4j-jdk14/src/main/java/org/slf4j/jul/JULServiceProvider.java
@@ -7,6 +7,9 @@
 import org.slf4j.spi.MDCAdapter;
 import org.slf4j.spi.SLF4JServiceProvider;
 
+import aQute.bnd.annotation.spi.ServiceProvider;
+
+@ServiceProvider(value = SLF4JServiceProvider.class, attribute = { "type=jul" })
 public class JULServiceProvider implements SLF4JServiceProvider {
 
     /**
@@ -30,6 +33,7 @@ public IMarkerFactory getMarkerFactory() {
         return markerFactory;
     }
 
+    @Override
     public MDCAdapter getMDCAdapter() {
         return mdcAdapter;
     }

diff --git a/slf4j-jdk14/src/main/resources/META-INF/services/org.slf4j.spi.SLF4JServiceProvider b/slf4j-jdk14/src/main/resources/META-INF/services/org.slf4j.spi.SLF4JServiceProvider
diff --git a/slf4j-nop/pom.xml b/slf4j-nop/pom.xml
@@ -28,24 +28,4 @@
     </dependency>
   </dependencies>
 
-  <build>
-    <plugins>
-
-      <plugin>
-        <groupId>biz.aQute.bnd</groupId>
-        <artifactId>bnd-maven-plugin</artifactId>
-        <configuration>
-          <bnd><![CDATA[
-            Provide-Capability: \
-              osgi.service;objectClass:List<String>="org.slf4j.spi.SLF4JServiceProvider";type=nop;effective:=active,\
-              osgi.serviceloader;osgi.serviceloader="org.slf4j.spi.SLF4JServiceProvider";register:="org.slf4j.nop.NOPServiceProvider";type=nop
-            Require-Capability: \
-              osgi.extender;filter:="(&(osgi.extender=osgi.serviceloader.registrar)(version>=1.0.0)(!(version>=2.0.0)))"
-          ]]></bnd>
-        </configuration>
-      </plugin>
-
-    </plugins>
-  </build>
-
 </project>
diff --git a/slf4j-nop/src/main/java/org/slf4j/nop/NOPServiceProvider.java b/slf4j-nop/src/main/java/org/slf4j/nop/NOPServiceProvider.java
@@ -8,6 +8,9 @@
 import org.slf4j.spi.MDCAdapter;
 import org.slf4j.spi.SLF4JServiceProvider;
 
+import aQute.bnd.annotation.spi.ServiceProvider;
+
+@ServiceProvider(value = SLF4JServiceProvider.class, attribute = { "type=nop" })
 public class NOPServiceProvider implements SLF4JServiceProvider {
 
     /**
@@ -21,14 +24,17 @@ public class NOPServiceProvider implements SLF4JServiceProvider {
     private final IMarkerFactory markerFactory = new BasicMarkerFactory();
     private final MDCAdapter mdcAdapter = new NOPMDCAdapter();
 
+    @Override
     public ILoggerFactory getLoggerFactory() {
         return loggerFactory;
     }
 
+    @Override
     public IMarkerFactory getMarkerFactory() {
         return markerFactory;
     }
 
+    @Override
     public MDCAdapter getMDCAdapter() {
         return mdcAdapter;
     }
@@ -38,9 +44,9 @@ public String getRequestedApiVersion() {
         return REQUESTED_API_VERSION;
     }
 
+    @Override
     public void initialize() {
 
     }
 
-
 }
diff --git a/slf4j-nop/src/main/resources/META-INF/services/org.slf4j.spi.SLF4JServiceProvider b/slf4j-nop/src/main/resources/META-INF/services/org.slf4j.spi.SLF4JServiceProvider
diff --git a/slf4j-reload4j/pom.xml b/slf4j-reload4j/pom.xml
@@ -66,11 +66,6 @@
             Import-Package: \
               org.apache.log4j;version="${range;[==,+)}",\
               org.slf4j.*
-            Provide-Capability: \
-              osgi.service;objectClass:List<String>="org.slf4j.spi.SLF4JServiceProvider";type=reload4j;effective:=active,\
-              osgi.serviceloader;osgi.serviceloader="org.slf4j.spi.SLF4JServiceProvider";register:="org.slf4j.reload4j.Reload4jServiceProvider";type=reload4j
-            Require-Capability: \
-              osgi.extender;filter:="(&(osgi.extender=osgi.serviceloader.registrar)(version>=1.0.0)(!(version>=2.0.0)))"
           ]]></bnd>
         </configuration>
       </plugin>

diff --git a/slf4j-reload4j/src/main/java/org/slf4j/reload4j/Reload4jServiceProvider.java b/slf4j-reload4j/src/main/java/org/slf4j/reload4j/Reload4jServiceProvider.java
@@ -8,6 +8,9 @@
 import org.slf4j.spi.MDCAdapter;
 import org.slf4j.spi.SLF4JServiceProvider;
 
+import aQute.bnd.annotation.spi.ServiceProvider;
+
+@ServiceProvider(value = SLF4JServiceProvider.class, attribute = { "type=reload4j" })
 public class Reload4jServiceProvider implements SLF4JServiceProvider {
 
     /**
@@ -42,13 +45,11 @@ public ILoggerFactory getLoggerFactory() {
         return loggerFactory;
     }
 
-
     @Override
     public IMarkerFactory getMarkerFactory() {
         return markerFactory;
     }
 
-
     @Override
     public MDCAdapter getMDCAdapter() {
         return mdcAdapter;

diff --git a/slf4j-reload4j/src/main/resources/META-INF/services/org.slf4j.spi.SLF4JServiceProvider b/slf4j-reload4j/src/main/resources/META-INF/services/org.slf4j.spi.SLF4JServiceProvider
diff --git a/slf4j-simple/pom.xml b/slf4j-simple/pom.xml
@@ -35,24 +35,4 @@
     </dependency>
   </dependencies>
 
-  <build>
-    <plugins>
-
-      <plugin>
-        <groupId>biz.aQute.bnd</groupId>
-        <artifactId>bnd-maven-plugin</artifactId>
-        <configuration>
-          <bnd><![CDATA[
-            Provide-Capability: \
-              osgi.service;objectClass:List<String>="org.slf4j.spi.SLF4JServiceProvider";type=simple;effective:=active,\
-              osgi.serviceloader;osgi.serviceloader="org.slf4j.spi.SLF4JServiceProvider";register:="org.slf4j.simple.SimpleServiceProvider";type=simple
-            Require-Capability: \
-              osgi.extender;filter:="(&(osgi.extender=osgi.serviceloader.registrar)(version>=1.0.0)(!(version>=2.0.0)))"
-          ]]></bnd>
-        </configuration>
-      </plugin>
-
-    </plugins>
-  </build>
-
 </project>
diff --git a/slf4j-simple/src/main/java/org/slf4j/simple/SimpleServiceProvider.java b/slf4j-simple/src/main/java/org/slf4j/simple/SimpleServiceProvider.java
@@ -7,6 +7,9 @@
 import org.slf4j.spi.MDCAdapter;
 import org.slf4j.spi.SLF4JServiceProvider;
 
+import aQute.bnd.annotation.spi.ServiceProvider;
+
+@ServiceProvider(value = SLF4JServiceProvider.class, attribute = { "type=simple" })
 public class SimpleServiceProvider implements SLF4JServiceProvider {
 
     /**
@@ -20,6 +23,7 @@ public class SimpleServiceProvider implements SLF4JServiceProvider {
     private IMarkerFactory markerFactory;
     private MDCAdapter mdcAdapter;
 
+    @Override
     public ILoggerFactory getLoggerFactory() {
         return loggerFactory;
     }

diff --git a/slf4j-simple/src/main/resources/META-INF/services/org.slf4j.spi.SLF4JServiceProvider b/slf4j-simple/src/main/resources/META-INF/services/org.slf4j.spi.SLF4JServiceProvider