Fork me on GitHub

multienv:environment

Full name:

com.soebes.maven.plugins:multienv-maven-plugin:0.3.1:environment

Description:

This mojo will get the main artifact of the current project unpack it and use the files of the appropriate environment and produce new files which contain the original files plus the supplemental files which have been given by the configuration for each environment.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: package.

Optional Parameters

Name Type Since Description
archive MavenArchiveConfiguration - The archive configuration to use. See Maven Archiver Reference.
delimiters LinkedHashSet -

Set of delimiters for expressions to filter within the resources. These delimiters are specified in the form 'beginToken*endToken'. If no '*' is given, the delimiter is assumed to be the same for start and end.

So, the default filtering delimiters might be specified as:

<delimiters>
  <delimiter>${*}</delimiter>
  <delimiter>@</delimiter>
</delimiters>

Since the '@' delimiter is the same on both ends, we don't need to specify '@*@' (though we can).
encoding String - The character encoding scheme to be applied when filtering resources.
Default value is: ${project.build.sourceEncoding}.
escapeString String - Expression preceded with the String won't be interpolated \${foo} will be replaced with ${foo}
escapeWindowsPaths boolean - Whether to escape backslashes and colons in windows-style paths.
Default value is: true.
fileNameFiltering boolean - Support filtering of filenames directories etc.
Default value is: false.
filters List - The list of extra filter properties files to be used along with System properties, project properties, and filter properties files specified in the POM build/filters section, which should be used for the filtering during the current mojo execution.
Normally, these will be configured from a plugin's execution section, to provide a different set of filters for a particular execution. For instance, starting in Maven 2.2.0, you have the option of configuring executions with the id's default-resources and default-testResources to supply different configurations for the two different types of resources. By supplying extraFilters configurations, you can separate which filters are used for which type of resource.
includeEmptyDirs boolean - Include empty directories or not.
Default value is: true.
nonFilteredFileExtensions List - Additional file extensions to not apply filtering (already defined are : jpg, jpeg, gif, bmp, png)
sourceDirectory File - directory which contains the different environments
Default value is: ${basedir}/src/main/environments.
supportMultiLineFiltering boolean - stop searching endToken at the end of line
Default value is: false.
useDefaultDelimiters boolean - Use default delimiters in addition to custom delimiters, if any.
Default value is: true.

Parameter Details

archive:

The archive configuration to use. See Maven Archiver Reference.
  • Type: org.apache.maven.archiver.MavenArchiveConfiguration
  • Required: No

delimiters:

Set of delimiters for expressions to filter within the resources. These delimiters are specified in the form 'beginToken*endToken'. If no '*' is given, the delimiter is assumed to be the same for start and end.

So, the default filtering delimiters might be specified as:

<delimiters>
  <delimiter>${*}</delimiter>
  <delimiter>@</delimiter>
</delimiters>

Since the '@' delimiter is the same on both ends, we don't need to specify '@*@' (though we can).

  • Type: java.util.LinkedHashSet
  • Required: No

encoding:

The character encoding scheme to be applied when filtering resources.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.sourceEncoding}

escapeString:

Expression preceded with the String won't be interpolated \${foo} will be replaced with ${foo}
  • Type: java.lang.String
  • Required: No

escapeWindowsPaths:

Whether to escape backslashes and colons in windows-style paths.
  • Type: boolean
  • Required: No
  • Default: true

fileNameFiltering:

Support filtering of filenames directories etc.
  • Type: boolean
  • Required: No
  • Default: false

filters:

The list of extra filter properties files to be used along with System properties, project properties, and filter properties files specified in the POM build/filters section, which should be used for the filtering during the current mojo execution.
Normally, these will be configured from a plugin's execution section, to provide a different set of filters for a particular execution. For instance, starting in Maven 2.2.0, you have the option of configuring executions with the id's default-resources and default-testResources to supply different configurations for the two different types of resources. By supplying extraFilters configurations, you can separate which filters are used for which type of resource.
  • Type: java.util.List
  • Required: No

includeEmptyDirs:

Include empty directories or not.
  • Type: boolean
  • Required: No
  • Default: true

nonFilteredFileExtensions:

Additional file extensions to not apply filtering (already defined are : jpg, jpeg, gif, bmp, png)
  • Type: java.util.List
  • Required: No

sourceDirectory:

directory which contains the different environments
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/src/main/environments

supportMultiLineFiltering:

stop searching endToken at the end of line
  • Type: boolean
  • Required: No
  • Default: false

useDefaultDelimiters:

Use default delimiters in addition to custom delimiters, if any.
  • Type: boolean
  • Required: No
  • Default: true