org.nuiton.jredmine.plugin

Class PublishNewsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.nuiton.plugin.AbstractPlugin

org.nuiton.jredmine.plugin.AbstractRedmineMojo

org.nuiton.jredmine.plugin.AbstractRedmineMojoWithProject

org.nuiton.jredmine.plugin.PublishNewsMojo

All Implemented Interfaces:

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

@Mojo(name="publish-news",
      requiresOnline=true,
      requiresProject=true)
public class PublishNewsMojo
extends AbstractRedmineMojoWithProject
implements DryRunAware

Publish a news on redmine 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 boolean	anonymous Flag to know if anonymous connexion to redmine server is required.
protected boolean	dryRun A flag to test plugin but send nothing to redmine.
protected File	newsContentFile The content file of the news.
protected String	newsSummary Short description or introduction of the released artifact.
protected String	newsTitle The title of the news to create on redmine server.
protected boolean	runOnce A flag to restrict only one run in a build (for multi-module context).
protected boolean	runOnceDone flag to mark if a runOnce goal was done
protected boolean	runOnlyOnRoot A flag to restrict only to run on root module.
protected boolean	skipPublishNews A flag to skip the goal.

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

projectId, releaseProject, releaseUser, users

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

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

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

ROLE

Constructor Summary

Constructors

Constructor and Description
PublishNewsMojo()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkRunOnceDone()
protected void	doAction() Re-expose the protected method for test purposes...
String	getSkipProperty()
protected void	init()
boolean	isAnonymous()
boolean	isDryRun()
boolean	isGoalSkip()
boolean	isRunOnce()
boolean	isRunOnceDone()
boolean	isRunOnlyOnRoot()
void	setAnonymous(boolean anonymous)
void	setDryRun(boolean dryRun)

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

checkSkip, getProjectId, initReleaseProject, initReleaseUser, setProjectId

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

afterExecute, closeService, failIfSafe, getAuthConfiguration, getEncoding, getProject, getUrl, 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, needInvoke, needInvoke, 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

anonymous

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

Flag to know if anonymous connexion to redmine server is required.

Note: If set to false, you should fill AbstractRedmineMojo.username and AbstractRedmineMojo.password properties.

Since:

1.1.3

newsContentFile

@Parameter(property="redmine.newsContentFile",
           required=true)
protected File newsContentFile

The content file of the news.

Since:

1.0.0

newsSummary

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

Short description or introduction of the released artifact.

Since:

1.0.0

newsTitle

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

The title of the news to create on redmine server.

Note : the size can not be more than 60 caracters (due to a redmine limitation).

Since:

1.0.0

skipPublishNews

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

A flag to skip the goal.

Since:

1.0.0

dryRun

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

A flag to test plugin but send nothing to redmine.

Since:

1.0.0

runOnce

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

A flag to restrict only one run in a build (for multi-module context).

Since:

1.0.0

runOnlyOnRoot

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

A flag to restrict only to run on root module.

Since:

1.6

runOnceDone

protected boolean runOnceDone

flag to mark if a runOnce goal was done

Constructor Detail

PublishNewsMojo

public PublishNewsMojo()

Method Detail

isAnonymous

public boolean isAnonymous()

Specified by:

isAnonymous in interface RedmineClientConfiguration

setAnonymous

public void setAnonymous(boolean anonymous)

Specified by:

setAnonymous in interface RedmineClientConfiguration

isDryRun

public boolean isDryRun()

Specified by:

isDryRun in interface DryRunAware

setDryRun

public void setDryRun(boolean dryRun)

Specified by:

setDryRun in interface DryRunAware

getSkipProperty

public String getSkipProperty()

Specified by:

getSkipProperty in interface SkipOrRunOnlyOnceAware

isGoalSkip

public boolean isGoalSkip()

Specified by:

isGoalSkip in interface SkipOrRunOnlyOnceAware

checkRunOnceDone

public boolean checkRunOnceDone()

Specified by:

checkRunOnceDone in interface SkipOrRunOnlyOnceAware

isRunOnce

public boolean isRunOnce()

Specified by:

isRunOnce in interface SkipOrRunOnlyOnceAware

isRunOnlyOnRoot

public boolean isRunOnlyOnRoot()

Specified by:

isRunOnlyOnRoot in interface SkipOrRunOnlyOnceAware

isRunOnceDone

public boolean isRunOnceDone()

Specified by:

isRunOnceDone in interface SkipOrRunOnlyOnceAware

init

protected void init()
             throws Exception

Overrides:

init in class AbstractRedmineMojoWithProject

Throws:

Exception

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