org.nuiton.jredmine.plugin

Class PublishAttachmentsMojo

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

org.nuiton.jredmine.plugin.PublishAttachmentsMojo

All Implemented Interfaces:

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

@Mojo(name="publish-attachments",
      requiresOnline=true,
      requiresProject=true)
public class PublishAttachmentsMojo
extends AbstractRedmineMojoWithProjectAndVersion
implements DryRunAware

Publish files for a given project and version 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 List<File>	allFiles files to deploy
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[]	files A list of files to deploy.
protected File	filesFromProperties The path of a properties files where files to deploy are descriped.
protected boolean	runOnce A flag to restrict only one run in a build (for multi-module context).
protected boolean	skipPublishAttachments A flag to skip the goal.

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

releaseVersion, versionId

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, runOnceDone, safe, service, serviceInit, session, url, username, verbose

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

ROLE

Constructor Summary

Constructors

Constructor and Description
PublishAttachmentsMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkRunOnceDone()
protected boolean	checkSkip()
protected void	doAction() Re-expose the protected method for test purposes...
protected List<File>	getFilesToDeploy()
protected void	init()
boolean	isAnonymous()
boolean	isDryRun()
protected boolean	isGoalSkip()
protected boolean	isRunOnce()
void	setAnonymous(boolean anonymous)
void	setDryRun(boolean dryRun)

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

getProjectVersion, getProjectVersions, getVersionId, initReleaseVersion, setVersionId

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

getProjectId, initReleaseProject, initReleaseUser, setProjectId

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

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

filesFromProperties

@Parameter(property="redmine.filesFromProperties")
protected File filesFromProperties

The path of a properties files where files to deploy are descriped.

The key of a property is the sortor key

The value of a property is the path of the file to upload.

If no Set - will not use this source

Since:

1.0.0

files

@Parameter(property="redmine.files")
protected File[] files

A list of files to deploy.

If no Set - will not use this source

Since:

1.0.0

skipPublishAttachments

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

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

allFiles

protected List<File> allFiles

files to deploy

Constructor Detail

PublishAttachmentsMojo

public PublishAttachmentsMojo()

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

isGoalSkip

protected boolean isGoalSkip()

Specified by:

isGoalSkip in class AbstractRedmineMojo

isRunOnce

protected boolean isRunOnce()

Specified by:

isRunOnce in class AbstractRedmineMojo

checkRunOnceDone

protected boolean checkRunOnceDone()

Specified by:

checkRunOnceDone in class AbstractRedmineMojo

init

protected void init()
             throws Exception

Overrides:

init in class AbstractRedmineMojoWithProjectAndVersion

Throws:

Exception

checkSkip

protected boolean checkSkip()

Overrides:

checkSkip in class AbstractRedmineMojoWithProjectAndVersion

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

getFilesToDeploy

protected List<File> getFilesToDeploy()
                               throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException