Fork me on GitHub

webstart:jnlp

Full name:

org.codehaus.mojo:webstart-maven-plugin:1.0-beta-8-SNAPSHOT: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. For more informations about how to choose the matching mojo see http://mojo.codehaus.org/webstart/webstart-maven-plugin/usage.html#Choices

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.
  • Binds by default to the lifecycle phase: package.
  • Invokes the execution of the lifecycle phase package prior to executing itself.

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.
templateDirectory File 28 May 2007 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 28 May 2007 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
archive File 1.0-beta-4 The path of the archive to generate if makeArchive flag is on.
Default value is: ${project.build.directory}/${project.build.finalName}.zip.
User property is: jnlp.archive.
attachArchive boolean 1.0-beta-2 Flag to attach the archive or not to the project's build.
Default value is: true.
User property is: jnlp.attachArchive.
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.
dependencies AbstractJnlpMojo$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}.
User property is: jnlp.encoding.
excludeTransitive boolean 28 May 2007 Set to true to exclude all transitive dependencies.
User property is: jnlp.excludeTransitive.
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.
User property is: jnlp.gzip.
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.
User property is: jnlp.libPath.
makeArchive boolean 1.0-beta-2 Flag to create the archive or not.
Default value is: true.
User property is: jnlp.makeArchive.
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. Note: since version 1.0-beta-5 we use the version download protocol optimization (see http://docs.oracle.com/javase/tutorial/deployment/deploymentInDepth/avoidingUnnecessaryUpdateChecks.html).
Default value is: false.
User property is: jnlp.outputJarVersions.
pack200 Pack200Config 1.0-beta-4 The Pack200 Config.
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.
User property is: jnlp.resourcesDirectory.
sign SignConfig 28 May 2007 The Sign Config.
unsignAlreadySignedJars boolean 28 May 2007 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 28 May 2007 Enable verbose output.
Default value is: false.
User property is: webstart.verbose.

Parameter Details

archive:

The path of the archive to generate if makeArchive flag is on.
  • Type: java.io.File
  • Since: 1.0-beta-4
  • Required: No
  • User Property: jnlp.archive
  • Default: ${project.build.directory}/${project.build.finalName}.zip

attachArchive:

Flag to attach the archive or not to the project's build.
  • Type: boolean
  • Since: 1.0-beta-2
  • Required: No
  • User Property: jnlp.attachArchive
  • 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
  • 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

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
  • User Property: jnlp.encoding
  • Default: ${project.build.sourceEncoding}

excludeTransitive:

Set to true to exclude all transitive dependencies.
  • Type: boolean
  • Since: 28 May 2007
  • 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: 28 May 2007
  • Required: No
  • User Property: jnlp.gzip
  • 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.
  • Type: java.lang.String
  • Since: 28 May 2007
  • Required: No
  • User Property: jnlp.libPath

makeArchive:

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

outputJarVersions:

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. Note: since version 1.0-beta-5 we use the version download protocol optimization (see http://docs.oracle.com/javase/tutorial/deployment/deploymentInDepth/avoidingUnnecessaryUpdateChecks.html).
  • Type: boolean
  • Since: 28 May 2007
  • Required: No
  • User Property: jnlp.outputJarVersions
  • Default: false

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: 28 May 2007
  • Required: No
  • User Property: jnlp.resourcesDirectory

sign:

The Sign Config.
  • Type: org.codehaus.mojo.webstart.sign.SignConfig
  • Since: 28 May 2007
  • Required: No

templateDirectory:

The location where the JNLP Velocity template files are stored.
  • Type: java.io.File
  • Since: 28 May 2007
  • Required: Yes
  • User Property: jnlp.templateDirectory
  • Default: ${project.basedir}/src/main/jnlp

unsignAlreadySignedJars:

Define whether to remove existing signatures.
  • Type: boolean
  • Since: 28 May 2007
  • 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: 28 May 2007
  • 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: 28 May 2007
  • Required: Yes
  • User Property: jnlp.workDirectory
  • Default: ${project.build.directory}/jnlp