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

All Implemented Interfaces:

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

public class PublishNewsMojo
extends AbstractRedmineMojo

Publish a news on redmine server.

Since:

1.0.0

Author:

tchemit

Is defined by the goal name:

publish-news

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

protected boolean	dryRun A flag to test plugin but send nothing to redmine.
protected java.io.File	newsContentFile The content file of the news.
protected java.lang.String	newsSummary Short description or introduction of the released artifact.
protected java.lang.String	newsTitle The title of the news to create on redmine server.
protected boolean	runOnce A flag to restirct only one run in a build (for multi-module context).
protected boolean	skipPublishNews A flag to skip the goal.

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

dateFormat, encoding, initOk, password, project, projectId, REDMINE_SYSTEM, releaseProject, releaseUser, releaseVersion, runOnceDone, safe, service, serviceInit, session, url, username, users, verbose, versionId

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

ROLE

Constructor Summary

PublishNewsMojo()

Method Summary

protected boolean	checkRunOnceDone()
protected void	doAction() Re-expose the protected method for test purposes...
protected void	init()
protected boolean	isGoalSkip()
protected boolean	isRunOnce()

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

afterExecute, checkSkip, closeService, getEncoding, getProject, getRestPassword, getRestUrl, getRestUsername, initReleaseProject, initReleaseUser, initReleaseVersion, isAnonymous, isRunOnceDone, isSafe, isVerbose, setAnonymous, setEncoding, setProject, setRestPassword, setRestUrl, setRestUsername, setSafe, setVerbose

Methods inherited from class org.nuiton.plugin.AbstractPlugin

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

newsContentFile

protected java.io.File newsContentFile

The content file of the news.

Since:

1.0.0

Is defined by:

expression:

${redmine.newsContentFile}

Is required.

newsSummary

protected java.lang.String newsSummary

Short description or introduction of the released artifact.

Since:

1.0.0

Is defined by:

expression:

${redmine.newsSummary}

newsTitle

protected java.lang.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

Is defined by:

expression:

${redmine.newsTitle}

Is required.

skipPublishNews

protected boolean skipPublishNews

A flag to skip the goal.

Since:

1.0.0

Is defined by:

expression:

${redmine.skipPublishNews}

default-value:

false

dryRun

protected boolean dryRun

A flag to test plugin but send nothing to redmine.

Since:

1.0.0

Is defined by:

expression:

${redmine.dryRun}

default-value:

false

runOnce

protected boolean runOnce

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

Since:

1.0.0

Is defined by:

expression:

${redmine.runOnce}

default-value:

true

Constructor Detail

PublishNewsMojo

public PublishNewsMojo()

Method Detail

isGoalSkip

protected boolean isGoalSkip()

Specified by:

isGoalSkip in class AbstractRedmineMojo

checkRunOnceDone

protected boolean checkRunOnceDone()

Specified by:

checkRunOnceDone in class AbstractRedmineMojo

isRunOnce

protected boolean isRunOnce()

Specified by:

isRunOnce in class AbstractRedmineMojo

init

protected void init()
             throws java.lang.Exception

Overrides:

init in class AbstractRedmineMojo

Throws:

java.lang.Exception

doAction

protected void doAction()
                 throws java.lang.Exception

Description copied from class: AbstractRedmineMojo

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

Specified by:

doAction in class AbstractRedmineMojo

Throws:

java.lang.Exception

See Also:

AbstractPlugin.doAction()