org.nuiton.jredmine.plugin.announcement

Class AbstractAnnouncementMojo

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.announcement.AbstractAnnouncementMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

GenerateEmailAnnouncementMojo, GenerateNewsAnnouncementMojo

public abstract class AbstractAnnouncementMojo
extends AbstractRedmineMojoWithProjectAndVersion
implements AnnouncementGeneratorConfiguration, SkipOrRunOnlyOnceAware

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 Map<String,Object>	announceParameters Map which will be pass to the velocity context
protected String	artifactId current project artifactId.
protected File	artifactsFile Files where are stored location of artifacts to deploy by the build.
protected Map<File,String>	artifactUrls
protected String	attachmentLinkTemplate Template strings per system that is used to discover the URL to use to display an attchment.
protected Attachment[]	attachments
protected Map<Attachment,String>	attachmentUrls
protected String	basedir The current project base directory.
protected String	deploymentUrl Deployement url (for artifacts).
protected String	developmentTeam Name of the team that develops the artifact.
protected String	finalName The name of the artifact to be used in the announcement.
protected AnnouncementGenerator	generator
protected String	groupId Current maven project groupId.
protected String	introduction Short description or introduction of the released artifact.
protected String	packaging Packaging structure for the artifact.
protected String	projectUrl Distribution url of the artifact.
protected List<?>	releases
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 String	templateDirectory Directory that contains the template.
protected String	templateEncoding The template encoding.
protected File	templateOutputDirectory Directory where the template file will be generated.
protected String	urlDownload URL where the artifact can be downloaded.
protected org.codehaus.plexus.velocity.VelocityComponent	velocity Velocity Component.
protected File	xmlPath The path of the changes.xml file.

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

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

ROLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAnnouncementMojo()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkRunOnceDone()
protected void	doAction() Re-expose the protected method for test purposes...
protected abstract String	getAnnouncementTemplate()
Map<String,Object>	getAnnounceParameters()
String	getArtifactId()
Map<File,String>	getArtifactUrls()
String	getAttachmentLinkTemplate()
Map<Attachment,String>	getAttachmentUrls()
String	getBasedir()
String	getDeploymentUrl()
String	getDevelopmentTeam()
String	getFinalName()
String	getGroupId()
String	getIntroduction()
protected File	getOutputFile()
String	getPackaging()
String	getProjectUrl()
String	getUrlDownload()
protected void	init()
boolean	isRunOnce()
boolean	isRunOnceDone()
boolean	isRunOnlyOnRoot()

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

checkSkip, 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, 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.nuiton.jredmine.plugin.announcement.AnnouncementGeneratorConfiguration

getLog, getProject, getUrl, getVersionId

Methods inherited from interface org.nuiton.jredmine.plugin.SkipOrRunOnlyOnceAware

getSkipProperty, isGoalSkip

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

getLog, setLog

Field Detail

templateOutputDirectory

@Parameter(property="redmine.templateOutputDirectory",
           defaultValue="${project.build.directory}/generated-sources/announcement",
           required=true)
protected File templateOutputDirectory

Directory where the template file will be generated.

Since:

1.0.0

xmlPath

@Parameter(property="redmine.xmlPath",
           defaultValue="${basedir}/src/changes/changes.xml",
           required=true)
protected File xmlPath

The path of the changes.xml file.

Since:

1.0.0

templateDirectory

@Parameter(property="redmine.templateDirectory",
           defaultValue="org/nuiton/jredmine/plugin/announcement",
           required=true)
protected String templateDirectory

Directory that contains the template.

Note: This directory must be a subdirectory of /src/main/resources/ or current project base directory.

Since:

1.0.0

templateEncoding

@Parameter(property="redmine.templateEncoding",
           defaultValue="${project.build.sourceEncoding}")
protected String templateEncoding

The template encoding.

Since:

1.0.0

announceParameters

@Parameter
protected Map<String,Object> announceParameters

Map which will be pass to the velocity context

Since:

1.0.0

attachmentLinkTemplate

@Parameter(property="redmine.attachmentLinkTemplate",
           defaultValue="%URL%/attachments/download/%FILE%")
protected String attachmentLinkTemplate

Template strings per system that is used to discover the URL to use to display an attchment. Each key in this map denotes the (case-sensitive) identifier of the issue tracking system and its value gives the URL template.

There are 2 template tokens you can use. %URL%: this is computed by getting the <issueManagement>/<url> value from the POM, and removing the last '/' and everything that comes after it. %FILE%: this is the issue number.

Since:

1.0.0

groupId

@Parameter(property="session.topLevelProject.groupId",
           readonly=true)
protected String groupId

Current maven project groupId.

Since:

1.0.0

artifactId

@Parameter(property="session.topLevelProject.artifactId",
           readonly=true)
protected String artifactId

current project artifactId.

Since:

1.0.0

projectUrl

@Parameter(property="redmine.projectUrl",
           defaultValue="${session.topLevelProject.url}",
           required=true)
protected String projectUrl

Distribution url of the artifact.

Since:

1.0.0

packaging

@Parameter(property="project.packaging",
           readonly=true)
protected String packaging

Packaging structure for the artifact.

Since:

1.0.0

finalName

@Parameter(property="redmine.finalName",
           defaultValue="${session.topLevelProject.build.finalName}",
           required=true)
protected String finalName

The name of the artifact to be used in the announcement.

Since:

1.0.0

basedir

@Parameter(property="basedir",
           required=true)
protected String basedir

The current project base directory.

Since:

1.0.0

urlDownload

@Parameter
protected String urlDownload

URL where the artifact can be downloaded. If not specified, no URL is used.

Since:

1.0.0

Is defined by:

developmentTeam

@Parameter(property="redmine.developmentTeam",
           defaultValue="${session.topLevelProject.name} team",
           required=true)
protected String developmentTeam

Name of the team that develops the artifact.

Since:

1.0.0

Is required.

introduction

@Parameter(property="redmine.introduction",
           defaultValue="${session.topLevelProject.description}")
protected String introduction

Short description or introduction of the released artifact.

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

artifactsFile

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

Files where are stored location of artifacts to deploy by the build.

Since:

1.2.1

deploymentUrl

@Parameter(property="redmine.deploymentUrl",
           readonly=true)
protected String deploymentUrl

Deployement url (for artifacts).

Since:

1.2.1

velocity

@Component(hint="jredmine-maven-plugin")
protected org.codehaus.plexus.velocity.VelocityComponent velocity

Velocity Component.

Since:

1.0.0

attachments

protected Attachment[] attachments

artifactUrls

protected Map<File,String> artifactUrls

attachmentUrls

protected Map<Attachment,String> attachmentUrls

releases

protected List<?> releases

generator

protected AnnouncementGenerator generator

runOnceDone

protected boolean runOnceDone

flag to mark if a runOnce goal was done

Constructor Detail

AbstractAnnouncementMojo

protected AbstractAnnouncementMojo()

Method Detail

getAnnouncementTemplate

protected abstract String getAnnouncementTemplate()

Returns:

the name fo the template to use

getAttachmentLinkTemplate

public String getAttachmentLinkTemplate()

Specified by:

getAttachmentLinkTemplate in interface AnnouncementGeneratorConfiguration

Returns:

the redmine attachment url template

getArtifactId

public String getArtifactId()

Specified by:

getArtifactId in interface AnnouncementGeneratorConfiguration

getArtifactUrls

public Map<File,String> getArtifactUrls()

Specified by:

getArtifactUrls in interface AnnouncementGeneratorConfiguration

getAttachmentUrls

public Map<Attachment,String> getAttachmentUrls()

Specified by:

getAttachmentUrls in interface AnnouncementGeneratorConfiguration

getBasedir

public String getBasedir()

Specified by:

getBasedir in interface AnnouncementGeneratorConfiguration

getDeploymentUrl

public String getDeploymentUrl()

Specified by:

getDeploymentUrl in interface AnnouncementGeneratorConfiguration

getDevelopmentTeam

public String getDevelopmentTeam()

Specified by:

getDevelopmentTeam in interface AnnouncementGeneratorConfiguration

getFinalName

public String getFinalName()

Specified by:

getFinalName in interface AnnouncementGeneratorConfiguration

getGroupId

public String getGroupId()

Specified by:

getGroupId in interface AnnouncementGeneratorConfiguration

getIntroduction

public String getIntroduction()

Specified by:

getIntroduction in interface AnnouncementGeneratorConfiguration

getPackaging

public String getPackaging()

Specified by:

getPackaging in interface AnnouncementGeneratorConfiguration

getProjectUrl

public String getProjectUrl()

Specified by:

getProjectUrl in interface AnnouncementGeneratorConfiguration

getUrlDownload

public String getUrlDownload()

Specified by:

getUrlDownload in interface AnnouncementGeneratorConfiguration

getAnnounceParameters

public Map<String,Object> getAnnounceParameters()

Specified by:

getAnnounceParameters in interface AnnouncementGeneratorConfiguration

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

checkRunOnceDone

public boolean checkRunOnceDone()

Specified by:

checkRunOnceDone in interface SkipOrRunOnlyOnceAware

init

protected void init()
             throws Exception

Overrides:

init in class AbstractRedmineMojoWithProjectAndVersion

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

getOutputFile

protected File getOutputFile()