org.nuiton.jredmine.plugin.report

Class AbstractRedmineReport

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.report.AbstractRedmineReport

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractIssuesReport

public abstract class AbstractRedmineReport
extends AbstractRedmineMojoWithProject
implements org.apache.maven.reporting.MavenReport, RedmineVersionAware

Abstract redmine report mojo.

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 org.apache.maven.artifact.factory.ArtifactFactory	factory Artifact factory.
protected org.codehaus.plexus.i18n.I18N	i18n Internationalization.
protected String	issueLinkTemplate Template strings per system that is used to discover the URL to use to display an issue report.
protected org.apache.maven.artifact.repository.ArtifactRepository	localRepository Local Repository.
protected File	outputDirectory Report output directory.
protected org.apache.maven.artifact.resolver.ArtifactResolver	resolver Artifact resolver.
protected org.apache.maven.doxia.siterenderer.Renderer	siteRenderer Doxia Site Renderer.
protected String	versionId Redmine version name.
protected String	versionLinkTemplate Template strings per system that is used to discover the URL to use to display an issue report.

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.reporting.MavenReport

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

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

ROLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRedmineReport()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canGenerateReport()
protected void	doAction() Re-expose the protected method for test purposes...
protected abstract void	executeReport(Locale locale)
void	generate(org.codehaus.doxia.sink.Sink sink, Locale locale)
protected ResourceBundle	getBundle(Locale locale)
String	getCategoryName()
String	getDescription(Locale locale)
String	getName(Locale locale)
File	getReportOutputDirectory()
protected org.apache.maven.doxia.sink.Sink	getSink()
protected File	getSkinArtifactFile()
String	getVersionId()
boolean	isAnonymous()
boolean	isExternalReport()
void	setAnonymous(boolean anonymous)
void	setReportOutputDirectory(File reportOutputDirectory)
void	setVersionId(String versionId)
protected abstract boolean	skipReport()

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

checkSkip, getProjectId, init, 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.reporting.MavenReport

getOutputName

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

getLog, setLog

Field Detail

versionId

@Parameter(property="redmine.versionId",
           defaultValue="${project.version}")
protected String versionId

Redmine version name.

Since:

1.0.0

anonymous

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

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

For this goal, the default value is true

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

Since:

1.1.3

issueLinkTemplate

@Parameter(property="redmine.issueLinkTemplate",
           defaultValue="%URL%/issues/show/%ISSUE%")
protected String issueLinkTemplate

Template strings per system that is used to discover the URL to use to display an issue report. 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. %ISSUE%: this is the issue number.

Since:

1.0.0

versionLinkTemplate

@Parameter(property="redmine.versionLinkTemplate",
           defaultValue="%URL%/versions/show/%VERSION%")
protected String versionLinkTemplate

Template strings per system that is used to discover the URL to use to display an issue report. 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. %VERSION%: this is the issue number.

Since:

1.0.0

localRepository

@Parameter(property="localRepository",
           required=true,
           readonly=true)
protected org.apache.maven.artifact.repository.ArtifactRepository localRepository

Local Repository.

Since:

1.0.0

outputDirectory

@Parameter(defaultValue="${project.reporting.outputDirectory}")
protected File outputDirectory

Report output directory. Note that this parameter is only relevant if the goal is run from the command line or from the default build lifecycle. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead.

Since:

1.0.0

resolver

@Component
protected org.apache.maven.artifact.resolver.ArtifactResolver resolver

Artifact resolver.

Since:

1.0.0

factory

@Component
protected org.apache.maven.artifact.factory.ArtifactFactory factory

Artifact factory.

Since:

1.0.0

i18n

@Component
protected org.codehaus.plexus.i18n.I18N i18n

Internationalization.

Since:

1.0.0

siteRenderer

@Component
protected org.apache.maven.doxia.siterenderer.Renderer siteRenderer

Doxia Site Renderer.

Since:

1.0.0

Constructor Detail

AbstractRedmineReport

protected AbstractRedmineReport()

Method Detail

executeReport

protected abstract void executeReport(Locale locale)
                               throws org.apache.maven.reporting.MavenReportException

Throws:

org.apache.maven.reporting.MavenReportException

skipReport

protected abstract boolean skipReport()

Returns:

true if report should be skip

isAnonymous

public boolean isAnonymous()

Specified by:

isAnonymous in interface RedmineClientConfiguration

setAnonymous

public void setAnonymous(boolean anonymous)

Specified by:

setAnonymous in interface RedmineClientConfiguration

getVersionId

public final String getVersionId()

Specified by:

getVersionId in interface RedmineVersionAware

setVersionId

public void setVersionId(String versionId)

Specified by:

setVersionId in interface RedmineVersionAware

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

canGenerateReport

public boolean canGenerateReport()

Specified by:

canGenerateReport in interface org.apache.maven.reporting.MavenReport

generate

public void generate(org.codehaus.doxia.sink.Sink sink,
            Locale locale)
              throws org.apache.maven.reporting.MavenReportException

Specified by:

generate in interface org.apache.maven.reporting.MavenReport

Throws:

org.apache.maven.reporting.MavenReportException

getName

public String getName(Locale locale)

Specified by:

getName in interface org.apache.maven.reporting.MavenReport

getDescription

public String getDescription(Locale locale)

Specified by:

getDescription in interface org.apache.maven.reporting.MavenReport

getCategoryName

public String getCategoryName()

Specified by:

getCategoryName in interface org.apache.maven.reporting.MavenReport

getReportOutputDirectory

public File getReportOutputDirectory()

Specified by:

getReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

setReportOutputDirectory

public void setReportOutputDirectory(File reportOutputDirectory)

Specified by:

setReportOutputDirectory in interface org.apache.maven.reporting.MavenReport

isExternalReport

public boolean isExternalReport()

Specified by:

isExternalReport in interface org.apache.maven.reporting.MavenReport

getSink

protected org.apache.maven.doxia.sink.Sink getSink()

getBundle

protected ResourceBundle getBundle(Locale locale)

getSkinArtifactFile

protected File getSkinArtifactFile()
                            throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException