OSGi - Jsoup imports its own packages

[bencebarna]

Hi!

I have noticed that with the current maven-bundle-plugin configuration the OSGi manifest is generated in way that Jsoup imports it's own packages. Is this being done on purpose?

I am asking because in my current project a 3rd-party bundle embeds and exports Jsoup (already notified the vendor not to do that) while the Jsoup bundle is also deployed standalone. The embedded Jsoup is a different version than the standalone one.

And in some cases, during deplyment, the standalone bundle imports the embedded Jsoup packages from the 3rd-party lib and exports them with that version. Making the version of the standalone packages unavailable.

[bencebarna]

Hi @jhy,

Any thoughts on this? 🙂

[jhy]

Doesn't it have to? The packages get imported because the are used by jsoup.

This is the Felix configuration:

<plugin>
        <groupId>org.apache.felix</groupId>
        <artifactId>maven-bundle-plugin</artifactId>
        <version>5.1.9</version>
        <executions>
          <execution>
            <id>bundle-manifest</id>
            <phase>process-classes</phase>
            <goals>
              <goal>manifest</goal>
            </goals>
          </execution>
        </executions>
        <configuration>
          <instructions>
            <Bundle-DocURL>https://jsoup.org/</Bundle-DocURL>
            <Export-Package>org.jsoup.*</Export-Package>
            <Import-Package>org.jspecify.annotations;version=!;resolution:=optional,*</Import-Package>
          </instructions>
        </configuration>
      </plugin>

And the resulting manifest:

Manifest-Version: 1.0
Created-By: Apache Maven Bundle Plugin 5.1.9
Build-Jdk-Spec: 17
Implementation-Title: jsoup Java HTML Parser
Implementation-Version: 1.18.1-SNAPSHOT
Implementation-Vendor: Jonathan Hedley
Multi-Release: true
Bnd-LastModified: 1704411886697
Bundle-Description: jsoup is a Java library that simplifies working with
  real-world HTML and XML. It offers an easy-to-use API for URL fetching
 , data parsing, extraction, and manipulation using DOM API methods, CSS
 , and xpath selectors. jsoup implements the WHATWG HTML5 specification,
  and parses HTML to the same DOM as modern browsers.
Bundle-DocURL: https://jsoup.org/
Bundle-License: https://jsoup.org/license
Bundle-ManifestVersion: 2
Bundle-Name: jsoup Java HTML Parser
Bundle-SymbolicName: org.jsoup
Bundle-Vendor: Jonathan Hedley
Bundle-Version: 1.18.1.SNAPSHOT
Export-Package: org.jsoup;uses:="javax.net.ssl,org.jsoup.helper,org.jsou
 p.nodes,org.jsoup.parser,org.jsoup.safety,org.jspecify.annotations";ver
 sion="1.18.1",org.jsoup.examples;uses:="org.jsoup.nodes";version="1.18.
 1",org.jsoup.helper;uses:="javax.net.ssl,javax.xml.parsers,org.jsoup,or
 g.jsoup.nodes,org.jsoup.parser,org.jsoup.select,org.jspecify.annotation
 s,org.w3c.dom";version="1.18.1",org.jsoup.internal;version="1.18.1",org
 .jsoup.nodes;uses:="org.jsoup,org.jsoup.parser,org.jsoup.select,org.jsp
 ecify.annotations";version="1.18.1",org.jsoup.parser;uses:="org.jsoup.n
 odes,org.jsoup.select,org.jspecify.annotations";version="1.18.1",org.js
 oup.safety;uses:="org.jsoup.nodes";version="1.18.1",org.jsoup.select;us
 es:="org.jsoup.nodes,org.jspecify.annotations";version="1.18.1"
Import-Package: org.jspecify.annotations;resolution:=optional,javax.net.
 ssl,javax.xml.namespace,javax.xml.parsers,javax.xml.transform,javax.xml
 .transform.dom,javax.xml.transform.stream,javax.xml.xpath,org.jsoup,org
 .jsoup.helper,org.jsoup.internal,org.jsoup.nodes,org.jsoup.parser,org.j
 soup.safety,org.jsoup.select,org.w3c.dom
Require-Capability: osgi.ee;filter:="(&(osgi.ee=JavaSE)(version=1.8))"
Tool: Bnd-6.3.1.202206071316

Is there a different configuration you would suggest?

[bencebarna]

I'd suggest adding !org.jsoup.* to the Import-Package. Like:

<Import-Package>!org.jsoup.*,org.jspecify.annotations;version=!;resolution:=optional,*</Import-Package>

This way the resulting manifest would be:

Manifest-Version: 1.0
Created-By: Apache Maven Bundle Plugin 5.1.9
Build-Jdk-Spec: 11
Implementation-Title: jsoup Java HTML Parser
Implementation-Version: 1.18.1-SNAPSHOT
Implementation-Vendor: Jonathan Hedley
Multi-Release: true
Bnd-LastModified: 1719840232180
Bundle-Description: jsoup is a Java library that simplifies working with
  real-world HTML and XML. It offers an easy-to-use API for URL fetching
 , data parsing, extraction, and manipulation using DOM API methods, CSS
 , and xpath selectors. jsoup implements the WHATWG HTML5 specification,
  and parses HTML to the same DOM as modern browsers.
Bundle-DocURL: https://jsoup.org/
Bundle-License: https://jsoup.org/license
Bundle-ManifestVersion: 2
Bundle-Name: jsoup Java HTML Parser
Bundle-SymbolicName: org.jsoup
Bundle-Vendor: Jonathan Hedley
Bundle-Version: 1.18.1.SNAPSHOT
Export-Package: org.jsoup;uses:="javax.net.ssl,org.jsoup.helper,org.jsou
 p.nodes,org.jsoup.parser,org.jsoup.safety,org.jspecify.annotations";ver
 sion="1.18.1",org.jsoup.examples;uses:="org.jsoup.nodes";version="1.18.
 1",org.jsoup.helper;uses:="javax.net.ssl,javax.xml.parsers,org.jsoup,or
 g.jsoup.nodes,org.jsoup.parser,org.jsoup.select,org.jspecify.annotation
 s,org.w3c.dom";version="1.18.1",org.jsoup.internal;version="1.18.1",org
 .jsoup.nodes;uses:="org.jsoup,org.jsoup.parser,org.jsoup.select,org.jsp
 ecify.annotations";version="1.18.1",org.jsoup.parser;uses:="org.jsoup.n
 odes,org.jsoup.select,org.jspecify.annotations";version="1.18.1",org.js
 oup.safety;uses:="org.jsoup.nodes";version="1.18.1",org.jsoup.select;us
 es:="org.jsoup.nodes,org.jspecify.annotations";version="1.18.1"
Import-Package: org.jspecify.annotations;resolution:=optional,javax.net.
 ssl,javax.xml.namespace,javax.xml.parsers,javax.xml.transform,javax.xml
 .transform.dom,javax.xml.transform.stream,javax.xml.xpath,org.w3c.dom
Require-Capability: osgi.ee;filter:="(&(osgi.ee=JavaSE)(version=1.8))"
Tool: Bnd-6.3.1.202206071316

Importing the exported packages is the default mode for maven-bundle-plugin. In general that is the recommendation for OSGi bundles. This way the framework may reduce the number of packages & classes available in cases when there are multiple versions of them installed in parallel: https://blog.osgi.org/2007/04/importance-of-exporting-nd-importing.html

However, Jsoup is not a "traditional" bundle:

• it's not separating it's api and implementation packages
• it exports its internal classes
• it does not provide nor consume any OSGi service.

It's a library bundle. And for the later I found the recommendation not to import its own packages:

• https://docs.osgi.org/whitepaper/semantic-versioning/050-exporter-policy.html#importing-the-packages-you-export
• https://felix.apache.org/documentation/tutorials-examples-and-presentations/apache-felix-osgi-faq.html#import-own-exports
• https://docs.redhat.com/en/documentation/red_hat_jboss_fuse/6.3/html/managing_osgi_dependencies/ImportExport#ImportExport-BundleTypes

[jhy]

Great, thanks for that. I have implemented that in #2158.

[bencebarna]

Cool. Thank you! 🙂