AbstractDeployitMojo (Deployit Maven Mojo 3.7.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.xebialabs.deployit.maven
Class AbstractDeployitMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      com.xebialabs.deployit.maven.AbstractDeployitMojo

All Implemented Interfaces:: org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:: CleanMojo, DeployMojo, GenerateDeploymentPackageMojo, ImportDarMojo

public abstract class AbstractDeployitMojo
extends org.apache.maven.plugin.AbstractMojo
extends org.apache.maven.plugin.AbstractMojo

Provides common code for deployit mojos

Author:: Benoit Moussaud

Field Summary
`protected boolean`	`cancelTaskOnError` When a task falls in error, it is cancelled.
`protected boolean`	`deletePreviouslyDeployedDar` Delete the previous deployed dar.
`protected List<MavenDeployable>`	`deployables` List of the deployables, including artifacts or middleware resource specification (eg Datasource)
`protected List<MavenDeployed>`	`deployeds` List of the deployeds: extensions or complete if you use explicitDeployeds options
`protected com.xebialabs.deployit.client.DeployitCli`	`deployitClient`
`protected List<MavenContainer>`	`environment` List of container in the target environment, if you want to create the environment through the Maven plugin.
`protected boolean`	`explicitDeployeds` With explicitDeployeds true, the deployed are not generated but fully loaded from the pluging configuration.
`protected boolean`	`failIfNoStepsAreGenerated` If a deployments leads no steps, fail the build.
`protected boolean`	`generateDeployedOnUpgrade` Flag controlling whether, during the upgrade operation, the Deployed objects should generated (like an initial deployment) or reused.
`protected String`	`mainArtifactName`
`protected String`	`orchestrator` Set the orchestrator used during the deployment.
`protected org.apache.maven.project.MavenProject`	`project` The maven project.
`protected boolean`	`secured` If true the communication with the deployit server is secured (https).
`protected boolean`	`skipMode` Activate the skip mode: generate the plan, skip all the steps, validate the task
`protected boolean`	`testMode` Activate the test mode, generate the plan, display all the steps, validate the task
`protected boolean`	`timestampedVersion` Use this attribute to add a timestamp to the version of the deployit package.

Fields inherited from interface org.apache.maven.plugin.Mojo
`ROLE`

Constructor Summary
`AbstractDeployitMojo()`

Method Summary
`protected void`	`deploy()`
`protected com.xebialabs.deployit.core.api.dto.RepositoryObject`	`fetchEnvironment()`
`protected com.xebialabs.deployit.client.DeployitCli`	`getClient()`
`String`	`getPassword()`
`String`	`getUsername()`
`protected com.xebialabs.deployit.core.api.dto.RepositoryObject`	`importDar()`
`protected void`	`undeploy()`

Methods inherited from class org.apache.maven.plugin.AbstractMojo
`getLog, getPluginContext, setLog, setPluginContext`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface org.apache.maven.plugin.Mojo
`execute`

Field Detail

project

protected org.apache.maven.project.MavenProject project

The maven project.

mainArtifactName

protected String mainArtifactName

skipMode

protected boolean skipMode

Activate the skip mode: generate the plan, skip all the steps, validate the task

orchestrator

protected String orchestrator

Set the orchestrator used during the deployment.

Since:: 3.7.0

testMode

protected boolean testMode

Activate the test mode, generate the plan, display all the steps, validate the task

failIfNoStepsAreGenerated

protected boolean failIfNoStepsAreGenerated

If a deployments leads no steps, fail the build.

secured

protected boolean secured

If true the communication with the deployit server is secured (https).

deployeds

protected List<MavenDeployed> deployeds

List of the deployeds: extensions or complete if you use explicitDeployeds options

deployables

protected List<MavenDeployable> deployables

List of the deployables, including artifacts or middleware resource specification (eg Datasource)

environment

protected List<MavenContainer> environment

List of container in the target environment, if you want to create the environment through the Maven plugin.

timestampedVersion

protected boolean timestampedVersion

Use this attribute to add a timestamp to the version of the deployit package. by default,the SNAPSHOT versions are automatically timestamped. This flag is useful only if you want to timestamp non SNAPSHOT version.

deletePreviouslyDeployedDar

protected boolean deletePreviouslyDeployedDar

Delete the previous deployed dar. Useful if you work with the SNAPSHOT versions you don't want to keep in your repository.

generateDeployedOnUpgrade

protected boolean generateDeployedOnUpgrade

Flag controlling whether, during the upgrade operation, the Deployed objects should generated (like an initial deployment) or reused. For security reasons, the default value is false but should be set to true to apply the modifications (new Ear, removed links) even during upgrade.

Since:: 3.6.2

cancelTaskOnError

protected boolean cancelTaskOnError

When a task falls in error, it is cancelled. Sometime it could be interesting to debug it using the UI or the CLI. When this flag is set to false, the task will be left as is.

Since:: 3.6.2

explicitDeployeds

protected boolean explicitDeployeds

With explicitDeployeds true, the deployed are not generated but fully loaded from the pluging configuration.

deployitClient

protected com.xebialabs.deployit.client.DeployitCli deployitClient

Constructor Detail