graniteit:wait-for-server

Full name:

net.adamcin:graniteit-maven-plugin:0.8.0:wait-for-server

Description:

Waits for server readiness before continuing on to integration-test phase. Fails the build if the configured timeout is exceeded.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 0.6.0 .
  • Binds by default to the lifecycle phase: pre-integration-test.

Optional Parameters

Name Type Since Description
baseUrl String 0.6.0
Server base URL (including context path, but without trailing slash)

Default value is: http://localhost:4502.
User property is: graniteit.baseUrl.
expectedContent String 0.6.0
The content that is expected anywhere in the response text.

Default value is: QUICKSTART_HOMEPAGE.
noProxy boolean 0.6.0
Set to true to completely disable HTTP proxy connections for this plugin. Overrides any other HTTP proxy configuration

User property is: graniteit.proxy.noProxy.
password String 0.6.0
Password to use in connection credentials

Default value is: admin.
User property is: graniteit.password.
proxyHost String 0.6.0
The HTTP Proxy hostname

Default value is: localhost.
User property is: graniteit.proxy.host.
proxyPassword String 0.6.0
The HTTP Proxy password

User property is: graniteit.proxy.password.
proxyPort int 0.6.0
The HTTP Proxy port. Set to -1 to use the default proxy port.

User property is: graniteit.proxy.port.
proxyProtocol String 0.6.0
The HTTP Proxy protocol

Default value is: http.
User property is: graniteit.proxy.protocol.
proxyServerId String 0.6.0
Server ID for proxy credentials defined in maven settings

User property is: graniteit.proxy.serverId.
proxySet boolean 0.6.0
Set to true to override the proxy configuration in the user's Maven Settings with the associated mojo parameter alternatives

User property is: graniteit.proxy.set.
proxyUsername String 0.6.0
The HTTP Proxy username

User property is: graniteit.proxy.username.
serverId String 0.6.0
Id of server defined in the maven settings to use for credentials

User property is: graniteit.serverId.
serverReadyPath String 0.6.0
The server path to ping.

Default value is: /libs/granite/core/content/login.html.
skip boolean 0.6.0
Set to true to specifically disable this goal

User property is: graniteit.skip.wait-for-server.
skipITs boolean 0.6.0
By convention, this parameter is used to disable execution of the maven-failsafe-plugin. It is recognized by graniteit to disable uploading of test artifacts and integration test reporting goals.

User property is: skipITs.
skipMkdirs boolean 0.6.0
Set to true to skip the use of the MKCOL WebDAV method for the creation ancestor JCR paths

User property is: graniteit.skip.mkdirs.
skipTests boolean 0.6.0
By convention, this parameter is used to disable execution of maven-surefire-plugin-derived goals. It is recognized by graniteit to disable uploading of test artifacts and integration test reporting goals.

User property is: skipTests.
timeout int 0.6.0
Number of seconds to wait while pinging the configured IT server for the expected response

Default value is: 60.
username String 0.6.0
Specify the CQ username associated with package creation and installation

Default value is: admin.
User property is: graniteit.username.

Parameter Details

baseUrl:

Server base URL (including context path, but without trailing slash)
  • Type: java.lang.String
  • Since: 0.6.0
  • Required: No
  • User Property: graniteit.baseUrl
  • Default: http://localhost:4502

expectedContent:

The content that is expected anywhere in the response text.
  • Type: java.lang.String
  • Since: 0.6.0
  • Required: No
  • Default: QUICKSTART_HOMEPAGE

noProxy:

Set to true to completely disable HTTP proxy connections for this plugin. Overrides any other HTTP proxy configuration
  • Type: boolean
  • Since: 0.6.0
  • Required: No
  • User Property: graniteit.proxy.noProxy

password:

Password to use in connection credentials
  • Type: java.lang.String
  • Since: 0.6.0
  • Required: No
  • User Property: graniteit.password
  • Default: admin

proxyHost:

The HTTP Proxy hostname
  • Type: java.lang.String
  • Since: 0.6.0
  • Required: No
  • User Property: graniteit.proxy.host
  • Default: localhost

proxyPassword:

The HTTP Proxy password
  • Type: java.lang.String
  • Since: 0.6.0
  • Required: No
  • User Property: graniteit.proxy.password

proxyPort:

The HTTP Proxy port. Set to -1 to use the default proxy port.
  • Type: int
  • Since: 0.6.0
  • Required: No
  • User Property: graniteit.proxy.port

proxyProtocol:

The HTTP Proxy protocol
  • Type: java.lang.String
  • Since: 0.6.0
  • Required: No
  • User Property: graniteit.proxy.protocol
  • Default: http

proxyServerId:

Server ID for proxy credentials defined in maven settings
  • Type: java.lang.String
  • Since: 0.6.0
  • Required: No
  • User Property: graniteit.proxy.serverId

proxySet:

Set to true to override the proxy configuration in the user's Maven Settings with the associated mojo parameter alternatives
  • Type: boolean
  • Since: 0.6.0
  • Required: No
  • User Property: graniteit.proxy.set

proxyUsername:

The HTTP Proxy username
  • Type: java.lang.String
  • Since: 0.6.0
  • Required: No
  • User Property: graniteit.proxy.username

serverId:

Id of server defined in the maven settings to use for credentials
  • Type: java.lang.String
  • Since: 0.6.0
  • Required: No
  • User Property: graniteit.serverId

serverReadyPath:

The server path to ping.
  • Type: java.lang.String
  • Since: 0.6.0
  • Required: No
  • Default: /libs/granite/core/content/login.html

skip:

Set to true to specifically disable this goal
  • Type: boolean
  • Since: 0.6.0
  • Required: No
  • User Property: graniteit.skip.wait-for-server

skipITs:

By convention, this parameter is used to disable execution of the maven-failsafe-plugin. It is recognized by graniteit to disable uploading of test artifacts and integration test reporting goals.
  • Type: boolean
  • Since: 0.6.0
  • Required: No
  • User Property: skipITs

skipMkdirs:

Set to true to skip the use of the MKCOL WebDAV method for the creation ancestor JCR paths
  • Type: boolean
  • Since: 0.6.0
  • Required: No
  • User Property: graniteit.skip.mkdirs

skipTests:

By convention, this parameter is used to disable execution of maven-surefire-plugin-derived goals. It is recognized by graniteit to disable uploading of test artifacts and integration test reporting goals.
  • Type: boolean
  • Since: 0.6.0
  • Required: No
  • User Property: skipTests

timeout:

Number of seconds to wait while pinging the configured IT server for the expected response
  • Type: int
  • Since: 0.6.0
  • Required: No
  • Default: 60

username:

Specify the CQ username associated with package creation and installation
  • Type: java.lang.String
  • Since: 0.6.0
  • Required: No
  • User Property: graniteit.username
  • Default: admin