MWEBSTART :: Webstart Maven Plugin

webstart:jnlp

Full name:

org.codehaus.mojo:webstart-maven-plugin:1.0-beta-3:jnlp

Description:

Packages a jnlp application. The plugin tries to not re-sign/re-pack if the dependent jar hasn't changed. As a consequence, if one modifies the pom jnlp config or a keystore, one should clean before rebuilding. This mojo forks a build lifecycle and won't install the zip packages in your local repository. You probably want to use the jnlp-inline instead.

Attributes:

Requires a Maven project to be executed.
Executes as an aggregator plugin.
Requires dependency resolution of artifacts in scope: runtime.
Since version: 28 May 2007.
Invokes the execution of the lifecycle phase package prior to executing itself.

Required Parameters

Name	Type	Since	Description
templateDirectory	`File`	`28 May 2007`	The location where the JNLP Velocity template files are stored. Default value is: `${project.basedir}/src/main/jnlp`.
workDirectory	`File`	`28 May 2007`	The directory in which files will be stored prior to processing. Default value is: `${project.build.directory}/jnlp`.

Optional Parameters

Name	Type	Since	Description
attachArchive	`boolean`	`1.0-beta-2`	Flag to attach the archive or not to the project's build. Default value is: `true`.
canUnsign	`boolean`	`1.0-beta-2`	To authorize or not to unsign some already signed jar. If set to false and the `unsign` parameter is set to `true` then the build will fail if there is a jar to unsign, to avoid this use then the extension jnlp component. Default value is: `true`.
codebase	`String`	`1.0-beta-2`	The code base to use on the generated jnlp files. Default value is: `${project.url}/jnlp`.
dependencies	`Dependencies`	`28 May 2007`	[optional] transitive dependencies filter - if omitted, the plugin will include all transitive dependencies. Provided and test scope dependencies are always excluded.
encoding	`String`	`1.0-beta-2`	Encoding used to read and write jnlp files. Note: If this property is not defined, then will use a default value `utf-8`. Default value is: `${project.build.sourceEncoding}`.
excludeTransitive	`boolean`	`28 May 2007`	Set to true to exclude all transitive dependencies.
gzip	`boolean`	`28 May 2007`	Indicates whether or not gzip archives will be created for each of the jar files included in the webstart bundle. Default value is: `false`.
jnlp	`JnlpConfig`	`28 May 2007`	The jnlp configuration element.
jnlpExtensions	`List`	`1.0-beta-2`	[optional] extensions configuration.
keystore	`String`	`28 May 2007`	A placeholder for an obsoleted configuration element. This dummy parameter is here to force the plugin configuration to fail in case one didn't properly migrate from 1.0-alpha-1 to 1.0-alpha-2 configuration. It will be removed before 1.0.
libPath	`String`	`28 May 2007`	The path where the libraries are placed within the jnlp structure.
makeArchive	`boolean`	`1.0-beta-2`	Flag to create the archive or not. Default value is: `true`.
outputJarVersions	`boolean`	`28 May 2007`	When set to true, this flag indicates that a version attribute should be output in each of the jar resource elements in the generated JNLP file. Default value is: `false`.
pack200	`boolean`	`28 May 2007`	Indicates whether or not jar resources should be compressed using pack200. Setting this value to true requires SDK 5.0 or greater. Default value is: `false`.
resourcesDirectory	`File`	`28 May 2007`	The location of the directory (relative or absolute) containing non-jar resources that are to be included in the JNLP bundle.
sign	`SignConfig`	`28 May 2007`	The Sign Config
unsignAlreadySignedJars	`boolean`	`28 May 2007`	Define whether to remove existing signatures. Default value is: `false`.
verbose	`boolean`	`28 May 2007`	Enable verbose output. Default value is: `false`.
verifyjar	`boolean`	`28 May 2007`	Indicates whether or not jar files should be verified after signing. Default value is: `true`.

Parameter Details

attachArchive:

Flag to attach the archive or not to the project's build.

Type: boolean
Since: 1.0-beta-2
Required: No
Default: true

canUnsign:

To authorize or not to unsign some already signed jar. If set to false and the unsign parameter is set to true then the build will fail if there is a jar to unsign, to avoid this use then the extension jnlp component.

Type: boolean
Since: 1.0-beta-2
Required: No
Default: true

codebase:

The code base to use on the generated jnlp files.

Type: java.lang.String
Since: 1.0-beta-2
Required: No
Expression: ${jnlp.codebase}
Default: ${project.url}/jnlp

dependencies:

[optional] transitive dependencies filter - if omitted, the plugin will include all transitive dependencies. Provided and test scope dependencies are always excluded.

Type: org.codehaus.mojo.webstart.AbstractJnlpMojo.Dependencies
Since: 28 May 2007
Required: No

encoding:

Encoding used to read and write jnlp files. Note: If this property is not defined, then will use a default value utf-8.

Type: java.lang.String
Since: 1.0-beta-2
Required: No
Expression: ${jnlp.encoding}
Default: ${project.build.sourceEncoding}

excludeTransitive:

Set to true to exclude all transitive dependencies.

Type: boolean
Since: 28 May 2007
Required: No

gzip:

Indicates whether or not gzip archives will be created for each of the jar files included in the webstart bundle.

Type: boolean
Since: 28 May 2007
Required: No
Default: false

jnlp:

The jnlp configuration element.

Type: org.codehaus.mojo.webstart.JnlpConfig
Since: 28 May 2007
Required: No

jnlpExtensions:

[optional] extensions configuration.

Type: java.util.List
Since: 1.0-beta-2
Required: No

keystore:

A placeholder for an obsoleted configuration element. This dummy parameter is here to force the plugin configuration to fail in case one didn't properly migrate from 1.0-alpha-1 to 1.0-alpha-2 configuration. It will be removed before 1.0.

Type: java.lang.String
Since: 28 May 2007
Required: No

libPath:

The path where the libraries are placed within the jnlp structure.