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, RedmineClientConfiguration, RedmineProjectAware, RedmineVersionAware, RedmineServiceConfiguration, org.nuiton.plugin.Plugin

@Mojo(name="display-data",
      requiresOnline=true,
      requiresProject=true)
public class DisplayDataMojo
extends AbstractRedmineMojo
implements RedmineProjectAware, RedmineVersionAware

Display in console some data from redmine's server.

This goals requires no authentication to the server.

Since:

1.0.0

Author:

tchemit

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

Fields

Modifier and Type	Field and Description
protected List<String>	actions list of actions to perform
protected boolean	anonymous Flag to know if anonymous connexion to redmine server is required.
protected String	projectId Redmine project name.
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.
protected String	versionId Redmine version name.

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

apiKey, dateFormat, encoding, initOk, password, project, REDMINE_SYSTEM, runOnceDone, safe, service, serviceInit, session, url, username, verbose

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

ROLE

Constructor Summary

Constructors

Constructor and Description
DisplayDataMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkRunOnceDone()
protected boolean	checkSkip()
protected void	doAction() Re-expose the protected method for test purposes...
protected IdAble[]	getDatas(String type)
protected IdAble[]	getDatasWithProject(String type)
protected IdAble[]	getDatasWithProjectAndVersion(String type)
protected List<String>	getDownloadActions()
String	getProjectId()
String	getVersionId()
protected void	init()
boolean	isAnonymous()
protected boolean	isGoalSkip()
protected boolean	isRunOnce()
void	setAnonymous(boolean anonymous)
void	setProjectId(String projectId)
void	setVersionId(String versionId)

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

afterExecute, closeService, failIfSafe, getAuthConfiguration, getEncoding, getProject, getUrl, isRunOnceDone, isVerbose, setApiKey, setAuthConfiguration, setEncoding, setPassword, setProject, setUrl, setUsername, setVerbose

Methods inherited from class org.nuiton.plugin.AbstractPlugin

acceptPackaging, addCompileSourceRoots, addDirectoryToUrlsList, addResourceDir, addTestCompileSourceRoots, addTestResourceDir, addUrlToUrlsList, backupFile, checkEncoding, checkPackaging, checkResource, checkRunOnceDone, copyFile, createDirectoryIfNecessary, createNewFile, deleteFile, execute, getBackupFile, getFileFromBasedir, getFilesToTreate, getFilesToTreateForRoots, getRootProject, getTemplate, hasClassPath, 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

projectId

@Parameter(property="redmine.projectId",
           defaultValue="${project.artifactId}",
           required=true)
protected String projectId

Redmine project name.

Since:

1.0.0

versionId

@Parameter(property="redmine.versionId",
           defaultValue="${project.version}")
protected String versionId

Redmine version name.

Since:

1.0.0

types

@Parameter(property="types",
           required=true)
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

sortById

@Parameter(property="sortById",
           defaultValue="true",
           required=true)
protected boolean sortById

A flag to sort of not retrived data by id.

Since:

1.0.0

anonymous

@Parameter(property="anonymous",
           defaultValue="true")
protected boolean anonymous

Flag to know if anonymous 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

actions

protected List<String> actions

list of actions to perform

Constructor Detail

DisplayDataMojo

public DisplayDataMojo()

Method Detail

isAnonymous

public boolean isAnonymous()

Specified by:

isAnonymous in interface RedmineClientConfiguration

setAnonymous

public void setAnonymous(boolean anonymous)

Specified by:

setAnonymous in interface RedmineClientConfiguration

getProjectId

public String getProjectId()

Specified by:

getProjectId in interface RedmineProjectAware

setProjectId

public void setProjectId(String projectId)

Specified by:

setProjectId in interface RedmineProjectAware

getVersionId

public String getVersionId()

Specified by:

getVersionId in interface RedmineVersionAware

setVersionId

public void setVersionId(String versionId)

Specified by:

setVersionId in interface RedmineVersionAware

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

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 - if any problems

getDownloadActions

protected List<String> getDownloadActions()
                                   throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

getDatas

protected IdAble[] getDatas(String type)
                     throws IOException

Throws:

IOException

getDatasWithProject

protected IdAble[] getDatasWithProject(String type)
                                throws IOException

Throws:

IOException

getDatasWithProjectAndVersion

protected IdAble[] getDatasWithProjectAndVersion(String type)
                                          throws IOException

Throws:

IOException