org.nuiton.jredmine.plugin
Class UpdateVersionMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.nuiton.plugin.AbstractPlugin
          org.nuiton.jredmine.plugin.AbstractRedmineMojo
              org.nuiton.jredmine.plugin.UpdateVersionMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.nuiton.io.rest.RestClientConfiguration, org.nuiton.plugin.Plugin

public class UpdateVersionMojo
extends AbstractRedmineMojo

Create or update a version on redmine server.

Will add a the version if not existing, otherwise, will update the version.

Since:

1.0.0

Author:

tchemit

Is defined by the goal name:

update-version

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuiton.plugin.Plugin

org.nuiton.plugin.Plugin.InitState, org.nuiton.plugin.Plugin.Packaging

Field Summary

protected boolean	anonymous Flag to know if anonymùous connexion to redmine server is required.
protected boolean	closeVersion A flag to close the version on redmine (will fix effectiveDate).
protected boolean	dryRun A flag to test plugin but send nothing to redmine.
protected String	effectiveDate The effective date to set on the version.
protected boolean	runOnce A flag to restirct only one run in a build (for multi-module context).
protected boolean	skipUpdateVersion A flag to skip the goal.
protected String	versionDescription The news description to update to redmine server.

Fields inherited from class org.nuiton.jredmine.plugin.AbstractRedmineMojo

dateFormat, encoding, initOk, password, project, projectId, REDMINE_SYSTEM, releaseProject, releaseUser, releaseVersion, runOnceDone, safe, service, serviceInit, session, url, username, users, verbose, versionId

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

ROLE

Constructor Summary

UpdateVersionMojo()

Method Summary

protected boolean	checkRunOnceDone()
protected void	doAction() Re-expose the protected method for test purposes...
protected void	init()
boolean	isAnonymous()
protected boolean	isGoalSkip()
protected boolean	isRunOnce()
void	setAnonymous(boolean anonymous)

Methods inherited from class org.nuiton.jredmine.plugin.AbstractRedmineMojo

afterExecute, checkSkip, closeService, getEncoding, getProject, getProjectId, getRestPassword, getRestUrl, getRestUsername, getVersionId, initReleaseProject, initReleaseUser, initReleaseVersion, isRunOnceDone, isSafe, isVerbose, setEncoding, setProject, setRestPassword, setRestUrl, setRestUsername, setSafe, setVerbose

Methods inherited from class org.nuiton.plugin.AbstractPlugin

acceptPackaging, addCompileSourceRoots, addDirectoryToUrlsList, addResourceDir, addResourceDir, addTestCompileSourceRoots, addTestResourceDir, addTestResourceDir, addUrlToUrlsList, backupFile, checkPackaging, checkResource, checkRunOnceDone, copyFile, createDirectoryIfNecessary, createNewFile, deleteFile, execute, getBackupFile, getFileFromBasedir, getFilesToTreate, getFilesToTreateForRoots, getTemplate, initClassLoader, isExecutionRoot, isFileNewerThanPomFile, rejectPackaging, removeCompileSourceRoots, removeTestCompileSourceRoots, renameFile, writeFile

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

getLog, setLog

Field Detail

anonymous

protected boolean anonymous

Flag to know if anonymùous connexion to redmine server is required. Note: If set to false, you should fill AbstractRedmineMojo.username and AbstractRedmineMojo.password properties.

Since:

1.1.3

Is defined by:

expression:

${redmine.anonymous}

default-value:

false

versionDescription

protected String versionDescription

The news description to update to redmine server.

Note : if not set, no update of the description will be made.

Since:

1.0.0

Is defined by:

expression:

${redmine.versionDescription}

closeVersion

protected boolean closeVersion

A flag to close the version on redmine (will fix effectiveDate).

Since:

1.0.0

Is defined by:

expression:

${redmine.closeVersion}

default-value:

false

effectiveDate

protected String effectiveDate

The effective date to set on the version.

The format of the date is yyyy-mm-dd.

If not Set - will use current day date only if closeVersion flag is on.

Since:

1.0.0

Is defined by:

expression:

${redmine.effectiveDate}

skipUpdateVersion

protected boolean skipUpdateVersion

A flag to skip the goal.

Since:

1.0.0

Is defined by:

expression:

${redmine.skipUpdateVersion}

default-value:

false

dryRun

protected boolean dryRun

A flag to test plugin but send nothing to redmine.

Since:

1.0.0

Is defined by:

expression:

${redmine.dryRun}

default-value:

false

runOnce

protected boolean runOnce

A flag to restirct only one run in a build (for multi-module context).

Since:

1.0.0

Is defined by:

expression:

${redmine.runOnce}

default-value:

true

Constructor Detail

UpdateVersionMojo

public UpdateVersionMojo()

Method Detail

isAnonymous

public boolean isAnonymous()

setAnonymous

public void setAnonymous(boolean anonymous)

isGoalSkip

protected boolean isGoalSkip()

Specified by:

isGoalSkip in class AbstractRedmineMojo

isRunOnce

protected boolean isRunOnce()

Specified by:

isRunOnce in class AbstractRedmineMojo

checkRunOnceDone

protected boolean checkRunOnceDone()

Specified by:

checkRunOnceDone in class AbstractRedmineMojo

init

protected void init()
             throws Exception

Overrides:

init in class AbstractRedmineMojo

Throws:

Exception

doAction

protected void doAction()
                 throws Exception

Description copied from class: AbstractRedmineMojo

Re-expose the protected method for test purposes...

Specified by:

doAction in class AbstractRedmineMojo

Throws:

Exception

See Also:

AbstractPlugin.doAction()