org.nuiton.jredmine.plugin
Class DisplayDataMojo

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

All Implemented Interfaces:

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

public class DisplayDataMojo
extends AbstractRedmineMojo

Display in console some data from redmine's server.

This goals requires no authentication to the server.

Since:

1.0.0

Author:

tchemit

Is defined by the goal name:

display-data

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 List<RedmineModelEnum>	actions list of actions to perform
protected boolean	anonymous Flag to know if anonymùous connexion to redmine server is required.
protected boolean	sortById A flag to sort of not retrived data by id.
protected String	types The data types to display : issueSatus, issuePriority, issueCategory, tracker and user.

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

DisplayDataMojo()

Method Summary

protected boolean	checkRunOnceDone()
protected boolean	checkSkip()
protected void	doAction() Re-expose the protected method for test purposes...
protected List<RedmineModelEnum>	getDownloadActions(String dataTypes, RedmineModelEnum... universe)
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, 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

types

protected String types

The data types to display : issueSatus, issuePriority, issueCategory, tracker and user.

issueStatus and issuePriority are common for all projects, so for those datas, no extrat configuration is required.

isseCategoriy, tracker and user are project specific, so you have to fill also the projectId parameter to obtain data for those types.

Note : you can specifiy several types separated by comma

Since:

1.0.0

Is defined by:

expression:

${types}

Is required.

sortById

protected boolean sortById

A flag to sort of not retrived data by id.

Since:

1.0.0

Is defined by:

expression:

${sortById}

default-value:

true

Is required.

anonymous

protected boolean anonymous

Flag to know if anonymùous connexion to redmine server is required. For this goal, the default value is true Note: If set to false, you should fill AbstractRedmineMojo.username and AbstractRedmineMojo.password properties.

Since:

1.1.3

Is defined by:

expression:

${anonymous}

default-value:

true

actions

protected List<RedmineModelEnum> actions

list of actions to perform

Constructor Detail

DisplayDataMojo

public DisplayDataMojo()

Method Detail

checkRunOnceDone

protected boolean checkRunOnceDone()

Specified by:

checkRunOnceDone in class AbstractRedmineMojo

isGoalSkip

protected boolean isGoalSkip()

Specified by:

isGoalSkip in class AbstractRedmineMojo

isRunOnce

protected boolean isRunOnce()

Specified by:

isRunOnce in class AbstractRedmineMojo

init

protected void init()
             throws Exception

Overrides:

init in class AbstractRedmineMojo

Throws:

Exception

isAnonymous

public boolean isAnonymous()

setAnonymous

public void setAnonymous(boolean anonymous)

checkSkip

protected boolean checkSkip()

Overrides:

checkSkip in class AbstractRedmineMojo

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()

getDownloadActions

protected List<RedmineModelEnum> getDownloadActions(String dataTypes,
                                                    RedmineModelEnum... universe)
                                             throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException