com.springsource.bundlor.:transform

Full name:

com.springsource.bundlor:com.springsource.bundlor.maven:1.0.0.BUILD-SNAPSHOT:transform

Description:

Goal which creates a MANIFEST file and inserts it into the bundle specified by the bundlePath property.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Binds by default to the lifecycle phase: package.

Optional Parameters

Name Type Since Description
bundlePath File - Location of the bundle to be transformed. Defaults to ${project.artifact.file}, which is normally a jar file in the target directory with the conventional artifact name ( ${project.artifactId}-${project.version}.jar).
enabled boolean - Flag to enable this plugin for the current project (defaults to true).
failOnWarnings boolean - Flag to indicate that the build should fail if there are warnings from Bundlor (defaults to true).
manifestHeaders String - Additional manifest headers to add to the template, overriding any with the same key already defined. Specify in the same way as you would a MANIFEST file with the same rules about line lengths, header names etc. Hint: use CDATA to push the entries to the left and avoid spaces at the start of lines, unless they are real MANIFEST continuation markers.
manifestTemplatePath String - Location of the manifest template. Defaults to template.mf.
outputBundle File - Location of the output bundle. Defaults to ${project.artifact.file}, which is normally a jar file in the target directory with the conventional artifact name ( ${project.artifactId}-${project.version}.jar).
packagings String[] - List of applicable packaging types (defaults to jar, war, bundle). Projects with other packaging (e.g. pom) will be ignored, so there will be no error if the template cannot be found.
removeNullHeaders boolean - Flag to indicate that manifest overrides that have the literal value null should be removed. This happens with manifestHeaders where Maven has interpolated a missing property. Overridden on command line with -DremoveNullHeaders=false.

Parameter Details

bundlePath :

Location of the bundle to be transformed. Defaults to ${project.artifact.file}, which is normally a jar file in the target directory with the conventional artifact name ( ${project.artifactId}-${project.version}.jar).

  • Type: java.io.File
  • Required: No
  • Expression: ${project.artifact.file}

enabled :

Flag to enable this plugin for the current project (defaults to true).

  • Type: boolean
  • Required: No
  • Expression: ${bundlor.enabled}

failOnWarnings :

Flag to indicate that the build should fail if there are warnings from Bundlor (defaults to true).

  • Type: boolean
  • Required: No
  • Expression: ${failOnWarnings}

manifestHeaders :

Additional manifest headers to add to the template, overriding any with the same key already defined. Specify in the same way as you would a MANIFEST file with the same rules about line lengths, header names etc. Hint: use CDATA to push the entries to the left and avoid spaces at the start of lines, unless they are real MANIFEST continuation markers.

  • Type: java.lang.String
  • Required: No

manifestTemplatePath :

Location of the manifest template. Defaults to template.mf.

  • Type: java.lang.String
  • Required: No
  • Expression: ${basedir}/template.mf

outputBundle :

Location of the output bundle. Defaults to ${project.artifact.file}, which is normally a jar file in the target directory with the conventional artifact name ( ${project.artifactId}-${project.version}.jar).

  • Type: java.io.File
  • Required: No
  • Expression: ${project.artifact.file}

packagings :

List of applicable packaging types (defaults to jar, war, bundle). Projects with other packaging (e.g. pom) will be ignored, so there will be no error if the template cannot be found.

  • Type: java.lang.String[]
  • Required: No

removeNullHeaders :

Flag to indicate that manifest overrides that have the literal value null should be removed. This happens with manifestHeaders where Maven has interpolated a missing property. Overridden on command line with -DremoveNullHeaders=false.

  • Type: boolean
  • Required: No
  • Expression: ${removeNullHeaders}