Overview

Project Documentation

deploymentplan:generate

Full name:

org.ow2.util.maven:deploymentplan-maven-plugin:2.0.0:generate

Description:

A GeneratePlanMojo is responsible to build a deployment plan XML file using the information available in the POM.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • Since version: 2.0.0.
  • Binds by default to the lifecycle phase: generate-resources.

Optional Parameters

Name Type Since Description
allowTimestamp boolean 2.0.0 Allow timestamp in SNAPSHOT version if set to true
Default value is: false.
atomic boolean 2.0.0 Is the generated plan atomic ?
Default value is: false.
enrichments List 2.0.0 Enrich artifacts description with per-artifact information, see Enrichment.
globalCondition String 2.0.0 The condition that have to be satisfied for this plan to be deployed at runtime.
notStarted List 2.0.0 List of artifacts in condensed form (groupId:artifactId:type:classifier) not to be started.
references List 2.0.0 List of artifacts in condensed form (groupId:artifactId:type:classifier) to be declared as reference: bundles.
reloadables List 2.0.0 List of reloadables artifacts in condensed form (groupId:artifactId:type:classifier).
startlevel Map 2.0.0 Express startlevels of artifacts in condensed form (groupId:artifactId:type:classifier). 

<startlevel>
    <level-1>
        com.acme:shop:jar,
        com.acme.foo:application:jar
    </level-1>
    <level-4>
        com.acme.bar:business:jar
    </level-4>
</startlevel>

target File 2.0.0 The XML file that will contain the geenrated plan.
Default value is: ${project.build.directory}/${project.artifactId}-${project.version}.xml.
transients List 2.0.0 List of transient artifacts in condensed form (groupId:artifactId:type:classifier).

Parameter Details

allowTimestamp:

Allow timestamp in SNAPSHOT version if set to true
  • Type: boolean
  • Since: 2.0.0
  • Required: No
  • Default: false

atomic:

Is the generated plan atomic ?
  • Type: boolean
  • Since: 2.0.0
  • Required: No
  • Default: false

enrichments:

Enrich artifacts description with per-artifact information, see Enrichment.
  • Type: java.util.List
  • Since: 2.0.0
  • Required: No

globalCondition:

The condition that have to be satisfied for this plan to be deployed at runtime.
  • Type: java.lang.String
  • Since: 2.0.0
  • Required: No

notStarted:

List of artifacts in condensed form (groupId:artifactId:type:classifier) not to be started.
  • Type: java.util.List
  • Since: 2.0.0
  • Required: No

references:

List of artifacts in condensed form (groupId:artifactId:type:classifier) to be declared as reference: bundles.
  • Type: java.util.List
  • Since: 2.0.0
  • Required: No

reloadables:

List of reloadables artifacts in condensed form (groupId:artifactId:type:classifier).
  • Type: java.util.List
  • Since: 2.0.0
  • Required: No

startlevel:

Express startlevels of artifacts in condensed form (groupId:artifactId:type:classifier). 

<startlevel>
    <level-1>
        com.acme:shop:jar,
        com.acme.foo:application:jar
    </level-1>
    <level-4>
        com.acme.bar:business:jar
    </level-4>
</startlevel>
  • Type: java.util.Map
  • Since: 2.0.0
  • Required: No

target:

The XML file that will contain the geenrated plan.
  • Type: java.io.File
  • Since: 2.0.0
  • Required: No
  • Default: ${project.build.directory}/${project.artifactId}-${project.version}.xml

transients:

List of transient artifacts in condensed form (groupId:artifactId:type:classifier).
  • Type: java.util.List
  • Since: 2.0.0
  • Required: No