Fork me on GitHub

webstart:jnlp-download-servlet

Full name:

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

Description:

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
filenameMapping String 1.0-beta-5 Naming strategy for dependencies of a jnlp application. The strategy purpose is to transform the name of the dependency file. The actual authorized values are:
  • simple: artifactId[-classifier]-version.jar
  • full: groupId-artifactId[-classifier]-version.jar
Default value is full which avoid any colision of naming.
Default value is: simple.
User property is: jnlp.filenameMapping.
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.
User property is: jnlp.templateDirectory.
workDirectory File 1.0-alpha-2 The directory in which files will be stored prior to processing.
Default value is: ${project.build.directory}/jnlp.
User property is: jnlp.workDirectory.

Optional Parameters

Name Type Since Description
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.
User property is: jnlp.canUnsign.
codebase String 1.0-beta-2 The code base to use on the generated jnlp files.
Default value is: ${project.url}/jnlp.
User property is: jnlp.codebase.
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}.
User property is: jnlp.encoding.
excludeTransitive boolean 1.0-alpha-2 Set to true to exclude all transitive dependencies.
User property is: jnlp.excludeTransitive.
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.
User property is: jnlp.gzip.
libPath String 1.0-alpha-2 The path where the libraries are placed within the jnlp structure.
User property is: jnlp.libPath.
outputDirectoryName String 1.0-alpha-2 The name of the directory into which the jnlp file and other artifacts will be stored after processing. directory will be created directly within the root of the WAR produced by the enclosing project.
Default value is: webstart.
User property is: jnlp.outputDirectoryName.
pack200 Pack200Config 1.0-beta-4 The Pack200 Config.
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.
User property is: jnlp.resourcesDirectory.
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.
User property is: jnlp.unsign.
updateManifestEntries Map 1.0-beta-4 To update manifest entries of all jar resources. Since jdk 1.7u45, you need to add some entries to be able to open jnlp files in High security level. See http://www.oracle.com/technetwork/java/javase/7u45-relnotes-2016950.html Note: Won't affect any already signed jar resources if you configuration does not authorize it. See parameters unsignAlreadySignedJars and canUnsign.
useUniqueVersions boolean 1.0-beta-7 Use unique version for any snapshot dependency, or just use the -SNAPSHOT version suffix.
Default value is: false.
User property is: jnlp.useUniqueVersions.
verbose boolean 1.0-alpha-2 Enable verbose output.
Default value is: false.
User property is: webstart.verbose.

Parameter Details

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
  • User Property: jnlp.canUnsign
  • Default: true

codebase:

The code base to use on the generated jnlp files.
  • Type: java.lang.String
  • Since: 1.0-beta-2
  • Required: No
  • User Property: 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
  • User Property: jnlp.encoding
  • Default: ${project.build.sourceEncoding}

excludeTransitive:

Set to true to exclude all transitive dependencies.
  • Type: boolean
  • Since: 1.0-alpha-2
  • Required: No
  • User Property: jnlp.excludeTransitive

filenameMapping:

Naming strategy for dependencies of a jnlp application. The strategy purpose is to transform the name of the dependency file. The actual authorized values are:
  • simple: artifactId[-classifier]-version.jar
  • full: groupId-artifactId[-classifier]-version.jar
Default value is full which avoid any colision of naming.
  • Type: java.lang.String
  • Since: 1.0-beta-5
  • Required: Yes
  • User Property: jnlp.filenameMapping
  • Default: simple

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
  • User Property: jnlp.gzip
  • 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
  • User Property: jnlp.libPath

outputDirectoryName:

The name of the directory into which the jnlp file and other artifacts will be stored after processing. 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
  • User Property: jnlp.outputDirectoryName
  • Default: webstart

pack200:

The Pack200 Config.
  • Type: org.codehaus.mojo.webstart.pack200.Pack200Config
  • Since: 1.0-beta-4
  • Required: No

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
  • User Property: jnlp.resourcesDirectory

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
  • User Property: jnlp.templateDirectory
  • Default: ${project.basedir}/src/main/jnlp

unsignAlreadySignedJars:

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

updateManifestEntries:

To update manifest entries of all jar resources. Since jdk 1.7u45, you need to add some entries to be able to open jnlp files in High security level. See http://www.oracle.com/technetwork/java/javase/7u45-relnotes-2016950.html Note: Won't affect any already signed jar resources if you configuration does not authorize it. See parameters unsignAlreadySignedJars and canUnsign.
  • Type: java.util.Map
  • Since: 1.0-beta-4
  • Required: No

useUniqueVersions:

Use unique version for any snapshot dependency, or just use the -SNAPSHOT version suffix.
  • Type: boolean
  • Since: 1.0-beta-7
  • Required: No
  • User Property: jnlp.useUniqueVersions
  • Default: false

verbose:

Enable verbose output.
  • Type: boolean
  • Since: 1.0-alpha-2
  • Required: No
  • User Property: webstart.verbose
  • Default: false

workDirectory:

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