smartics-properties:properties-transfer

Full name:

de.smartics.properties:smartics-properties-maven-plugin:0.2.0:properties-transfer

Description:

Transfers property definitions from a source to a target location.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 1.0.

Required Parameters

Name Type Since Description
definitionConfigParser DefinitionConfigParser 1.0 Parser to read definition.xml files to determine the configuration key for a given properties file.
propertySinkFactory PropertySinkFactory 1.0 Factory to create property sinks.

Optional Parameters

Name Type Since Description
artifactItems List 1.0 The list of artifactItems containing additional property definitions.
clearStore boolean 1.0 If set to true the store will be cleared from all values prior to writing the new ones. If set to false new keys will be added and existing keys overridden. Any keys not contained in the new set of keys will be preserved in the store.

Although most use cases will set this to true, the default is conservative to not delete the property keys by accident.


Default value is: false.
User property is: properties-transfer.clearStore.
propertiesFolder File 1.0 The folder within the project that contains the properties to be transferred. If not specified, no locally stored properties are considered. If the folder contains definition JARs, their properties files will be transfered, too.
User property is: project.build.outputDirectory.
skip boolean 1.0 A simple flag to skip the transfer. If set on the command line use -Dproperties-transfer.skip.
Default value is: false.
User property is: properties-transfer.skip.

Parameter Details

artifactItems:

The list of artifactItems containing additional property definitions.
  • Type: java.util.List
  • Since: 1.0
  • Required: No

clearStore:

If set to true the store will be cleared from all values prior to writing the new ones. If set to false new keys will be added and existing keys overridden. Any keys not contained in the new set of keys will be preserved in the store.

Although most use cases will set this to true, the default is conservative to not delete the property keys by accident.

  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: properties-transfer.clearStore
  • Default: false

definitionConfigParser:

Parser to read definition.xml files to determine the configuration key for a given properties file.
  • Type: de.smartics.properties.spi.config.definition.DefinitionConfigParser
  • Since: 1.0
  • Required: Yes

propertiesFolder:

The folder within the project that contains the properties to be transferred. If not specified, no locally stored properties are considered. If the folder contains definition JARs, their properties files will be transfered, too.
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • User Property: project.build.outputDirectory

propertySinkFactory:

Factory to create property sinks.
  • Type: de.smartics.properties.api.config.transfer.PropertySinkFactory
  • Since: 1.0
  • Required: Yes

skip:

A simple flag to skip the transfer. If set on the command line use -Dproperties-transfer.skip.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: properties-transfer.skip
  • Default: false