Configurator Maven Plugin – iterator:invoker

iterator:invoker

Full name:

com.soebes.maven.plugins:iterator-maven-plugin:0.5.1:invoker

Description:

Invoker will execute an Maven instance by iterating through the given items.

Attributes:

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

Required Parameters

Name	Type	Since	Description
beginToken	`String`	`-`	The token the iterator placeholder begins with. Default value is: `@`.
endToken	`String`	`-`	The token the iterator placeholder ends with. Default value is: `@`.
iteratorName	`String`	`-`	The name of the iterator variable. Default value is: `item`.

Optional Parameters

Name	Type	Since	Description
alsoMake	`boolean`	`-`	This will `--also-make` Default value is: `false`.
alsoMakeDependents	`boolean`	`-`	This will activate `--also-make-dependents` Default value is: `false`.
baseDirectory	`File`	`-`	Sets the path to the base directory of the POM for the Maven invocation. If `getPomFile()` does not return `null`, this setting only affects the working directory for the Maven invocation. Here you can use the placeholder like: EXAMPLE
content	`String`	`-`	The list of items which will be iterated through. `<content>one, two, three</content>`
debug	`boolean`	`-`	`-Ddebug=true` Default value is: `false`.
delimiter	`String`	`-`	The delimiter which will be used to split the `content`. Default value is: `,`.
failAtEnd	`boolean`	`-`	Fail the execution at the end of all iterations or fail the whole if one iteration step fails. Default value is: `false`. User property is: `iterator.failAtEnd`.
failureBehaviour	`String`	`-`	The valid values are `InvocationRequest.REACTOR_FAIL_AT_END`, `InvocationRequest.REACTOR_FAIL_FAST`, `InvocationRequest.REACTOR_FAIL_NEVER`. Default value is: `fail-fast`.
folder	`File`	`-`	By using this folder you define a folder which sub folders will be used to iterate over. It will be iterated over the directories but not the sub folders so no recursion will be done. The order of the iterated elements is done by `sortOrder`.
globalChecksumPolicy	`String`	`-`	Sets the checksum mode of the Maven invocation. Equivalent of `-c` or `--lax-checksums`, `-C` or `--strict-checksums` Default value is: `warn`.
globalSettingsFile	`File`	`-`	The path to the global settings for the Maven invocation or `null` to load the global settings from the default location.
goals	`List`	`-`	The list of goals which will be called during each invocation of Maven. TODO: Change the name, cause we are calling life cycle phases instead of goal but we can if we like things like site:site ?
interactive	`boolean`	`-`	This will set `--batch-mode` Default value is: `false`.
items	`List`	`-`	Here you can define the items which will be iterated through. `<items> <item>one</item> <item>two</item> <item>three</item> .. </items>` User property is: `iterator.items`.
itemsWithProperties	`List`	`-`	If you like to have items to iterate through which also contain supplemental properties. This can be done by using the following: `<itemsWithProperties> <itemWithProperty> <name>one</name> <properties> <xyz>google</xyz> </properties> </itemWithProperty> <itemWithProperty> <name>two</name> <properties> <xyz>theseverside</xyz> </properties> </itemWithProperty> .. </items>` You are not determined having the same properties for the iterations. You can use different properties for each iteration.
localRepositoryDirectory	`File`	`-`	If `null` the default location from `settings.xml` will be used.
mavenOpts	`String`	`-`	If `null`.
nonPluginUpdates	`boolean`	`-`	If true `--no-plugin-updates` will be used.
offline	`boolean`	`-`	`true` Maven will be executed in off-line mode ( `--offline`).
profiles	`List`	`-`	The list of profiles.
projects	`List`	`-`	Sets the reactor project list. Equivalent of `-pl` or `--projects` projects the reactor project list
properties	`Properties`	`-`	Sets the system properties for the Maven invocation, may be `null` if not set.
recursive	`boolean`	`-`	Sets the recursion behavior of a reactor invocation. Inverse equivalent of `-N` and `--non-recursive` Default value is: `false`.
resumeFrom	`String`	`-`	Specify the reactor project to resume from.
shellEnvironmentInherited	`boolean`	`-`	Indicates whether the environment variables of the current process should be propagated to the Maven invocation. By default, the current environment variables are inherited by the new Maven invocation. Default value is: `true`.
showErrors	`boolean`	`-`	Gets the exception output mode of the Maven invocation. By default, Maven will not print stack traces of build exceptions. Default value is: `false`.
showVersion	`boolean`	`-`	The show version behaviour `-V` option. Default value is: `false`.
skip	`boolean`	`-`	If you like to skip the execution. Default value is: `false`. User property is: `iterator.skip`.
sortOrder	`String`	`-`	This defines the sort order for the folders which will be iterated over. `NameFileComparator.NAME_COMPARATOR` `NameFileComparator.NAME_INSENSITIVE_COMPARATOR` `NameFileComparator.NAME_INSENSITIVE_REVERSE` `NameFileComparator.NAME_REVERSE` `NameFileComparator.NAME_SYSTEM_COMPARATOR` `NameFileComparator.NAME_SYSTEM_REVERSE` Default value is: `NAME_COMPARATOR`.
threads	`String`	`-`	`-T` option of Maven.
toolchains	`File`	`-`	Set the path to the custom toolchains file
updateSnapshots	`boolean`	`-`	Indicates whether Maven should enforce an update check for plugins and snapshots. By default, no update check is performed `--update-snapshots`. Default value is: `false`.
userSettings	`File`	`-`	Sets the path to the user settings for the Maven invocation.
workingDirectory	`File`	`-`	(no description)

Parameter Details

alsoMake:

This will --also-make

Type: boolean
Required: No
Default: false

alsoMakeDependents:

This will activate --also-make-dependents

Type: boolean
Required: No
Default: false

baseDirectory:

Sets the path to the base directory of the POM for the Maven invocation. If getPomFile() does not return null, this setting only affects the working directory for the Maven invocation. Here you can use the placeholder like: EXAMPLE

Type: java.io.File
Required: No

beginToken:

The token the iterator placeholder begins with.

Type: java.lang.String
Required: Yes
Default: @

content:

The list of items which will be iterated through. <content>one, two, three</content>

Type: java.lang.String
Required: No

debug:

-Ddebug=true

Type: boolean
Required: No
Default: false

delimiter:

The delimiter which will be used to split the content.

Type: java.lang.String
Required: No
Default: ,

endToken:

The token the iterator placeholder ends with.

Type: java.lang.String
Required: Yes
Default: @

failAtEnd:

Fail the execution at the end of all iterations or fail the whole if one iteration step fails.

Type: boolean
Required: No
User Property: iterator.failAtEnd
Default: false

failureBehaviour:

The valid values are InvocationRequest.REACTOR_FAIL_AT_END, InvocationRequest.REACTOR_FAIL_FAST, InvocationRequest.REACTOR_FAIL_NEVER.

Type: java.lang.String
Required: No
Default: fail-fast

folder:

By using this folder you define a folder which sub folders will be used to iterate over. It will be iterated over the directories but not the sub folders so no recursion will be done. The order of the iterated elements is done by sortOrder.

Type: java.io.File
Required: No

globalChecksumPolicy:

Sets the checksum mode of the Maven invocation. Equivalent of -c or --lax-checksums, -C or --strict-checksums

Type: java.lang.String
Required: No
Default: warn

globalSettingsFile:

The path to the global settings for the Maven invocation or null to load the global settings from the default location.

Type: java.io.File
Required: No

goals:

The list of goals which will be called during each invocation of Maven. TODO: Change the name, cause we are calling life cycle phases instead of goal but we can if we like things like site:site ?

Type: java.util.List
Required: No

interactive:

This will set --batch-mode

Type: boolean
Required: No
Default: false

items:

Here you can define the items which will be iterated through.


<items>
    <item>one</item>
    <item>two</item>
    <item>three</item>
    ..
  </items>

Type: java.util.List
Required: No
User Property: iterator.items

itemsWithProperties:

If you like to have items to iterate through which also contain supplemental properties. This can be done by using the following:


<itemsWithProperties>
    <itemWithProperty>
      <name>one</name>
      <properties>
        <xyz>google</xyz>
      </properties>
    </itemWithProperty>
    <itemWithProperty>
      <name>two</name>
      <properties>
        <xyz>theseverside</xyz>
      </properties>
    </itemWithProperty>
    ..
  </items>

You are not determined having the same properties for the iterations. You can use different properties for each iteration.

Type: java.util.List
Required: No

iteratorName:

The name of the iterator variable.

Type: java.lang.String
Required: Yes
Default: item

localRepositoryDirectory:

If null the default location from settings.xml will be used.

Type: java.io.File
Required: No

mavenOpts:

If null.

Type: java.lang.String
Required: No

nonPluginUpdates:

If true --no-plugin-updates will be used.

Type: boolean
Required: No

offline:

true Maven will be executed in off-line mode ( --offline).

Type: boolean
Required: No

profiles:

The list of profiles.

Type: java.util.List
Required: No

projects:

Sets the reactor project list. Equivalent of -pl or --projects projects the reactor project list

Type: java.util.List
Required: No

properties:

Sets the system properties for the Maven invocation, may be null if not set.

Type: java.util.Properties
Required: No

recursive:

Sets the recursion behavior of a reactor invocation. Inverse equivalent of -N and --non-recursive

Type: boolean
Required: No
Default: false

resumeFrom:

Specify the reactor project to resume from.

Type: java.lang.String
Required: No

shellEnvironmentInherited:

Indicates whether the environment variables of the current process should be propagated to the Maven invocation. By default, the current environment variables are inherited by the new Maven invocation.

Type: boolean
Required: No
Default: true

showErrors:

Gets the exception output mode of the Maven invocation. By default, Maven will not print stack traces of build exceptions.

Type: boolean
Required: No
Default: false

showVersion:

The show version behaviour -V option.

Type: boolean
Required: No
Default: false

skip:

If you like to skip the execution.

Type: boolean
Required: No
User Property: iterator.skip
Default: false

sortOrder:

This defines the sort order for the folders which will be iterated over. NameFileComparator.NAME_COMPARATOR NameFileComparator.NAME_INSENSITIVE_COMPARATOR NameFileComparator.NAME_INSENSITIVE_REVERSE NameFileComparator.NAME_REVERSE NameFileComparator.NAME_SYSTEM_COMPARATOR NameFileComparator.NAME_SYSTEM_REVERSE

Type: java.lang.String
Required: No
Default: NAME_COMPARATOR

threads:

-T option of Maven.