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, RedmineClientConfiguration, 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 String	apiKey The redmine's server login apiKey.
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 Current project.
static String	REDMINE_SYSTEM
protected boolean	runOnceDone flag to mark if a runOnce goal was done
protected boolean	safe Flag to fail build if configuration is not ok.
protected RedmineService	service Redmine service.
protected boolean	serviceInit flag to mark if service was sucessfull init
protected org.apache.maven.execution.MavenSession	session Maven session.
protected URL	url The real basedir redmine url.
protected String	username The redmine's server login.
protected boolean	verbose Flag to activate verbose mode.

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...
protected void	failIfSafe(String message) Convinient method to throw the given message if safe flag is on.
RedmineClientAuthConfiguration	getAuthConfiguration()
String	getEncoding()
org.apache.maven.project.MavenProject	getProject()
URL	getUrl()
protected void	init()
protected abstract boolean	isGoalSkip()
protected abstract boolean	isRunOnce()
boolean	isRunOnceDone()
boolean	isVerbose()
void	setApiKey(String apiKey)
void	setAuthConfiguration(RedmineClientAuthConfiguration authConfiguration)
void	setEncoding(String encoding)
void	setPassword(String password)
void	setProject(org.apache.maven.project.MavenProject project)
void	setUrl(URL url)
void	setUsername(String username)
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.jredmine.client.RedmineClientConfiguration

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

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

apiKey

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

The redmine's server login apiKey.

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

Since:

1.5

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

Flag to activate verbose mode.

Since:

1.0.0

safe

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

Flag to fail build if configuration is not ok.

Since:

1.0.0

project

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

Current project.

Since:

1.0.0

session

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

Maven session.

Since:

1.0.0

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

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 RedmineClientConfiguration

Specified by:

isVerbose in interface org.nuiton.plugin.Plugin

setVerbose

public void setVerbose(boolean verbose)

Specified by:

setVerbose in interface RedmineClientConfiguration

Specified by:

setVerbose in interface org.nuiton.plugin.Plugin

getEncoding

public String getEncoding()

Specified by:

getEncoding in interface RedmineClientConfiguration

setEncoding

public void setEncoding(String encoding)

Specified by:

setEncoding in interface RedmineClientConfiguration

getAuthConfiguration

public RedmineClientAuthConfiguration getAuthConfiguration()

Specified by:

getAuthConfiguration in interface RedmineClientConfiguration

setAuthConfiguration

public void setAuthConfiguration(RedmineClientAuthConfiguration authConfiguration)

Specified by:

setAuthConfiguration in interface RedmineClientConfiguration

getUrl

public URL getUrl()

Specified by:

getUrl in interface RedmineClientConfiguration

setUrl

public void setUrl(URL url)

Specified by:

setUrl in interface RedmineClientConfiguration

isGoalSkip

protected abstract boolean isGoalSkip()

isRunOnce

protected abstract boolean isRunOnce()

checkRunOnceDone

protected abstract boolean checkRunOnceDone()

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

setApiKey

public void setApiKey(String apiKey)

setUsername

public void setUsername(String username)

setPassword

public void setPassword(String password)

closeService

protected void closeService()

isRunOnceDone

public boolean isRunOnceDone()

failIfSafe

protected void failIfSafe(String message)
                   throws org.apache.maven.plugin.MojoExecutionException

Convinient method to throw the given message if safe flag is on.

Parameters:

message - message to throw if safe mode is on

Throws:

org.apache.maven.plugin.MojoExecutionException - the error thrown if safe flag is on

Since:

1.4.1