apptools:enable

Full name:

de.smartics.maven.plugin:apptools-maven-plugin:0.9.0:enable

Description:

Enable apps on the Confluence server.

Either specify the apps you want to enable explicitly by their plugin keys (using the 'pluginKeys' parameter) or choose to find the keys in the artifacts found in the folder specified by the 'sourceFolder' parameter.

Attributes:

  • Since version: 1.0.

Optional Parameters

Name Type Since Description
<acceptedFilenameExtensions> List 1.0 Specify the file name extensions to accept.
User property is: apptools.acceptedFilenameExtensions.
<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.
<artifacts> List 1.0 List of specification strings to locate artifacts on the artifact server and download them to the configured source repository.
User property is: apptools.artifacts.
<deployedAppsServicePath> String 1.0 The path to the service on the server to check which apps are deployed.

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


User property is: apptools.deployedAppsServicePath.
<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 file names for exclusion. If empty, nothing is excluded. Suffix searches are supported by appending the dollar character ($) to the include string.
User property is: apptools.excludes.
<ignoreNonEmptySourceFolder> boolean 1.0 If the source folder is not empty, the build will be terminated with an fail message. This prevents the user to deploy artifacts in an existing folder.
Default value is: false.
User property is: apptools.ignoreNonEmptySourceFolder.
<includes> List 1.0 Strings to match in app file names for inclusion. If empty, everything is included. Suffix searches are supported by appending the dollar character ($) to the include string.
User property is: apptools.includes.
<mode> String 1.0 Specify whether to extract keys from the local artifacts (LOCAL), fetch keys from the remote server (REMOTE) or both (BOTH). Note that includes and excludes are applied in either case.

Defaults to 'LOCAL'.


User property is: apptools.mode.
<order> List 1.0 Allows to impose a sort order on the list of artifacts to be deployed. The list represents stages (1, 2, 3, ...) that will deploy all matching artifacts.
User property is: apptools.order.
<password> String 1.0 The password of the user to authenticate to the remote server.
User property is: apptools.password.
<pluginKeys> List 1.0 List of key for plugins to enable. If plugins are explicitly specified, local artifacts in the source folder are not checked.
User property is: apptools.pluginKeys.
<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/enablement-state/'.


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.
<sourceFolder> String 1.0 The folder with application files to process.

Defaults to 'target/apps'.


User property is: apptools.source.
<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.
<useLatest> String 1.0 Override any specified versions in the POM with the latest version. Use SNAPSHOT for the latest snapshot release, RELEASE for the latest public release.
User property is: apptools.useLatest.
<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

<acceptedFilenameExtensions>

Specify the file name extensions to accept.
  • Type: java.util.List
  • Since: 1.0
  • Required: No
  • User Property: apptools.acceptedFilenameExtensions

<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

<artifacts>

List of specification strings to locate artifacts on the artifact server and download them to the configured source repository.
  • Type: java.util.List
  • Since: 1.0
  • Required: No
  • User Property: apptools.artifacts

<deployedAppsServicePath>

The path to the service on the server to check which apps are deployed.

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

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

<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 file names for exclusion. 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

<ignoreNonEmptySourceFolder>

If the source folder is not empty, the build will be terminated with an fail message. This prevents the user to deploy artifacts in an existing folder.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: apptools.ignoreNonEmptySourceFolder
  • Default: false

<includes>

Strings to match in app file names for inclusion. 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

<mode>

Specify whether to extract keys from the local artifacts (LOCAL), fetch keys from the remote server (REMOTE) or both (BOTH). Note that includes and excludes are applied in either case.

Defaults to 'LOCAL'.

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

<order>

Allows to impose a sort order on the list of artifacts to be deployed. The list represents stages (1, 2, 3, ...) that will deploy all matching artifacts.
  • Type: java.util.List
  • Since: 1.0
  • Required: No
  • User Property: apptools.order

<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

<pluginKeys>

List of key for plugins to enable. If plugins are explicitly specified, local artifacts in the source folder are not checked.
  • Type: java.util.List
  • Since: 1.0
  • Required: No
  • User Property: apptools.pluginKeys

<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/enablement-state/'.

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

<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

<sourceFolder>

The folder with application files to process.

Defaults to 'target/apps'.

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

<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

<useLatest>

Override any specified versions in the POM with the latest version. Use SNAPSHOT for the latest snapshot release, RELEASE for the latest public release.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: apptools.useLatest

<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