webstart:jnlp-download-servlet

Full name:

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

Description:

This MOJO is tailored for use within a Maven web application project that uses the JnlpDownloadServlet to serve up the JNLP application.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • Since version: 1.0-alpha-2.

Required Parameters

Name Type Since Description
jnlpFiles List 1.0-alpha-2 The collection of JnlpFile configuration elements. Each one represents a JNLP file that is to be generated and deployed within the enclosing project's WAR artifact. At least one JnlpFile must be specified.
templateDirectory File 1.0-alpha-2 The location where the JNLP Velocity template files are stored.
Default value is: ${project.basedir}/src/main/jnlp.
workDirectory File 1.0-alpha-2 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.
commonJarResources List 1.0-alpha-2 The configurable collection of jars that are common to all jnlpFile elements declared in plugin configuration. These jars will be output as jar elements in the resources section of every generated JNLP file and bundled into the specified output directory of the artifact produced by the project.
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 1.0-alpha-2 Set to true to exclude all transitive dependencies.
gzip boolean 1.0-alpha-2 Indicates whether or not gzip archives will be created for each of the jar files included in the webstart bundle.
Default value is: false.
libPath String 1.0-alpha-2 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.
outputDirectoryName String 1.0-alpha-2 The name of the directory into which the jnlp file and other artifacts will be stored after processing. This directory will be created directly within the root of the WAR produced by the enclosing project.
Default value is: webstart.
pack200 boolean 1.0-alpha-2 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 1.0-alpha-2 The location of the directory (relative or absolute) containing non-jar resources that are to be included in the JNLP bundle.
sign SignConfig 1.0-alpha-2 The Sign Config
unsignAlreadySignedJars boolean 1.0-alpha-2 Define whether to remove existing signatures.
Default value is: false.
verbose boolean 1.0-alpha-2 Enable verbose output.
Default value is: false.
verifyjar boolean 1.0-alpha-2 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

commonJarResources:

The configurable collection of jars that are common to all jnlpFile elements declared in plugin configuration. These jars will be output as jar elements in the resources section of every generated JNLP file and bundled into the specified output directory of the artifact produced by the project.
  • Type: java.util.List
  • Since: 1.0-alpha-2
  • 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: 1.0-alpha-2
  • 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: 1.0-alpha-2
  • Required: No
  • Default: false

jnlpFiles:

The collection of JnlpFile configuration elements. Each one represents a JNLP file that is to be generated and deployed within the enclosing project's WAR artifact. At least one JnlpFile must be specified.
  • Type: java.util.List
  • Since: 1.0-alpha-2
  • Required: Yes

libPath:

The path where the libraries are placed within the jnlp structure.
  • Type: java.lang.String
  • Since: 1.0-alpha-2
  • Required: No

makeArchive:

Flag to create the archive or not.
  • Type: boolean
  • Since: 1.0-beta-2
  • Required: No
  • Default: true

outputDirectoryName:

The name of the directory into which the jnlp file and other artifacts will be stored after processing. This directory will be created directly within the root of the WAR produced by the enclosing project.
  • Type: java.lang.String
  • Since: 1.0-alpha-2
  • Required: No
  • Default: webstart

pack200:

Indicates whether or not jar resources should be compressed using pack200. Setting this value to true requires SDK 5.0 or greater.
  • Type: boolean
  • Since: 1.0-alpha-2
  • Required: No
  • Default: false

resourcesDirectory:

The location of the directory (relative or absolute) containing non-jar resources that are to be included in the JNLP bundle.
  • Type: java.io.File
  • Since: 1.0-alpha-2
  • Required: No

sign:

The Sign Config
  • Type: org.codehaus.mojo.webstart.sign.SignConfig
  • Since: 1.0-alpha-2
  • Required: No

templateDirectory:

The location where the JNLP Velocity template files are stored.
  • Type: java.io.File
  • Since: 1.0-alpha-2
  • Required: Yes
  • Default: ${project.basedir}/src/main/jnlp

unsignAlreadySignedJars:

Define whether to remove existing signatures.
  • Type: boolean
  • Since: 1.0-alpha-2
  • Required: No
  • Default: false

verbose:

Enable verbose output.
  • Type: boolean
  • Since: 1.0-alpha-2
  • Required: No
  • Expression: ${verbose}
  • Default: false

verifyjar:

Indicates whether or not jar files should be verified after signing.
  • Type: boolean
  • Since: 1.0-alpha-2
  • Required: No
  • Default: true

workDirectory:

The directory in which files will be stored prior to processing.
  • Type: java.io.File
  • Since: 1.0-alpha-2
  • Required: Yes
  • Default: ${project.build.directory}/jnlp