BOM Helper Maven Plugin

bom-helper:fromJars

Full name:

com.commsen.maven:bom-helper-maven-plugin:0.5.0:fromJars

Description:

Creates dependency management entries (BOM) from jar files stored in directory on local file system.

Attributes:

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

Optional Parameters

Name Type Since Description
allOrNothing boolean - If true the build will fail if there are libraries found that can not be converted to dependency management entries
Default value is: false.
User property is: bom-helper.allOrNothing.
backupFileName String - The name of the file to copy the original POM to if `inplace` and `makeBackup` are set to `true`
Default value is: pom-original.xml.
User property is: bom-helper.backupFile.
folderDepth int - The maximum number of directory levels to visit
Default value is: 100.
User property is: bom-helper.recursiveDepth.
inplace boolean - If true, the current POM will be replaced with the one generated by this goal
Default value is: false.
User property is: bom-helper.inplace.
librariesFolder File - The folder to search (recursively) for libraries to be converted to dependency management entries
Default value is: ${project.basedir}/lib.
User property is: bom-helper.jarsFolder.
makeBackup boolean - Should the goal make copy of the original POM when `inplace` is set to `true`
Default value is: true.
User property is: bom-helper.backup.
outputFileName String - The name of the file to save the pom generated by this goal
Default value is: pom-bom-update.xml.
User property is: bom-helper.outputFile.
recursive boolean - Should sub-directories be recursively scanned for Jar files
Default value is: false.
User property is: bom-helper.recursive.
replaceBackup boolean - Should the goal replace an existing copy of the original POM when `inplace` and `makeBackup` are set to `true`
Default value is: false.
User property is: bom-helper.backupFile.replace.

Parameter Details

allOrNothing:

If true the build will fail if there are libraries found that can not be converted to dependency management entries
  • Type: boolean
  • Required: No
  • User Property: bom-helper.allOrNothing
  • Default: false

backupFileName:

The name of the file to copy the original POM to if `inplace` and `makeBackup` are set to `true`
  • Type: java.lang.String
  • Required: No
  • User Property: bom-helper.backupFile
  • Default: pom-original.xml

folderDepth:

The maximum number of directory levels to visit
  • Type: int
  • Required: No
  • User Property: bom-helper.recursiveDepth
  • Default: 100

inplace:

If true, the current POM will be replaced with the one generated by this goal
  • Type: boolean
  • Required: No
  • User Property: bom-helper.inplace
  • Default: false

librariesFolder:

The folder to search (recursively) for libraries to be converted to dependency management entries
  • Type: java.io.File
  • Required: No
  • User Property: bom-helper.jarsFolder
  • Default: ${project.basedir}/lib

makeBackup:

Should the goal make copy of the original POM when `inplace` is set to `true`
  • Type: boolean
  • Required: No
  • User Property: bom-helper.backup
  • Default: true

outputFileName:

The name of the file to save the pom generated by this goal
  • Type: java.lang.String
  • Required: No
  • User Property: bom-helper.outputFile
  • Default: pom-bom-update.xml

recursive:

Should sub-directories be recursively scanned for Jar files
  • Type: boolean
  • Required: No
  • User Property: bom-helper.recursive
  • Default: false

replaceBackup:

Should the goal replace an existing copy of the original POM when `inplace` and `makeBackup` are set to `true`
  • Type: boolean
  • Required: No
  • User Property: bom-helper.backupFile.replace
  • Default: false