org.nuiton.jredmine.plugin

Class AbstractRedmineMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.nuiton.plugin.AbstractPlugin

org.nuiton.jredmine.plugin.AbstractRedmineMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractRedmineMojoWithProject, DisplayDataMojo

public abstract class AbstractRedmineMojo
extends org.nuiton.plugin.AbstractPlugin
implements RedmineServiceConfiguration

Abstract redmine mojo.

Since:

1.0.0

Author:

tchemit

Requires to be online to run:

true

Requires a Maven project to run:

true

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 DateFormat	dateFormat the date format used to write a date
protected String	encoding The encoding used to read and write files.
protected boolean	initOk
protected String	password The redmine's server password.
protected org.apache.maven.project.MavenProject	project Dependance du projet.
static String	REDMINE_SYSTEM
protected boolean	runOnceDone flag to mark if a runOnce goal was done
protected boolean	safe Un flag pour faire échouer le build si la configuration n'est pas ok.
protected RedmineService	service Redmine service.
protected boolean	serviceInit flag to mark if service was sucessfull init
protected org.apache.maven.execution.MavenSession	session
protected URL	url The real basedir redmine url.
protected String	username The redmine's server login.
protected boolean	verbose Un flag pour activer le mode verbeux.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractRedmineMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	afterExecute()
protected abstract boolean	checkRunOnceDone()
protected boolean	checkSkip()
protected void	closeService()
protected abstract void	doAction() Re-expose the protected method for test purposes...
String	getApiKey() Note: Still not used (will be in version 2.0)
String	getEncoding()
org.apache.maven.project.MavenProject	getProject()
String	getRestPassword()
URL	getRestUrl()
String	getRestUsername()
protected void	init()
protected abstract boolean	isGoalSkip()
protected abstract boolean	isRunOnce()
boolean	isRunOnceDone()
boolean	isSafe()
boolean	isVerbose()
void	setApiKey(String apiKey) Note: Still not used (will be in version 2.0)
void	setEncoding(String encoding)
void	setProject(org.apache.maven.project.MavenProject project)
void	setRestPassword(String restPassword)
void	setRestUrl(URL restUrl)
void	setRestUsername(String restUsername)
void	setSafe(boolean safe)
void	setVerbose(boolean verbose)

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.nuiton.io.rest.RestClientConfiguration

isAnonymous, setAnonymous

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

getLog, setLog

Field Detail

REDMINE_SYSTEM

public static final String REDMINE_SYSTEM

See Also:

Constant Field Values

project

@Component
protected org.apache.maven.project.MavenProject project

Dependance du projet.

Since:

1.0.0

url

@Parameter(property="redmine.url")
protected URL url

The real basedir redmine url.

If no url is given, will use the issue management url.

Since:

1.0.0

username

@Parameter(property="redmine.username")
protected String username

The redmine's server login.

Note: This parameter (or username/password) is mandatory if you not use a anonymous service.

Since:

1.0.0

password

@Parameter(property="redmine.password")
protected String password

The redmine's server password.

Note: This parameter (or username/password) is mandatory if you not use a anonymous service.

Since:

1.0.0

encoding

@Parameter(property="redmine.encoding",
           defaultValue="${project.build.sourceEncoding}")
protected String encoding

The encoding used to read and write files.

Note: If nothing is filled here, we will use the system property file.encoding.

Since:

1.0.0

verbose

@Parameter(property="redmine.verbose",
           defaultValue="${maven.verbose}")
protected boolean verbose

Un flag pour activer le mode verbeux.

Since:

1.0.0

safe

@Parameter(property="redmine.safe",
           defaultValue="true")
protected boolean safe

Un flag pour faire échouer le build si la configuration n'est pas ok.

Since:

1.0.0

session

@Component
protected org.apache.maven.execution.MavenSession session

service

@Component
protected RedmineService service

Redmine service.

Since:

1.0.0

dateFormat

protected DateFormat dateFormat

the date format used to write a date

runOnceDone

protected boolean runOnceDone

flag to mark if a runOnce goal was done

serviceInit

protected boolean serviceInit

flag to mark if service was sucessfull init

initOk

protected boolean initOk

Constructor Detail

AbstractRedmineMojo

public AbstractRedmineMojo()

Method Detail

init

protected void init()
             throws Exception

Specified by:

init in class org.nuiton.plugin.AbstractPlugin

Throws:

Exception

checkSkip

protected boolean checkSkip()

Overrides:

checkSkip in class org.nuiton.plugin.AbstractPlugin

afterExecute

protected void afterExecute()

Overrides:

afterExecute in class org.nuiton.plugin.AbstractPlugin

doAction

protected abstract void doAction()
                          throws Exception

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

Specified by:

doAction in class org.nuiton.plugin.AbstractPlugin

Throws:

Exception - if any problems

isGoalSkip

protected abstract boolean isGoalSkip()

isRunOnce

protected abstract boolean isRunOnce()

checkRunOnceDone

protected abstract boolean checkRunOnceDone()

getProject

public org.apache.maven.project.MavenProject getProject()

Specified by:

getProject in interface org.nuiton.plugin.Plugin

setProject

public void setProject(org.apache.maven.project.MavenProject project)

Specified by:

setProject in interface org.nuiton.plugin.Plugin

isVerbose

public boolean isVerbose()

Specified by:

isVerbose in interface org.nuiton.io.rest.RestClientConfiguration

Specified by:

isVerbose in interface org.nuiton.plugin.Plugin

setVerbose

public void setVerbose(boolean verbose)

Specified by:

setVerbose in interface org.nuiton.io.rest.RestClientConfiguration

Specified by:

setVerbose in interface org.nuiton.plugin.Plugin

getEncoding

public String getEncoding()

Specified by:

getEncoding in interface org.nuiton.io.rest.RestClientConfiguration

setEncoding

public void setEncoding(String encoding)

Specified by:

setEncoding in interface org.nuiton.io.rest.RestClientConfiguration

getRestPassword

public String getRestPassword()

Specified by:

getRestPassword in interface org.nuiton.io.rest.RestClientConfiguration

getRestUrl

public URL getRestUrl()

Specified by:

getRestUrl in interface org.nuiton.io.rest.RestClientConfiguration

getRestUsername

public String getRestUsername()

Specified by:

getRestUsername in interface org.nuiton.io.rest.RestClientConfiguration

setRestPassword

public void setRestPassword(String restPassword)

Specified by:

setRestPassword in interface org.nuiton.io.rest.RestClientConfiguration

setRestUrl

public void setRestUrl(URL restUrl)

Specified by:

setRestUrl in interface org.nuiton.io.rest.RestClientConfiguration

setRestUsername

public void setRestUsername(String restUsername)

Specified by:

setRestUsername in interface org.nuiton.io.rest.RestClientConfiguration

getApiKey

public String getApiKey()

Note: Still not used (will be in version 2.0)

Specified by:

getApiKey in interface RedmineServiceConfiguration

Returns:

the api key

Since:

2.0

setApiKey

public void setApiKey(String apiKey)

Note: Still not used (will be in version 2.0)

Specified by:

setApiKey in interface RedmineServiceConfiguration

Parameters:

apiKey - the niew api key to set

Since:

2.0

closeService

protected void closeService()

isRunOnceDone

public boolean isRunOnceDone()

isSafe

public boolean isSafe()

setSafe

public void setSafe(boolean safe)