Fork me on GitHub

play2:package-war

Full name:

de.akquinet.innovation.play2:play2-maven-plugin:1.2.2-SNAPSHOT:package-war

Description:

Packages the Play application as War.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Binds by default to the lifecycle phase: package.

Optional Parameters

Name Type Since Description
additionalFiles List - Allows customization of the play packaging. The files specified in this attribute will get added to the distribution zip file. This allows, for example, to write your own start script and have it packaged in the distribution. This is done post-packaging by the play framework. This parameter is shared with the package mojo.
baseDirectory File - Base directory of the project.
buildDirectory File - Directory containing the build files.
buildWar boolean - Enables or disabled the packaging of the application as a War file.
Default value is: true.
play2Home String - The PLAY2_HOME path is taken from this setting, if not found as a Java system property (-DPLAY2_HOME). Refers to the PLAY2_HOME environment variable by default. So that means that the PLAY2_HOME can be given using:
  1. A system variable defined by the system or with -DPLAY2_HOME=...
  2. The play2Home configuration property
  3. The PLAY2_HOME environment property
play2SystemProperties Properties - Allows customization of the play execution System properties.
pluginArtifacts List - Dependencies of the current plugin. This list is used to extract and copy the servlet bridge.
timeout long - Sets a timeout to the play invocation (in milliseconds). If not set (or set to -1, the plugin waits until the underlying play process completes. If set, the plugin kills the underlying play process when the timeout is reached, and it fails the build.
Default value is: -1.
warClassifier String - Sets the war classifier.
webappDirectory File - The directory where the webapp is built.
Default value is: ${project.build.directory}/${project.build.finalName}.

Parameter Details

additionalFiles:

Allows customization of the play packaging. The files specified in this attribute will get added to the distribution zip file. This allows, for example, to write your own start script and have it packaged in the distribution. This is done post-packaging by the play framework. This parameter is shared with the package mojo.
  • Type: java.util.List
  • Required: No

baseDirectory:

Base directory of the project.
  • Type: java.io.File
  • Required: No
  • Expression: ${basedir}

buildDirectory:

Directory containing the build files.
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}

buildWar:

Enables or disabled the packaging of the application as a War file.
  • Type: boolean
  • Required: No
  • Default: true

play2Home:

The PLAY2_HOME path is taken from this setting, if not found as a Java system property (-DPLAY2_HOME). Refers to the PLAY2_HOME environment variable by default. So that means that the PLAY2_HOME can be given using:
  1. A system variable defined by the system or with -DPLAY2_HOME=...
  2. The play2Home configuration property
  3. The PLAY2_HOME environment property
  • Type: java.lang.String
  • Required: No
  • Expression: ${env.PLAY2_HOME}

play2SystemProperties:

Allows customization of the play execution System properties.
  • Type: java.util.Properties
  • Required: No

pluginArtifacts:

Dependencies of the current plugin. This list is used to extract and copy the servlet bridge.
  • Type: java.util.List
  • Required: No
  • Expression: ${plugin.artifacts}

timeout:

Sets a timeout to the play invocation (in milliseconds). If not set (or set to -1, the plugin waits until the underlying play process completes. If set, the plugin kills the underlying play process when the timeout is reached, and it fails the build.
  • Type: long
  • Required: No
  • Expression: ${play2timeout}
  • Default: -1

warClassifier:

Sets the war classifier.
  • Type: java.lang.String
  • Required: No

webappDirectory:

The directory where the webapp is built.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/${project.build.finalName}