org.nuiton.jredmine.plugin

Class LoginMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.nuiton.plugin.AbstractPlugin

org.nuiton.jredmine.plugin.LoginMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, RedmineClientConfiguration, RedmineServiceConfiguration, org.nuiton.plugin.Plugin

@Mojo(name="login",
      requiresOnline=true,
      requiresProject=true)
public class LoginMojo
extends org.nuiton.plugin.AbstractPlugin
implements RedmineServiceConfiguration

Obtain login for the redmine server to use.

Since:

1.2.1

Author:

Tony Chemit Copyright Code Lutin

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 boolean	checkLogin Flag to check login is ok (will connect to server).
protected static org.nuiton.helper.plugin.ShareServerSecretPlugin	plugin Shared instance of delegate plugin to obtain login
protected org.apache.maven.project.MavenProject	project Current project.
protected boolean	safe Flag to fail build if configuration is not ok.
protected org.sonatype.plexus.components.sec.dispatcher.SecDispatcher	sec Password decypher.
protected String	serverId Redmine server id to obtain login and password.
protected RedmineService	service Redmine service.
protected org.apache.maven.settings.Settings	settings Settings.
protected URL	url The real basedir redmine url.
protected boolean	verbose Flag to activate verbose logging.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
LoginMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	afterExecute()
protected boolean	checkSkip()
protected void	doAction()
RedmineClientAuthConfiguration	getAuthConfiguration()
String	getEncoding()
org.apache.maven.project.MavenProject	getProject()
URL	getUrl()
protected void	init()
boolean	isAnonymous()
boolean	isVerbose()
void	setAnonymous(boolean anonymous)
void	setAuthConfiguration(RedmineClientAuthConfiguration authConfiguration)
void	setEncoding(String encoding)
void	setProject(org.apache.maven.project.MavenProject project)
void	setUrl(URL url)
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.apache.maven.plugin.Mojo

getLog, setLog

Field Detail

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.2.1

verbose

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

Flag to activate verbose logging.

Since:

1.2.1

checkLogin

@Parameter(property="redmine.checkLogin",
           defaultValue="false")
protected boolean checkLogin

Flag to check login is ok (will connect to server).

Since:

1.2.1

safe

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

Flag to fail build if configuration is not ok.

Since:

1.2.1

serverId

@Parameter(property="redmine.serverId",
           required=true)
protected String serverId

Redmine server id to obtain login and password.

The server must be defined in your settings.xml file in servers section.

Since:

1.2.1

project

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

Current project.

Since:

1.2.1

settings

@Component
protected org.apache.maven.settings.Settings settings

Settings.

Since:

1.2.1

sec

@Component(hint="helper-maven-plugin")
protected org.sonatype.plexus.components.sec.dispatcher.SecDispatcher sec

Password decypher.

Since:

1.2.1

service

@Component
protected RedmineService service

Redmine service.

Since:

1.2.1

Is a Plexus component defined by:

plugin

protected static org.nuiton.helper.plugin.ShareServerSecretPlugin plugin

Shared instance of delegate plugin to obtain login

Since:

1.2.1

Constructor Detail

LoginMojo

public LoginMojo()

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

isAnonymous

public boolean isAnonymous()

Specified by:

isAnonymous in interface RedmineClientConfiguration

setAnonymous

public void setAnonymous(boolean anonymous)

Specified by:

setAnonymous 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

getAuthConfiguration

public RedmineClientAuthConfiguration getAuthConfiguration()

Specified by:

getAuthConfiguration in interface RedmineClientConfiguration

setAuthConfiguration

public void setAuthConfiguration(RedmineClientAuthConfiguration authConfiguration)

Specified by:

setAuthConfiguration in interface RedmineClientConfiguration

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

doAction

protected void doAction()
                 throws Exception

Specified by:

doAction in class org.nuiton.plugin.AbstractPlugin

Throws:

Exception

afterExecute

protected void afterExecute()

Overrides:

afterExecute in class org.nuiton.plugin.AbstractPlugin