play2:start

Full name:

com.google.code.play2-maven-plugin:play2-maven-plugin:1.0.0-beta4:start

Description:

Start Play! server ("play 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
httpPort String 1.0.0 Alternative server port.
User property is: play2.httpPort.
httpsPort String 1.0.0 Alternative server port for secure connection (https protocol).
User property is: play2.httpsPort.
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.
serverJvmArgs String 1.0.0 Additional JVM arguments passed to Play! server's JVM
User property is: play2.serverJvmArgs.
startCheckUrl String 1.0.0 URL to check periodically when server is starting. Server is started when connection to this URL returns any content (does not throw IOException). Has to starts with 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 "http://localhost:${httpPort}${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

httpPort:

Alternative server port.
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: play2.httpPort

httpsPort:

Alternative server port for secure connection (https protocol).
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: play2.httpsPort

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

serverJvmArgs:

Additional JVM arguments passed to Play! server's JVM
  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: play2.serverJvmArgs

startCheckUrl:

URL to check periodically when server is starting. Server is started when connection to this URL returns any content (does not throw IOException). Has to starts with 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: /

startSkip:

Allows the server startup to be skipped.
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: play2.startSkip
  • Default: false

startSpawn:

Spawns started JVM process. See Ant Java task documentation for details.
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: play2.startSpawn
  • Default: true

startSynchro:

Start server synchronously. After starting server wait for "http://localhost:${httpPort}${startCheckUrl}" URL to be available.
  • Type: boolean
  • Since: 1.0.0
  • Required: No
  • User Property: play2.startSynchro
  • Default: false

startTimeout:

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