gae:run

Full name:

net.kindleit:maven-gae-plugin:0.9.2-SNAPSHOT:run

Description:

Runs the WAR project locally on the Google App Engine development server. You can specify jvm flags via the jvmFlags in the configuration section.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • Since version: 0.5.8.
  • Binds by default to the lifecycle phase: pre-integration-test.
  • Invokes the execution of the lifecycle phase package prior to executing itself.

Required Parameters

Name Type Since Description
appDir String 0.5.8 Overrides where the Project War Directory is located.
sdkDir String 0.5.8 Specifies where the Google App Engine SDK is located.
Default value is: ${settings.localRepository}/com/google/appengine/appengine-java-sdk/${gae.version}/appengine-java-sdk-${gae.version}.

Optional Parameters

Name Type Since Description
address String 0.5.8 Address to bind to.
Default value is: 0.0.0.0.
disableUpdateCheck boolean 0.5.8 Do not check for new SDK versions.
Default value is: false.
emailAccount String 0.5.8 Deprecated. use maven settings.xml/server/username and "serverId" parameter
encoding String 0.8.3 The character encoding scheme to be applied interacting with the SDK. Sent as the --compile_encoding flag.
Default value is: ${project.build.sourceEncoding}.
hostString String 0.5.8 Overrides the Host header sent with all RPCs.
javaAgent String 0.5.8 Optional javaAgent parameter prepended to the jvmFalgs.
jvmFlags List 0.5.8 Arbitrary list of JVM Flags to send to the KickStart task.
keepTempUploadDir boolean 0.5.8 Do not delete temporary directory used in uploading.
Default value is: false.
monitorKey String 0.5.8 Key to provide when making stop requests.
Default value is: monitor.${project.artifactId}.
monitorPort int 0.5.8 Port to listen for stop requests on.
Default value is: 8081.
passIn boolean 0.5.8 Always read the login password from stdin.
Default value is: false.
port int 0.5.8 Port to run in.
Default value is: 8080.
proxy String 0.5.8 Tell AppCfg to use a proxy. By default will use first active proxy in maven settings.xml
serverId String 0.5.8 The server id in maven settings.xml to use for emailAccount(username) and password when connecting to GAE. If password present in settings "--passin" is set automatically.
splitJars boolean 0.5.8 Split large jar files (> 10M) into smaller fragments.
Default value is: false.
uploadServer String 0.5.8 The server to connect to.
wait boolean 0.5.8 Decides whether to wait after the server is started or to return the execution flow to the user.
Default value is: false.

Parameter Details

address:

Address to bind to.
  • Type: java.lang.String
  • Since: 0.5.8
  • Required: No
  • Expression: ${gae.address}
  • Default: 0.0.0.0

appDir:

Overrides where the Project War Directory is located.
  • Type: java.lang.String
  • Since: 0.5.8
  • Required: Yes
  • Expression: ${project.build.directory}/${project.build.finalName}

disableUpdateCheck:

Do not check for new SDK versions.
  • Type: boolean
  • Since: 0.5.8
  • Required: No
  • Expression: ${gae.disableUpdateCheck}
  • Default: false

emailAccount:

Deprecated. use maven settings.xml/server/username and "serverId" parameter
The username to use. Will prompt if omitted.
  • Type: java.lang.String
  • Since: 0.5.8
  • Required: No
  • Expression: ${gae.email}

encoding:

The character encoding scheme to be applied interacting with the SDK. Sent as the --compile_encoding flag.
  • Type: java.lang.String
  • Since: 0.8.3
  • Required: No
  • Expression: ${encoding}
  • Default: ${project.build.sourceEncoding}

hostString:

Overrides the Host header sent with all RPCs.
  • Type: java.lang.String
  • Since: 0.5.8
  • Required: No
  • Expression: ${gae.host}

javaAgent:

Optional javaAgent parameter prepended to the jvmFalgs.
  • Type: java.lang.String
  • Since: 0.5.8
  • Required: No
  • Expression: ${gae.javaAgent}

jvmFlags:

Arbitrary list of JVM Flags to send to the KickStart task.
  • Type: java.util.List
  • Since: 0.5.8
  • Required: No

keepTempUploadDir:

Do not delete temporary directory used in uploading.
  • Type: boolean
  • Since: 0.5.8
  • Required: No
  • Expression: ${gae.keepTemps}
  • Default: false

monitorKey:

Key to provide when making stop requests.
  • Type: java.lang.String
  • Since: 0.5.8
  • Required: No
  • Expression: ${gae.monitor.key}
  • Default: monitor.${project.artifactId}

monitorPort:

Port to listen for stop requests on.
  • Type: int
  • Since: 0.5.8
  • Required: No
  • Expression: ${gae.monitor.port}
  • Default: 8081

passIn:

Always read the login password from stdin.
  • Type: boolean
  • Since: 0.5.8
  • Required: No
  • Expression: ${gae.passin}
  • Default: false

port:

Port to run in.
  • Type: int
  • Since: 0.5.8
  • Required: No
  • Expression: ${gae.port}
  • Default: 8080

proxy:

Tell AppCfg to use a proxy. By default will use first active proxy in maven settings.xml
  • Type: java.lang.String
  • Since: 0.5.8
  • Required: No
  • Expression: ${gae.proxy}

sdkDir:

Specifies where the Google App Engine SDK is located.
  • Type: java.lang.String
  • Since: 0.5.8
  • Required: Yes
  • Expression: ${gae.home}
  • Default: ${settings.localRepository}/com/google/appengine/appengine-java-sdk/${gae.version}/appengine-java-sdk-${gae.version}

serverId:

The server id in maven settings.xml to use for emailAccount(username) and password when connecting to GAE. If password present in settings "--passin" is set automatically.
  • Type: java.lang.String
  • Since: 0.5.8
  • Required: No
  • Expression: ${gae.serverId}

splitJars:

Split large jar files (> 10M) into smaller fragments.
  • Type: boolean
  • Since: 0.5.8
  • Required: No
  • Expression: ${gae.deps.split}
  • Default: false

uploadServer:

The server to connect to.
  • Type: java.lang.String
  • Since: 0.5.8
  • Required: No
  • Expression: ${gae.server}

wait:

Decides whether to wait after the server is started or to return the execution flow to the user.
  • Type: boolean
  • Since: 0.5.8
  • Required: No
  • Expression: ${gae.wait}
  • Default: false