Go to start of metadata
- Created by Robert Reiner on 10. Apr 2019
Enable apps on the Confluence server.
- Name
- apptools:enable
- Full Name
- de.smartics.maven.plugin:apptools-maven-plugin:0.11.1:enable
- Since
- 1.0
- Inherited by Default
- true
- Instantiation Strategy
- per-lookup
- Execute Strategy
- once-per-session
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.
Parameters
Optional Parameters
| Name | Since | Data Type | Short Description |
|---|---|---|---|
| acceptedFilenameExtensions | 1.0 | List | Specify the file name extensions to accept. |
| artifacts | 1.0 | List | List of specification strings to locate artifacts on the artifact server
and download them to the configured source repository. |
| artifactServerId | 1.0 | String | The server ID to lookup additional credentials in the settings.xml.
This is used when wagon needs extra authentication information.
User property: apptools.artifactServerId, artifactServerId |
| deployedAppsServicePath | 1.0 | String | The path to the service on the server to check which apps are deployed.
|
| dryRun | 1.0 | boolean | A simple flag to run on the specified environment, but without actually
enabling apps on the target. |
| enablementStateServicePath | 1.0 | String | The path to the service on the server.
|
| excludes | 1.0 | List | 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. |
| ignoreNonEmptySourceFolder | 1.0 | boolean | 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. |
| includes | 1.0 | List | 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. |
| mode | 1.0 | String | 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.
|
| order | 1.0 | List | 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. |
| password | 1.0 | String | The password of the user to authenticate to the remote server. |
| pluginKeys | 1.0 | List | List of key for plugins to enable. If plugins are explicitly specified,
local artifacts in the source folder are not checked. |
| requireReleases | 1.0 | boolean | If set to true only releases are considered. Otherwise
snapshots are also taken into account. |
| rulesUri | 1.0 | String | 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). |
| serverId | 1.0 | String | 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. |
| serverUrl | 1.0 | String | 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. |
| settingsSecurityLocation | 1.0 | String | The location of the settings-security.xml. |
| skip | 1.0 | boolean | A simple flag to skip the deployment process. |
| sourceFolder | 1.0 | String | The folder with application files to process.
|
| timeoutMs | 1.0 | Integer | The timeout in milliseconds for any connection issues accessing the remote
service.
|
| tokenServicePath | 1.0 | String | The path to a service to fetch a token on the server.
|
| useLatest | 1.0 | String | Override any specified versions in the POM with the latest version. Use
SNAPSHOT for the latest snapshot release, RELEASE
for the latest public release. |
| username | 1.0 | String | The name of the user to authenticate to the remote server. |
| verbose | 1.0 | boolean | A simple flag to log verbosely. |
