A Maven POM can be viewed as the root node in an artifact transitive dependency graph. The Bnd Pom Repository plugin reads this graph and provides the set of artifacts as a bnd repository. The purpose of this plugin is to be able to have a single dependency definition that can be used by Maven projects and bnd projects.
The pom can be a file on the local file system, a URL, a group, artifact, version (GAV) coordinate, or a query expression on maven central.
One can express dependencies in a pom.xml
file:
<dependencies>
<dependency>
<groupId>org.osgi</groupId>
<artifactId>osgi.enroute.base.api</artifactId>
<version>2.0.0</version>
</dependency>
<dependency>
<groupId>org.osgi</groupId>
<artifactId>osgi.enroute.pom.distro</artifactId>
<version>2.0.0</version>
</dependency>
</dependencies>
In a bndrun file in the same directory we can now use this pom.xml
file as our repository:
-standalone: true
-plugin.enroute-distro = \
aQute.bnd.repository.maven.pom.provider.BndPomRepository; \
snapshotUrl=https://oss.sonatype.org/content/repositories/osgi/; \
releaseUrl=https://repo.maven.apache.org/maven2/; \
pom=${.}/pom.xml; \
name=enRouteDistroPom
Opening the Run
tab of the bndrun editor on this file will show you all transitive dependencies.
Maven Central supports a searching facility based on Solr. For example, you want all the artifacts of a given group id. In that case you could use the following Bnd Pom Repository plugin:
-standalone: true
-plugin.query = \
aQute.bnd.repository.maven.pom.provider.BndPomRepository; \
releaseUrl=https://repo.maven.apache.org/maven2; \
query='q=g:%22biz.aQute.bnd%22'; \
name=Query
The query must return a JSON response.
Property | Type | Default | Description |
---|---|---|---|
releaseUrl |
URI... |
Comma separated list of URLs to the repositories of released artifacts. | |
snapshotUrl |
URI... |
Comma separated list of URLs to the repositories of snapshot artifacts. | |
If this is not specified, it falls back to the release repository or just local if that is also not specified. |
|||
local |
PATH |
~/.m2/repository |
The file path to the local Maven repository. |
If specified, it should use forward slashes. If the directory does not exist, the plugin will attempt to create it. | |||
The default can be overridden with the maven.repo.local System property. |
|||
revision |
GAV... |
A comma separated list of Maven coordinates. The GAV will be searched in the normal way. For further information about Coordinates & Terminology please see MavenBndRepositoryPlugin | |
pom |
URI... |
A comma separated list of URLs to POM files. | |
location |
PATH |
cnf/cache/pom-<name>.xml |
Optional cached index of the parsed POMs. |
query |
STRING |
A Solr query string. This is the part after ? and must be properly URL encoded |
|
queryUrl |
URI |
https://search.maven.org/solrsearch/select |
Optional URL to the search engine. |
name |
STRING |
Required name of the repo. | |
transitive |
true|false |
true |
If set to truthy then dependencies are transitive. |
poll.time |
integer |
5 minutes | Number of seconds between checks for changes to POM files referenced by pom or revision . If the value is negative or the workspace is in batch/CI mode, then no polling takes place. |
dependencyManagement |
boolean |
false | If set to true , dependencies in the dependencyManagement section will be handled as actual dependencies. |
tags |
STRING |
Comma separated list of tags. (e.g. resolve, baseline, release) Use a placeholder like <<EMPTY>> to exclude the repo from resolution. The resolve tag is picked up by the -runrepos instruction. |
One, and only one, of the pom
, revision
, or query
configurations can be set. If multiple are set then the first in [pom, revision, query]
is used and the remainders are ignored.
The Maven Bnd Repository uses the bnd Http Client. See the -connection-settings instruction for how to set the proxy and authentication information.
If you use a remote repository then you must configure the credentials. This is described in -connection-settings. Placing the following XML in ~/.bnd/settings.xml
will provide you with the default Nexus credentials:
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
http://maven.apache.org/xsd/settings-1.0.0.xsd">
<servers>
<server>
<id>http://localhost:8081</id>
<username>admin</username>
<password>admin123</password>
</server>
</servers>
</settings>
Notice that the id must match the scheme, the host, and the port if not the default port for the scheme.
This plugin supports Tagging via the tags
configuration property. See Tagging of repository plugins for more details.
The repository view in the IDE will show detailed information when you hover the mouse over the the repository entry, the program entry, or the revision entry.
releaseUrl
and snapshotUrl
configuration parameters. This is for security reasons.-runblacklist
instruction.