Maven Jarsigner plugin - jarsigner:sign

jarsigner:sign

Full name:

org.apache.maven.plugins:maven-jarsigner-plugin:1.2:sign

Description:

Signs a project artifact and attachments using jarsigner.

Attributes:

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

Required Parameters

Name	Type	Since	Description
alias	`String`	`1.0`	See options.

Optional Parameters

Name	Type	Since	Description
archive	`File`	`1.0`	Archive to process. If set, neither the project artifact nor any attachments or archive sets are processed.
archiveDirectory	`File`	`1.1`	The base directory to scan for JAR files using Ant-like inclusion/exclusion patterns.
arguments	`String[]`	`1.0`	List of additional arguments to append to the jarsigner command line.
attachments	`Boolean`	`1.0`	Deprecated. As of version 1.1 in favor of the new parameter `processAttachedArtifacts`.
excludeClassifiers	`String[]`	`1.2`	A set of artifact classifiers describing the project attachments that should not be processed. This parameter is only relevant if `processAttachedArtifacts` is `true`. If empty, no attachments are excluded.
excludes	`String[]`	`1.1`	The Ant-like exclusion patterns used to exclude JAR files from processing. The patterns must be relative to the directory given by the parameter `archiveDirectory`.
includeClassifiers	`String[]`	`1.2`	A set of artifact classifiers describing the project attachments that should be processed. This parameter is only relevant if `processAttachedArtifacts` is `true`. If empty, all attachments are included.
includes	`String[]`	`1.1`	The Ant-like inclusion patterns used to select JAR files to process. The patterns must be relative to the directory given by the parameter `archiveDirectory`. By default, the pattern `*/.?ar` is used.
keypass	`String`	`1.0`	See options.
keystore	`String`	`1.0`	See options.
maxMemory	`String`	`1.0`	The maximum memory available to the JAR signer, e.g. `256M`. See -Xmx for more details.
processAttachedArtifacts	`boolean`	`1.1`	Controls processing of project attachments. If enabled, attached artifacts that are no JAR/ZIP files will be automatically excluded from processing. Default value is: `true`.
processMainArtifact	`boolean`	`1.1`	Controls processing of the main artifact produced by the project. Default value is: `true`.
providerArg	`String`	`1.0`	See options.
providerClass	`String`	`1.0`	See options.
providerName	`String`	`1.0`	See options.
removeExistingSignatures	`boolean`	`1.1`	Indicates whether existing signatures should be removed from the processed JAR files prior to signing them. If enabled, the resulting JAR will appear as being signed only once. Default value is: `false`.
sigfile	`String`	`1.0`	See options.
skip	`boolean`	`1.0`	Set to `true` to disable the plugin. Default value is: `false`.
storepass	`String`	`1.0`	See options.
storetype	`String`	`1.0`	See options.
verbose	`boolean`	`1.0`	See options. Default value is: `false`.

Parameter Details

alias:

See options.

Type: java.lang.String
Since: 1.0
Required: Yes
Expression: ${jarsigner.alias}

archive:

Archive to process. If set, neither the project artifact nor any attachments or archive sets are processed.

Type: java.io.File
Since: 1.0
Required: No
Expression: ${jarsigner.archive}

archiveDirectory:

The base directory to scan for JAR files using Ant-like inclusion/exclusion patterns.

Type: java.io.File
Since: 1.1
Required: No
Expression: ${jarsigner.archiveDirectory}

arguments:

List of additional arguments to append to the jarsigner command line.

Type: java.lang.String[]
Since: 1.0
Required: No
Expression: ${jarsigner.arguments}

attachments:

Deprecated. As of version 1.1 in favor of the new parameter processAttachedArtifacts.

Controls processing of project attachments.

Type: java.lang.Boolean
Since: 1.0
Required: No
Expression: ${jarsigner.attachments}

excludeClassifiers:

A set of artifact classifiers describing the project attachments that should not be processed. This parameter is only relevant if processAttachedArtifacts is true. If empty, no attachments are excluded.

Type: java.lang.String[]
Since: 1.2
Required: No

excludes:

The Ant-like exclusion patterns used to exclude JAR files from processing. The patterns must be relative to the directory given by the parameter archiveDirectory.

Type: java.lang.String[]
Since: 1.1
Required: No

includeClassifiers:

A set of artifact classifiers describing the project attachments that should be processed. This parameter is only relevant if processAttachedArtifacts is true. If empty, all attachments are included.

Type: java.lang.String[]
Since: 1.2
Required: No

includes:

The Ant-like inclusion patterns used to select JAR files to process. The patterns must be relative to the directory given by the parameter archiveDirectory. By default, the pattern **/*.?ar is used.

Type: java.lang.String[]
Since: 1.1
Required: No

keypass:

See options.

Type: java.lang.String
Since: 1.0
Required: No
Expression: ${jarsigner.keypass}

keystore:

See options.

Type: java.lang.String
Since: 1.0
Required: No
Expression: ${jarsigner.keystore}

maxMemory:

The maximum memory available to the JAR signer, e.g. 256M. See -Xmx for more details.

Type: java.lang.String
Since: 1.0
Required: No
Expression: ${jarsigner.maxMemory}

processAttachedArtifacts:

Controls processing of project attachments. If enabled, attached artifacts that are no JAR/ZIP files will be automatically excluded from processing.

Type: boolean
Since: 1.1
Required: No
Expression: ${jarsigner.processAttachedArtifacts}
Default: true

processMainArtifact:

Controls processing of the main artifact produced by the project.

Type: boolean
Since: 1.1
Required: No
Expression: ${jarsigner.processMainArtifact}
Default: true

providerArg:

See options.

Type: java.lang.String
Since: 1.0
Required: No
Expression: ${jarsigner.providerArg}

providerClass:

See options.

Type: java.lang.String
Since: 1.0
Required: No
Expression: ${jarsigner.providerClass}

providerName:

See options.

Type: java.lang.String
Since: 1.0
Required: No
Expression: ${jarsigner.providerName}

removeExistingSignatures:

Indicates whether existing signatures should be removed from the processed JAR files prior to signing them. If enabled, the resulting JAR will appear as being signed only once.

Type: boolean
Since: 1.1
Required: No
Expression: ${jarsigner.removeExistingSignatures}
Default: false