contentcheck:show-licenses

Full name:

net.kozelka.maven:contentcheck-maven-plugin:1.0-SNAPSHOT:show-licenses

Description:

Shows license information for selected source entries. By default, the information is parsed from dependency's POM, but the project may define additional mapping between files in output archive and licenses.

Attributes:

  • Requires a Maven project to be executed.
  • Since version: 1.0.1.

Optional Parameters

Name Type Since Description
archive File 1.0.1 Deprecated. use sourceFile instead
checkFilesPattern String 1.0.1 Ant like file pattern selecting archive entries (files) to include in the check.
Default value is: **/*.jar.
csvOutput boolean 1.0.1 If true print the result of check to a CSV file in project build directory. See csvOutputFile
Default value is: true.
csvOutputFile File 1.0.1 The CSV output file that is used when csvOutput is turned on.
Default value is: ${project.build.directory}/licenses.csv.
defaultBundleForPOMPacking File 1.0.1 The archive file to be checked
Default value is: ${project.build.directory}/${project.build.finalName}.zip.
directory File 1.0.3 Deprecated. use sourceFile instead
ignoreVendorArchives boolean 1.0.1 If true, doesn't check vendor JAR files. A vendor JAR file is determined by a value (vendorId) in its manifest key (manifestVendorEntry).
Default value is: false.
User property is: ignoreVendorArchives.
licenseMappingFile File 1.0.1 The license mapping file, in JSON format. This file may define additional license information for JARs that are not recognized.

Additional license information


{
"licenses": [
      {
         "name" : "License name",
          "url"  : "License text URL",
          "files": [
              "file name"
           ]
      }
 ]
}

Example


{
   "licenses": [
      {
          "name"  : "The LGPL license 2.1",
          "url"   : "http://www.gnu.org/licenses/lgpl-2.1.html",
          "files" : [
                        "aspectwerkz-nodeps-jdk5-2.2.1.jar"
          ]
      },
      {
          "name"  : "The public domain",
          "url"   : "http://creativecommons.org/licenses/publicdomain/",
          "files" : [
              "jsr166x-1.0.jar",
              "xyz.jar"
          ]
      }
   ]
}

Default value is: src/main/license.mapping.json.
User property is: licenseMappingFile.
manifestVendorEntry String 1.0.1 The name of manifest entry that holds vendor's identification
Default value is: Implementation-Vendor-Id.
sourceFile File 1.0.4 The archive file or directory to be checked.
Default value is: ${project.build.directory}/${project.build.finalName}.${project.packaging}.
User property is: source.file.
vendorId String 1.0.1 The vendor identification. This value is used for JAR's manifest checking when ignoreVendorArchives is turned on. Using the same groupId for all modules in your project can be beneficial for proper verdor archive detection.
Default value is: ${project.groupId}.

Parameter Details

archive:

Deprecated. use sourceFile instead
(no description)
  • Type: java.io.File
  • Since: 1.0.1
  • Required: No

checkFilesPattern:

Ant like file pattern selecting archive entries (files) to include in the check.
  • Type: java.lang.String
  • Since: 1.0.1
  • Required: No
  • Default: **/*.jar

csvOutput:

If true print the result of check to a CSV file in project build directory. See csvOutputFile
  • Type: boolean
  • Since: 1.0.1
  • Required: No
  • Default: true

csvOutputFile:

The CSV output file that is used when csvOutput is turned on.
  • Type: java.io.File
  • Since: 1.0.1
  • Required: No
  • Default: ${project.build.directory}/licenses.csv

defaultBundleForPOMPacking:

The archive file to be checked
  • Type: java.io.File
  • Since: 1.0.1
  • Required: No
  • Default: ${project.build.directory}/${project.build.finalName}.zip

directory:

Deprecated. use sourceFile instead
(no description)
  • Type: java.io.File
  • Since: 1.0.3
  • Required: No

ignoreVendorArchives:

If true, doesn't check vendor JAR files. A vendor JAR file is determined by a value (vendorId) in its manifest key (manifestVendorEntry).
  • Type: boolean
  • Since: 1.0.1
  • Required: No
  • User Property: ignoreVendorArchives
  • Default: false

licenseMappingFile:

The license mapping file, in JSON format. This file may define additional license information for JARs that are not recognized.

Additional license information


{
"licenses": [
      {
         "name" : "License name",
          "url"  : "License text URL",
          "files": [
              "file name"
           ]
      }
 ]
}

Example


{
   "licenses": [
      {
          "name"  : "The LGPL license 2.1",
          "url"   : "http://www.gnu.org/licenses/lgpl-2.1.html",
          "files" : [
                        "aspectwerkz-nodeps-jdk5-2.2.1.jar"
          ]
      },
      {
          "name"  : "The public domain",
          "url"   : "http://creativecommons.org/licenses/publicdomain/",
          "files" : [
              "jsr166x-1.0.jar",
              "xyz.jar"
          ]
      }
   ]
}
  • Type: java.io.File
  • Since: 1.0.1
  • Required: No
  • User Property: licenseMappingFile
  • Default: src/main/license.mapping.json

manifestVendorEntry:

The name of manifest entry that holds vendor's identification
  • Type: java.lang.String
  • Since: 1.0.1
  • Required: No
  • Default: Implementation-Vendor-Id

sourceFile:

The archive file or directory to be checked.
  • Type: java.io.File
  • Since: 1.0.4
  • Required: No
  • User Property: source.file
  • Default: ${project.build.directory}/${project.build.finalName}.${project.packaging}

vendorId:

The vendor identification. This value is used for JAR's manifest checking when ignoreVendorArchives is turned on. Using the same groupId for all modules in your project can be beneficial for proper verdor archive detection.
  • Type: java.lang.String
  • Since: 1.0.1
  • Required: No
  • Default: ${project.groupId}