Fully automate OSGi metadata creation and fix brocken OSGi-metadata in slf4j-api (#330)

HannesWell · web-flow · commit 2235d3c69829 · 2023-03-15T21:28:25.000+01:00
* Improve generated OSGi metadata and restore Bundle-SymbolicName

Enhance the generated OSGi metadata for all slf4j-modules in the
following ways:
- Restore the Bundle-SymbolicName, Bundle-Name, Bundle-Vendor and
Bundle-DocURL from SLF4J-2.0.5 and before
- Removes Export-Package: META-INF.versions.9
- Removes self-Imports of exported package (has to be added again in a
follow up, where desired)
- Remove unnecessary BND-internal headers

Additionally move the maven-bundle-plugin configuration from the
execution configuration up into the configuration of the plugin so that
it can be easier overwritten in child-modules.

Signed-off-by: Hannes Wellmann &lt;wellmann.hannes1@gmx.net&gt;

* Automate OSGi metadata creation and restore package-exports of slf4j-api

Only use the maven-bundle-plugin to generate all OSGi metadata into
slf4j-api's Manifest.MF file. This unifies the resulting MANIFEST.MFs
that are currently partly generated and partly statically defined.

Furthermore it fixes the following flaws in the currently generated OSGi
metadata of slf4j-api:
- Import only the exported org.slf4j.spi package (like in slf4j 2.0.5
and before)
- Replace the deprecated 'Bundle-RequiredExecutionEnvironment' header by
a corresponding required 'osgi.ee' capability

Signed-off-by: Hannes Wellmann &lt;wellmann.hannes1@gmx.net&gt;

---------

Signed-off-by: Hannes Wellmann &lt;wellmann.hannes1@gmx.net&gt;
diff --git a/pom.xml b/pom.xml
@@ -241,24 +241,32 @@
         <groupId>org.apache.felix</groupId>
         <artifactId>maven-bundle-plugin</artifactId>
         <version>${maven-bundle-plugin.version}</version>
+        <configuration>
+          <supportIncrementalBuild>true</supportIncrementalBuild>
+          <!-- populated by the plugin itself -->
+          <instructions>
+			  <Bundle-SymbolicName>${replacestring;${project.artifactId};-;.}</Bundle-SymbolicName>
+			  <Bundle-Name>${project.artifactId}</Bundle-Name>
+			  <Bundle-Vendor>SLF4J.ORG</Bundle-Vendor>
+			  <_snapshot/>
+			  <_exportcontents>!META-INF.versions.9,*;-noimport:=true</_exportcontents>
+			  <Bundle-Description>${project.description}</Bundle-Description>
+			  <Bundle-DocURL>${project.url}</Bundle-DocURL>
+			  <X-Compile-Source-JDK>${maven.compiler.source}</X-Compile-Source-JDK>
+			  <X-Compile-Target-JDK>${maven.compiler.target}</X-Compile-Target-JDK>
+			  <Implementation-Version>${project.version}</Implementation-Version>
+			  <Implementation-Title>${project.artifactId}</Implementation-Title>
+			  <Multi-Release>true</Multi-Release>
+			  <_removeheaders>Private-Package,Bundle-SCM, Bundle-Developers, Include-Resource</_removeheaders>
+		  </instructions>
+        </configuration>
         <executions>
           <execution>
             <id>bundle-manifest</id>
             <phase>process-classes</phase>
             <goals>
               <goal>manifest</goal>
             </goals>
-            <configuration>
-              <instructions>
-                <!-- populated by the plugin itself -->
-                <Bundle-Version>${parsedVersion.osgiVersion}</Bundle-Version>
-                <Bundle-Description>${project.description}</Bundle-Description>
-                <X-Compile-Source-JDK>${maven.compiler.source}</X-Compile-Source-JDK>
-                <X-Compile-Target-JDK>${maven.compiler.target}</X-Compile-Target-JDK>
-                <Implementation-Version>${project.version}</Implementation-Version>
-                <Multi-Release>true</Multi-Release>
-              </instructions>
-            </configuration>
           </execution>
         </executions>
       </plugin>
diff --git a/slf4j-api/pom.xml b/slf4j-api/pom.xml
@@ -53,6 +53,20 @@
         </executions>
       </plugin>
 
+      <plugin>
+        <groupId>org.apache.felix</groupId>
+        <artifactId>maven-bundle-plugin</artifactId>
+        <configuration>
+          <instructions>
+            <Import-Package>org.slf4j.spi;version="${range;[===,+);${version;===;${maven_version;${project.version}}}}"</Import-Package>
+            <Require-Capability><![CDATA[
+              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"
+            ]]></Require-Capability>
+          </instructions>
+        </configuration>
+      </plugin>
+
     </plugins>
 
   </build>
diff --git a/slf4j-api/src/main/resources/META-INF/MANIFEST.MF b/slf4j-api/src/main/resources/META-INF/MANIFEST.MF
