play2:run
Full name:
com.google.code.play2-maven-plugin:play2-maven-plugin:1.0.0-rc5:run
Description:
Run Play! server in development mode (sbt run
equivalent).
Attributes:
- Requires a Maven project to be executed.
- Since version: 1.0.0.
Required Parameters
| Name | Type | Since | Description |
|---|---|---|---|
| <runGoals> | String | 1.0.0 | Maven goals to execute during project rebuild. In multi-module projects they are executed for all modules being rebuilt. Default value is: process-classes. User property is: play2.runGoals. |
Optional Parameters
| Name | Type | Since | Description |
|---|---|---|---|
| <assetsOutputDirectory> | File | 1.0.0 | Directory containing all processed web assets. Default value is: ${project.build.outputDirectory}/public. User property is: play2.assetsOutputDirectory. |
| <assetsPrefix> | String | 1.0.0 | Web asset URLs prefix. Default value is: public/. User property is: play2.assetsPrefix. |
| <devSettings> | String | 1.0.0 | Extra settings used only in development mode (see Play!
Framework documentation) Space-separated list of key=value pairs, e.g. play.server.http.port=9001 play.server.https.port=9443 User property is: play2.devSettings. |
| <fileWatchService> | String | 1.0.0 | Watch service used to watch for file changes. Supported watch services:
Default watch service is selected based on operating system and JDK version. User property is: play2.fileWatchService. |
| <httpAddress> | String | 1.0.0 | Server address. User property is: play2.httpAddress. |
| <httpPort> | String | 1.0.0 | Server port (HTTP protocol) or disabled to disable
HTTP protocol. User property is: play2.httpPort. |
| <httpsPort> | String | 1.0.0 | Server port for secure connection (HTTPS protocol). User property is: play2.httpsPort. |
| <mainModule> | String | 1.0.0 | Identifier of the module to run. Important in multi-module projects with more than one play2 modules to select which one should be run. There are three supported formats:
User property is: play2.mainModule. |
| <playVersion> | String | 1.0.0 | Used to automatically select one of the "well known" Play!
providers if no provider added explicitly as plugin's dependency. User property is: play2.version. |
| <runAdditionalGoals> | String | 1.0.0 | Additional Maven goals to execute during project rebuild. In multi-module projects they are executed only for the main module. It's required when calling SbtWeb plugin (via sbtrun-maven-plugin) in multi-module project. User property is: play2.runAdditionalGoals. |
| <runSkip> | boolean | 1.0.0 | Allows the run to be skipped. Default value is: false. User property is: play2.runSkip. |
| <sbtVersion> | String | 1.0.0 | Forced SBT version. Used to automatically select one of the "well known" SBT compilation analysis processors (if no SBT compiler added explicitly as plugin's dependency). There are two cases possible:
User property is: sbt.version. |
| <serverJvmArgs> | String | 1.0.0 | Additional JVM arguments passed to Play! server's JVM. Because this goal does not fork JVM, only system properties are used, other arguments are ignored. User property is: play2.serverJvmArgs. |
| <sourceEncoding> | String | 1.0.0 | Source files encoding. If not specified, the encoding value will be the value of the file.encoding system property. User property is: project.build.sourceEncoding. |
Parameter Details
<assetsOutputDirectory>
Directory containing all processed web assets.
- Type: java.io.File
- Since: 1.0.0
- Required: No
- User Property: play2.assetsOutputDirectory
- Default: ${project.build.outputDirectory}/public
<assetsPrefix>
Web asset URLs prefix.
- Type: java.lang.String
- Since: 1.0.0
- Required: No
- User Property: play2.assetsPrefix
- Default: public/
<devSettings>
Extra settings used only in development mode (see Play!
Framework documentation)
Space-separated list of key=value pairs, e.g.
play.server.http.port=9001 play.server.https.port=9443
Space-separated list of key=value pairs, e.g.
play.server.http.port=9001 play.server.https.port=9443
- Type: java.lang.String
- Since: 1.0.0
- Required: No
- User Property: play2.devSettings
<fileWatchService>
Watch service used to watch for file changes.
Supported watch services:
Default watch service is selected based on operating system and JDK version.
Supported watch services:
- jdk7
- jnotify
- polling
Default watch service is selected based on operating system and JDK version.
- Type: java.lang.String
- Since: 1.0.0
- Required: No
- User Property: play2.fileWatchService
<httpAddress>
Server address.
- Type: java.lang.String
- Since: 1.0.0
- Required: No
- User Property: play2.httpAddress
<httpPort>
Server port (HTTP protocol) or disabled to disable
HTTP protocol.
- Type: java.lang.String
- Since: 1.0.0
- Required: No
- User Property: play2.httpPort
<httpsPort>
Server port for secure connection (HTTPS protocol).
- Type: java.lang.String
- Since: 1.0.0
- Required: No
- User Property: play2.httpsPort
<mainModule>
Identifier of the module to run.
Important in multi-module projects with more than one play2 modules to select which one should be run.
There are three supported formats:
Important in multi-module projects with more than one play2 modules to select which one should be run.
There are three supported formats:
- artifactId or :artifactId - find first module with given artifactId
- groupId:artifactId - find module with given groupId and artifactId
- Type: java.lang.String
- Since: 1.0.0
- Required: No
- User Property: play2.mainModule
<playVersion>
Used to automatically select one of the "well known" Play!
providers if no provider added explicitly as plugin's dependency.
- Type: java.lang.String
- Since: 1.0.0
- Required: No
- User Property: play2.version
<runAdditionalGoals>
Additional Maven goals to execute during project rebuild.
In multi-module projects they are executed only for the main module.
It's required when calling SbtWeb plugin (via sbtrun-maven-plugin) in multi-module project.
In multi-module projects they are executed only for the main module.
It's required when calling SbtWeb plugin (via sbtrun-maven-plugin) in multi-module project.
- Type: java.lang.String
- Since: 1.0.0
- Required: No
- User Property: play2.runAdditionalGoals
<runGoals>
Maven goals to execute during project rebuild.
In multi-module projects they are executed for all modules being rebuilt.
In multi-module projects they are executed for all modules being rebuilt.
- Type: java.lang.String
- Since: 1.0.0
- Required: Yes
- User Property: play2.runGoals
- Default: process-classes
<runSkip>
Allows the run to be skipped.
- Type: boolean
- Since: 1.0.0
- Required: No
- User Property: play2.runSkip
- Default: false
<sbtVersion>
Forced SBT version.
Used to automatically select one of the "well known" SBT compilation analysis processors (if no SBT compiler added explicitly as plugin's dependency).
There are two cases possible:
Used to automatically select one of the "well known" SBT compilation analysis processors (if no SBT compiler added explicitly as plugin's dependency).
There are two cases possible:
- If sbtVersion is specified, AnalysisProcessor implementation compatible with that SBT version is selected.
- If sbtVersion is not specified, playVersion parameter value is used to indirectly select AnalysisProcessor implementation compatible with that Play! Framework version.
- Type: java.lang.String
- Since: 1.0.0
- Required: No
- User Property: sbt.version
<serverJvmArgs>
Additional JVM arguments passed to Play! server's JVM.
Because this goal does not fork JVM, only system properties are used, other arguments are ignored.
Because this goal does not fork JVM, only system properties are used, other arguments are ignored.
- Type: java.lang.String
- Since: 1.0.0
- Required: No
- User Property: play2.serverJvmArgs
<sourceEncoding>
Source files encoding.
If not specified, the encoding value will be the value of the file.encoding system property.
If not specified, the encoding value will be the value of the file.encoding system property.
- Type: java.lang.String
- Since: 1.0.0
- Required: No
- User Property: project.build.sourceEncoding