bundle:instructions

Full name:

org.apache.felix:maven-bundle-plugin:2.3.7:instructions

Description:

Generate BND instructions for this project

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: package.

Required Parameters

Name Type Since Description
buildDirectory String - The directory for the generated JAR.
outputDirectory File - The directory for the generated bundles.

Optional Parameters

Name Type Since Description
archive MavenArchiveConfiguration - The archive configuration to use.
classifier String - Classifier type of the bundle to be installed. For example, "jdk14". Defaults to none which means this is the project's main bundle.
dumpClasspath File - File where the BND class-path will be dumped
dumpInstructions File - File where the BND instructions will be dumped
excludeDependencies String - Comma separated list of artifactIds to exclude from the dependency classpath passed to BND (use "true" to exclude everything)
instructions Map - The BND instructions for the bundle.
manifestLocation File - Directory where the manifest will be written
Default value is: ${project.build.outputDirectory}/META-INF.
supportedProjectTypes List - Project types which this plugin supports.
unpackBundle boolean - When true, unpack the bundle contents to the outputDirectory

Parameter Details

archive:

The archive configuration to use.
  • Type: org.apache.maven.archiver.MavenArchiveConfiguration
  • Required: No

buildDirectory:

The directory for the generated JAR.
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${project.build.directory}

classifier:

Classifier type of the bundle to be installed. For example, "jdk14". Defaults to none which means this is the project's main bundle.
  • Type: java.lang.String
  • Required: No

dumpClasspath:

File where the BND class-path will be dumped
  • Type: java.io.File
  • Required: No
  • Expression: ${dumpClasspath}

dumpInstructions:

File where the BND instructions will be dumped
  • Type: java.io.File
  • Required: No
  • Expression: ${dumpInstructions}

excludeDependencies:

Comma separated list of artifactIds to exclude from the dependency classpath passed to BND (use "true" to exclude everything)
  • Type: java.lang.String
  • Required: No
  • Expression: ${excludeDependencies}

instructions:

The BND instructions for the bundle.
  • Type: java.util.Map
  • Required: No

manifestLocation:

Directory where the manifest will be written
  • Type: java.io.File
  • Required: No
  • Expression: ${manifestLocation}
  • Default: ${project.build.outputDirectory}/META-INF

outputDirectory:

The directory for the generated bundles.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.outputDirectory}

supportedProjectTypes:

Project types which this plugin supports.
  • Type: java.util.List
  • Required: No

unpackBundle:

When true, unpack the bundle contents to the outputDirectory
  • Type: boolean
  • Required: No
  • Expression: ${unpackBundle}