opensearch-project / opensearch-project/sql-jdbc

Manifest with OSGi Metadata

Open
#124 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

catch-all acknowledged enhancement
Dominant language
Java
Stars
28
Forks
39
PR merge metrics
No merged PRs in 30d

Description

Is your feature request related to a problem?
I want to use the jdbc driver in OSGi enviroments, but cant because it has not a proper Manifest

What solution would you like?
add Manifest Metadata . Minimum would be:

  • Bundle-SymbolicName (bare minimum)
  • Export-Package (that others could use the classes you export)

easiest way in build.gradle

Use the OSGi Spec complient tool bnd and let the tool generate the manifest for you

https://github.com/bndtools/bnd/blob/master/gradle-plugins/README.md


plugins {
        id 'biz.aQute.bnd.builder' version '6.4.0'
}

jar {
    bundle {
        bnd '''
            Bundle-SymbolicName: org.opensearch.jdbc
            Export-Package: org.opensearch.jdbc*
            Import-Package:  *
//maybe some marked as optional
            '''
  }
}

because of your shadow plugin i am not sure how to integrate in gradle

What alternatives have you considered?

Do you have any additional context?

Manifest-Version: 1.0
Bnd-LastModified: 1726578495191
Bundle-ManifestVersion: 2
Bundle-Name: org.opensearch.jdbc
Bundle-SymbolicName: org.opensearch.jdbc
Bundle-Version: 1.4.0.2
Created-By: 11.0.24 (Azul Systems, Inc.)
Export-Package: org.opensearch.jdbc;uses:="org.opensearch.jdbc.config,
 org.opensearch.jdbc.internal,org.opensearch.jdbc.internal.results,org
 .opensearch.jdbc.logging,org.opensearch.jdbc.protocol,org.opensearch.
 jdbc.transport";version="1.4.0",org.opensearch.jdbc.auth;version="1.4
 .0",org.opensearch.jdbc.config;uses:="org.opensearch.jdbc.auth,org.op
 ensearch.jdbc.logging";version="1.4.0",org.opensearch.jdbc.internal;v
 ersion="1.4.0",org.opensearch.jdbc.internal.exceptions;version="1.4.0
 ",org.opensearch.jdbc.internal.results;uses:="org.opensearch.jdbc.pro
 tocol,org.opensearch.jdbc.types";version="1.4.0",org.opensearch.jdbc.
 internal.util;version="1.4.0",org.opensearch.jdbc.logging;version="1.
 4.0",org.opensearch.jdbc.protocol;uses:="org.opensearch.jdbc,org.open
 search.jdbc.config,org.opensearch.jdbc.protocol.exceptions,org.opense
 arch.jdbc.transport";version="1.4.0",org.opensearch.jdbc.protocol.exc
 eptions;version="1.4.0",org.opensearch.jdbc.protocol.http;uses:="org.
 opensearch.jdbc,org.opensearch.jdbc.config,org.opensearch.jdbc.protoc
 ol,org.opensearch.jdbc.protocol.exceptions,org.opensearch.jdbc.transp
 ort,org.opensearch.jdbc.transport.http";version="1.4.0",org.opensearc
 h.jdbc.transport;uses:="org.opensearch.jdbc.config,org.opensearch.jdb
 c.logging";version="1.4.0",org.opensearch.jdbc.transport.http;uses:="
 org.opensearch.jdbc.config,org.opensearch.jdbc.logging,org.opensearch
 .jdbc.transport";version="1.4.0",org.opensearch.jdbc.transport.http.a
 uth.aws;version="1.4.0",org.opensearch.jdbc.types;version="1.4.0"
Require-Capability: osgi.ee;filter:="(&(osgi.ee=JavaSE)(version=1.8))"
Tool: Bnd-6.4.0.202211291949

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with build.gradle and the JDBC driver's existing shadow plugin configuration, then review how the bnd Gradle plugin could generate OSGi metadata. Compare the resulting jar manifest with the example in the issue, including Bundle-SymbolicName and exported packages. Done means the JDBC artifact has a usable OSGi manifest without breaking the existing shaded build.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
databases
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.