nbm:webstart-app

Full name:

org.codehaus.mojo:nbm-maven-plugin:3.6:webstart-app

Description:

Create webstartable binaries for a 'nbm-application'.

Attributes:

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

Required Parameters

Name Type Since Description
brandingToken String 3.0 The branding token for the application based on NetBeans platform.
destinationFile File 3.0 Ready-to-deploy WAR containing application in JNLP packaging.
Default value is: ${project.build.directory}/${project.artifactId}-${project.version}-jnlp.war.
outputDirectory File 3.0 output directory where the the netbeans application will be created.
Default value is: ${project.build.directory}.

Optional Parameters

Name Type Since Description
additionalArguments String 3.0 additional command line arguments. Eg. -J-Xdebug -J-Xnoagent -J-Xrunjdwp:transport=dt_socket,suspend=n,server=n,address=8888 can be used to debug the IDE.
codebase String 3.0 Codebase value within *.jnlp files. Defining this parameter is generally a bad idea.
keystore String 3.0 keystore location for signing the nbm file
keystorealias String 3.0 keystore alias
keystorepassword String 3.0 keystore password
keystoretype String 3.5 keystore type
masterJnlpFile File 3.0 A custom master JNLP file. If not defined, the default one is used. The following expressions can be used within the file and will be replaced when generating content.
  • ${jnlp.resources}
  • ${jnlp.codebase} - the 'codebase' parameter value is passed in.
  • ${app.name}
  • ${app.title}
  • ${app.vendor}
  • ${app.description}
  • ${branding.token} - the 'brandingToken' parameter value is passed in.
  • ${netbeans.jnlp.fixPolicy}
masterJnlpFileName String 3.5 The basename (minus .jnlp extension) of the master JNLP file in the output. This file will be the entry point for javaws. Defaults to the branding token.
processJarVersions boolean 3.0 If set true, build-jnlp target creates versioning info in jnlp descriptors and version.xml files. This allows for incremental updates of Webstart applications, but requires download via JnlpDownloadServlet Defaults to false, which means versioning info is not generated (see http://java.sun.com/j2se/1.5.0/docs/guide/javaws/developersguide/downloadservletguide.html#resources).
Default value is: false.
webstartClassifier String 3.1 Artifact Classifier to use for the webstart distributable zip file.
Default value is: webstart.

Parameter Details

additionalArguments:

additional command line arguments. Eg. -J-Xdebug -J-Xnoagent -J-Xrunjdwp:transport=dt_socket,suspend=n,server=n,address=8888 can be used to debug the IDE.
  • Type: java.lang.String
  • Since: 3.0
  • Required: No
  • Expression: ${netbeans.run.params}

brandingToken:

The branding token for the application based on NetBeans platform.
  • Type: java.lang.String
  • Since: 3.0
  • Required: Yes
  • Expression: ${netbeans.branding.token}

codebase:

Codebase value within *.jnlp files. Defining this parameter is generally a bad idea.
  • Type: java.lang.String
  • Since: 3.0
  • Required: No
  • Expression: ${nbm.webstart.codebase}

destinationFile:

Ready-to-deploy WAR containing application in JNLP packaging.
  • Type: java.io.File
  • Since: 3.0
  • Required: Yes
  • Default: ${project.build.directory}/${project.artifactId}-${project.version}-jnlp.war

keystore:

keystore location for signing the nbm file
  • Type: java.lang.String
  • Since: 3.0
  • Required: No
  • Expression: ${keystore}

keystorealias:

keystore alias
  • Type: java.lang.String
  • Since: 3.0
  • Required: No
  • Expression: ${keystorealias}

keystorepassword:

keystore password
  • Type: java.lang.String
  • Since: 3.0
  • Required: No
  • Expression: ${keystorepass}

keystoretype:

keystore type
  • Type: java.lang.String
  • Since: 3.5
  • Required: No
  • Expression: ${keystoretype}

masterJnlpFile:

A custom master JNLP file. If not defined, the default one is used. The following expressions can be used within the file and will be replaced when generating content.
  • ${jnlp.resources}
  • ${jnlp.codebase} - the 'codebase' parameter value is passed in.
  • ${app.name}
  • ${app.title}
  • ${app.vendor}
  • ${app.description}
  • ${branding.token} - the 'brandingToken' parameter value is passed in.
  • ${netbeans.jnlp.fixPolicy}
  • Type: java.io.File
  • Since: 3.0
  • Required: No

masterJnlpFileName:

The basename (minus .jnlp extension) of the master JNLP file in the output. This file will be the entry point for javaws. Defaults to the branding token.
  • Type: java.lang.String
  • Since: 3.5
  • Required: No
  • Expression: ${master.jnlp.file.name}

outputDirectory:

output directory where the the netbeans application will be created.
  • Type: java.io.File
  • Since: 3.0
  • Required: Yes
  • Default: ${project.build.directory}

processJarVersions:

If set true, build-jnlp target creates versioning info in jnlp descriptors and version.xml files. This allows for incremental updates of Webstart applications, but requires download via JnlpDownloadServlet Defaults to false, which means versioning info is not generated (see http://java.sun.com/j2se/1.5.0/docs/guide/javaws/developersguide/downloadservletguide.html#resources).
  • Type: boolean
  • Since: 3.0
  • Required: No
  • Expression: ${nbm.webstart.versions}
  • Default: false

webstartClassifier:

Artifact Classifier to use for the webstart distributable zip file.
  • Type: java.lang.String
  • Since: 3.1
  • Required: No
  • Expression: ${nbm.webstart.classifier}
  • Default: webstart