apptools:check-deployment

Full name:

de.smartics.maven.plugin:apptools-maven-plugin:0.9.0:check-deployment

Description:

Check which apps are deployed on the Confluence server.

Compare the artifacts on the Confluence server with those on the artifact server.

Attributes:

  • Since version: 1.0.

Optional Parameters

Name Type Since Description
<artifactServerId> String 1.0 The server ID to lookup additional credentials in the settings.xml. This is used when wagon needs extra authentication information.
User property is: apptools.artifactServerId.
<dryRun> boolean 1.0 A simple flag to populate the source, but without actually deploying to the target.
Default value is: false.
User property is: apptools.dryRun.
<excludes> List 1.0 Strings to match in app key to be excluded. If empty, nothing is excluded. Suffix searches are supported by appending the dollar character ($) to the include string.
User property is: apptools.excludes.
<includes> List 1.0 Strings to match apps keys to be listed. If empty, everything is included. Suffix searches are supported by appending the dollar character ($) to the include string.
User property is: apptools.includes.
<password> String 1.0 The password of the user to authenticate to the remote server.
User property is: apptools.password.
<requireReleases> boolean 1.0 If set to true only releases are considered. Otherwise snapshots are also taken into account.
Default value is: false.
User property is: apptools.requireReleases.
<rulesUri> String 1.0 URI of a ruleSet file containing the rules that control how to compare version numbers. The URI could be either a Wagon URI or a classpath URI (e.g. classpath:///package/sub/package/rules.xml).
User property is: rulesUri.
<serverId> String 1.0 The identifier for the server to fetch credentials in case username or password are not set explicitly. The credentials are used to connect to the REST API of the remote server.
User property is: apptools.serverId.
<serverUrl> String 1.0 The base server URL to locate services. This value is required, and is probably set via a profile in case more than one environment is targeted. Per convention, profiles containing a environment specific configuration, do not contain lower case letters.
User property is: apptools.serverUrl.
<servicePath> String 1.0 The path to the service on the server.

Defaults to '/rest/plugins/1.0/'.


Default value is: /rest/plugins/1.0/.
User property is: apptools.servicePath.
<settingsSecurityLocation> String 1.0 The location of the settings-security.xml.
Default value is: ${user.home}/.m2/settings-security.xml.
<skip> boolean 1.0 A simple flag to skip the deployment process.
Default value is: false.
User property is: apptools.skip.
<timeoutMs> int 1.0 The timeout in milliseconds for any connection issues accessing the remote service.

Defaults to '5000'.


User property is: apptools.timeout.
<tokenServicePath> String 1.0 The path to a service to fetch a token on the server.

Defaults to '/rest/plugins/1.0/'.


User property is: apptools.tokenServicePath.
<username> String 1.0 The name of the user to authenticate to the remote server.
User property is: apptools.username.
<verbose> boolean 1.0 A simple flag to log verbosely.
Default value is: false.
User property is: apptools.verbose.

Parameter Details

<artifactServerId>

The server ID to lookup additional credentials in the settings.xml. This is used when wagon needs extra authentication information.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: apptools.artifactServerId

<dryRun>

A simple flag to populate the source, but without actually deploying to the target.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: apptools.dryRun
  • Default: false

<excludes>

Strings to match in app key to be excluded. If empty, nothing is excluded. Suffix searches are supported by appending the dollar character ($) to the include string.
  • Type: java.util.List
  • Since: 1.0
  • Required: No
  • User Property: apptools.excludes

<includes>

Strings to match apps keys to be listed. If empty, everything is included. Suffix searches are supported by appending the dollar character ($) to the include string.
  • Type: java.util.List
  • Since: 1.0
  • Required: No
  • User Property: apptools.includes

<password>

The password of the user to authenticate to the remote server.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: apptools.password

<requireReleases>

If set to true only releases are considered. Otherwise snapshots are also taken into account.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: apptools.requireReleases
  • Default: false

<rulesUri>

URI of a ruleSet file containing the rules that control how to compare version numbers. The URI could be either a Wagon URI or a classpath URI (e.g. classpath:///package/sub/package/rules.xml).
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: rulesUri

<serverId>

The identifier for the server to fetch credentials in case username or password are not set explicitly. The credentials are used to connect to the REST API of the remote server.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: apptools.serverId

<serverUrl>

The base server URL to locate services. This value is required, and is probably set via a profile in case more than one environment is targeted. Per convention, profiles containing a environment specific configuration, do not contain lower case letters.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: apptools.serverUrl

<servicePath>

The path to the service on the server.

Defaults to '/rest/plugins/1.0/'.

  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: apptools.servicePath
  • Default: /rest/plugins/1.0/

<settingsSecurityLocation>

The location of the settings-security.xml.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Default: ${user.home}/.m2/settings-security.xml

<skip>

A simple flag to skip the deployment process.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: apptools.skip
  • Default: false

<timeoutMs>

The timeout in milliseconds for any connection issues accessing the remote service.

Defaults to '5000'.

  • Type: int
  • Since: 1.0
  • Required: No
  • User Property: apptools.timeout

<tokenServicePath>

The path to a service to fetch a token on the server.

Defaults to '/rest/plugins/1.0/'.

  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: apptools.tokenServicePath

<username>

The name of the user to authenticate to the remote server.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: apptools.username

<verbose>

A simple flag to log verbosely.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: apptools.verbose
  • Default: false