Fork me on GitHub

swid:generate

Full name:

com.labs64.mojo:swid-maven-plugin:0.1.0:generate

Description:

A mojo that generates a SWID tag from a given POM.

Attributes:

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

Required Parameters

Name Type Since Description
outputDirectory File 1.0.0 Specifies the destination directory where the generated SWID tags files will be saved.
Default value is: ${project.build.directory}/generated-resources/swid.
User property is: swid.outputDirectory.

Optional Parameters

Name Type Since Description
domain_creation_date String 1.0.0 Specifies domain creation date which belongs to the software creator.
Format: 'yyyy-MM'
Example: '2010-04'
Default value: current date
User property is: swid.domain_creation_date.
encoding String 1.0.0 Specifies the encoding of the generated SWID tags files.
Fallback value(s): UTF-8
Default value is: ${project.build.sourceEncoding}.
User property is: swid.encoding.
entitlement_required Boolean 1.0.0 Specifies if an entitlement is required to reconcile this product.
Default value is: false.
User property is: swid.entitlement_required.
extension String 1.0.0 Specifies the extension of the generated SWID tags files.
Default value is: swidtag.
User property is: swid.extension.
product_title String 1.0.0 Specifies product title.
Fallback value(s): ${project.artifactId}
Default value is: ${project.name}.
User property is: swid.product_title.
product_version String 1.0.0 Specifies product version.
Default value is: ${project.version}.
User property is: swid.product_version.
software_creator RegId 1.0.0 Specifies software creator attributes.
Fallback value(s): name: ${project.groupId}; regid: ${project.url}, ${project.groupId}
Default value(s):
<software_creator>
    <name>${project.organization.name}</name>
    <regid>${project.organization.url}</regid>
</software_creator>

Default value is: ${software_creator}.
software_id RegId 1.0.0 Specifies software identifier attributes.
Fallback value(s): tag_creator_regid: ${project.url}, ${project.groupId}
Default value(s):
<software_id>
    <unique_id>${project.artifactId}</unique_id>
    <tag_creator_regid>${project.organization.url}</tag_creator_regid>
</software_id>

Default value is: ${software_id}.
software_licensor RegId 1.0.0 Specifies software licensor attributes.
Fallback value(s): name: ${project.groupId}; regid: ${project.url}, ${project.groupId}
Default value(s):
<software_licensor>
    <name>${project.organization.name}</name>
    <regid>${project.organization.url}</regid>
</software_licensor>

Default value is: ${software_licensor}.
tag_creator RegId 1.0.0 Specifies tag creator attributes.
Fallback value(s): name: ${project.groupId}; regid: ${project.url}, ${project.groupId}
Default value(s):
<tag_creator>
    <name>${project.organization.name}</name>
    <regid>${project.organization.url}</regid>
</tag_creator>

Default value is: ${tag_creator}.

Parameter Details

domain_creation_date:

Specifies domain creation date which belongs to the software creator.
Format: 'yyyy-MM'
Example: '2010-04'
Default value: current date
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: swid.domain_creation_date

encoding:

Specifies the encoding of the generated SWID tags files.
Fallback value(s): UTF-8
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: swid.encoding
  • Default: ${project.build.sourceEncoding}

entitlement_required:

Specifies if an entitlement is required to reconcile this product.
  • Type: java.lang.Boolean
  • Since: 1.0.0
  • Required: No
  • User Property: swid.entitlement_required
  • Default: false

extension:

Specifies the extension of the generated SWID tags files.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: swid.extension
  • Default: swidtag

outputDirectory:

Specifies the destination directory where the generated SWID tags files will be saved.
  • Type: java.io.File
  • Since: 1.0.0
  • Required: Yes
  • User Property: swid.outputDirectory
  • Default: ${project.build.directory}/generated-resources/swid

product_title:

Specifies product title.
Fallback value(s): ${project.artifactId}
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: swid.product_title
  • Default: ${project.name}

product_version:

Specifies product version.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: swid.product_version
  • Default: ${project.version}

software_creator:

Specifies software creator attributes.
Fallback value(s): name: ${project.groupId}; regid: ${project.url}, ${project.groupId}
Default value(s):
<software_creator>
    <name>${project.organization.name}</name>
    <regid>${project.organization.url}</regid>
</software_creator>
  • Type: com.labs64.mojo.swid.configuration.RegId
  • Since: 1.0.0
  • Required: No
  • Default: ${software_creator}

software_id:

Specifies software identifier attributes.
Fallback value(s): tag_creator_regid: ${project.url}, ${project.groupId}
Default value(s):
<software_id>
    <unique_id>${project.artifactId}</unique_id>
    <tag_creator_regid>${project.organization.url}</tag_creator_regid>
</software_id>
  • Type: com.labs64.mojo.swid.configuration.RegId
  • Since: 1.0.0
  • Required: No
  • Default: ${software_id}

software_licensor:

Specifies software licensor attributes.
Fallback value(s): name: ${project.groupId}; regid: ${project.url}, ${project.groupId}
Default value(s):
<software_licensor>
    <name>${project.organization.name}</name>
    <regid>${project.organization.url}</regid>
</software_licensor>
  • Type: com.labs64.mojo.swid.configuration.RegId
  • Since: 1.0.0
  • Required: No
  • Default: ${software_licensor}

tag_creator:

Specifies tag creator attributes.
Fallback value(s): name: ${project.groupId}; regid: ${project.url}, ${project.groupId}
Default value(s):
<tag_creator>
    <name>${project.organization.name}</name>
    <regid>${project.organization.url}</regid>
</tag_creator>
  • Type: com.labs64.mojo.swid.configuration.RegId
  • Since: 1.0.0
  • Required: No
  • Default: ${tag_creator}