play2:start
Full name:
com.google.code.play2-maven-plugin:play2-maven-plugin:1.0.0-rc5:start
Description:
Start Play! server in production mode (sbt start
equivalent).
Attributes:
- Requires a Maven project to be executed.
- Requires dependency resolution of artifacts in scope: runtime.
- Since version: 1.0.0.
Optional Parameters
Name |
Type |
Since |
Description |
<mainModule> |
String |
1.0.0 |
Identifier of the module to start.
Important in multi-module projects with more than one
play2 modules to choose which one should be started.
There are three supported formats:
- artifactId or :artifactId - find
first module with given artifactId
- groupId:artifactId - find module with given
groupId and artifactId
If not specified, all reactor modules with play2
packaging will be selected.
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.
|
<prodSettings> |
String |
1.0.0 |
Extra settings used only in production mode (like
devSettings for development mode).
Space-separated list of key=value pairs, e.g.
play.server.http.port=9001 play.server.https.port=9443
User property is: play2.prodSettings.
|
<serverJvmArgs> |
String |
1.0.0 |
Additional JVM arguments passed to Play! server's JVM
Space-separated list of arguments, e.g.
-Xmx1024m -Dconfig.resource=application-prod.conf
-Dlogger.file=./conf/logback-prod.xml
User property is: play2.serverJvmArgs.
|
<startCheckUrl> |
String |
1.0.0 |
Relative or absolute URL to check periodically when server is
starting.
Server is started when connection to this URL returns any content
(does not throw IOException).
Relative URL is allowed only if absolute URL starts with
http://0.0.0.0:9000 (protocol, host and port have
their default values).
If URL is relative, it has to start with a slash character (like
URLs in conf/routes file).
Used only if startSynchro is true.
Default value is: /. User property is: play2.startCheckUrl.
|
<startSkip> |
boolean |
1.0.0 |
Allows the server startup to be skipped.
Default value is: false. User property is: play2.startSkip.
|
<startSpawn> |
boolean |
1.0.0 |
Spawns started JVM process.
See Ant Java
task documentation for details.
Default value is: true. User property is: play2.startSpawn.
|
<startSynchro> |
boolean |
1.0.0 |
Start server synchronously.
After starting server wait for startCheckUrl URL to be
available.
Default value is: false. User property is: play2.startSynchro.
|
<startTimeout> |
int |
1.0.0 |
Server start timeout in milliseconds.
Used only if startSynchro is true.
Default value is: 0. User property is: play2.startTimeout.
|
Parameter Details
Identifier of the module to start.
Important in multi-module projects with more than one
play2 modules to choose which one should be started.
There are three supported formats:
- artifactId or :artifactId - find
first module with given artifactId
- groupId:artifactId - find module with given
groupId and artifactId
If not specified, all reactor modules with
play2
packaging will be selected.
- Type: java.lang.String
- Since: 1.0.0
- Required: No
- User Property: play2.mainModule
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
Extra settings used only in production mode (like
devSettings for development mode).
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.prodSettings
Additional JVM arguments passed to Play! server's JVM
Space-separated list of arguments, e.g.
-Xmx1024m -Dconfig.resource=application-prod.conf
-Dlogger.file=./conf/logback-prod.xml
- Type: java.lang.String
- Since: 1.0.0
- Required: No
- User Property: play2.serverJvmArgs
Relative or absolute URL to check periodically when server is
starting.
Server is started when connection to this URL returns any content
(does not throw IOException).
Relative URL is allowed only if absolute URL starts with
http://0.0.0.0:9000 (protocol, host and port have
their default values).
If URL is relative, it has to start with a slash character (like
URLs in conf/routes file).
Used only if startSynchro is true.
- Type: java.lang.String
- Since: 1.0.0
- Required: No
- User Property: play2.startCheckUrl
- Default: /
Allows the server startup to be skipped.
- Type: boolean
- Since: 1.0.0
- Required: No
- User Property: play2.startSkip
- Default: false
- Type: boolean
- Since: 1.0.0
- Required: No
- User Property: play2.startSpawn
- Default: true
Start server synchronously.
After starting server wait for startCheckUrl URL to be
available.
- Type: boolean
- Since: 1.0.0
- Required: No
- User Property: play2.startSynchro
- Default: false
Server start timeout in milliseconds.
Used only if startSynchro is true.
- Type: int
- Since: 1.0.0
- Required: No
- User Property: play2.startTimeout
- Default: 0