ch.fortysix.maven.report
Class AbstractReportMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          ch.fortysix.maven.report.AbstractReportMojo

All Implemented Interfaces:

groovy.lang.GroovyObject, org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport

Direct Known Subclasses:

PostmanCriterionReportMojortMojo, PostmanSurefireReportMojoo, PostmanTaglistReportMojo

public abstract class AbstractReportMojo
extends org.apache.maven.reporting.AbstractMavenReport
implements groovy.lang.GroovyObject

Author:

Domi

Field Summary

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

AbstractReportMojo()

Method Summary

protected abstract void	executePostmanReport(Locale locale) To be implemented by subclasses
protected void	executeReport(Locale locale) do the report and send the mails
String	getActualDocuSite() Returns the actual url to the documentation site
ResourceBundle	getBundle(Locale locale)
String	getDescription(Locale locale)
String	getDocuSite()
boolean	getFailonerror()
String	getFrom()
boolean	getMailAltConfig()
String	getMailcontenttype()
String	getMailhost()
String	getMailpassword()
String	getMailport()
Object	getMailSender()
boolean	getMailssl()
String	getMailuser()
groovy.lang.MetaClass	getMetaClass()
boolean	getMultipartSupported()
String	getName(Locale locale)
abstract String	getNlsPrefix() prefix within the bundle files - has to be overwritten by implemtors!
protected String	getOutputDirectory()
protected org.apache.maven.project.MavenProject	getProject()
Object	getProperty(String name)
Object	getSendReport()
org.apache.maven.execution.MavenSession	getSession()
protected org.apache.maven.doxia.siterenderer.Renderer	getSiteRenderer()
boolean	getSkipMails()
String	getSourceEncoding()
String	getSubject()
protected abstract String	getSubjectPostFix() returns the postfix for the mail subject
Object	invokeMethod(String name, Object args)
boolean	isFailonerror()
boolean	isMailAltConfig()
boolean	isMailssl()
boolean	isMultipartSupported()
boolean	isSkipMails()
void	setDocuSite(String value)
void	setFailonerror(boolean value)
void	setFrom(String value)
void	setMailAltConfig(boolean value)
void	setMailcontenttype(String value)
void	setMailhost(String value)
void	setMailpassword(String value)
void	setMailport(String value)
void	setMailSender(Object value)
void	setMailssl(boolean value)
void	setMailuser(String value)
void	setMetaClass(groovy.lang.MetaClass metaClass)
void	setMultipartSupported(boolean value)
void	setOutputDirectory(File value)
void	setProject(org.apache.maven.project.MavenProject value)
void	setProperty(String name, Object value)
void	setSendReport(Object value)
void	setSession(org.apache.maven.execution.MavenSession value)
void	setSkipMails(boolean value)
void	setSourceEncoding(String value)
void	setSubject(String value)

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

canGenerateReport, closeReport, execute, generate, getCategoryName, getReportOutputDirectory, getSink, isExternalReport, setReportOutputDirectory

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

Constructor Detail

AbstractReportMojo

public AbstractReportMojo()

Method Detail

getSession

public org.apache.maven.execution.MavenSession getSession()

setSession

public void setSession(org.apache.maven.execution.MavenSession value)

getSourceEncoding

public String getSourceEncoding()

setSourceEncoding

public void setSourceEncoding(String value)

getSkipMails

public boolean getSkipMails()

isSkipMails

public boolean isSkipMails()

setSkipMails

public void setSkipMails(boolean value)

setProject

public void setProject(org.apache.maven.project.MavenProject value)

getMailssl

public boolean getMailssl()

isMailssl

public boolean isMailssl()

setMailssl

public void setMailssl(boolean value)

getMailAltConfig

public boolean getMailAltConfig()

isMailAltConfig

public boolean isMailAltConfig()

setMailAltConfig

public void setMailAltConfig(boolean value)

getMailhost

public String getMailhost()

setMailhost

public void setMailhost(String value)

getMailport

public String getMailport()

setMailport

public void setMailport(String value)

getMailuser

public String getMailuser()

setMailuser

public void setMailuser(String value)

getMailpassword

public String getMailpassword()

setMailpassword

public void setMailpassword(String value)

getSubject

public String getSubject()

setSubject

public void setSubject(String value)

getFrom

public String getFrom()

setFrom

public void setFrom(String value)

setOutputDirectory

public void setOutputDirectory(File value)

getDocuSite

public String getDocuSite()

setDocuSite

public void setDocuSite(String value)

getFailonerror

public boolean getFailonerror()

isFailonerror

public boolean isFailonerror()

setFailonerror

public void setFailonerror(boolean value)

getMailcontenttype

public String getMailcontenttype()

setMailcontenttype

public void setMailcontenttype(String value)

getMultipartSupported

public boolean getMultipartSupported()

isMultipartSupported

public boolean isMultipartSupported()

setMultipartSupported

public void setMultipartSupported(boolean value)

getMailSender

public Object getMailSender()

setMailSender

public void setMailSender(Object value)

getSendReport

public Object getSendReport()

setSendReport

public void setSendReport(Object value)

getNlsPrefix

public abstract String getNlsPrefix()

prefix within the bundle files - has to be overwritten by implemtors!

getOutputDirectory

protected String getOutputDirectory()

Specified by:

getOutputDirectory in class org.apache.maven.reporting.AbstractMavenReport

See Also:

AbstractMavenReport.getOutputDirectory()

getProject

protected org.apache.maven.project.MavenProject getProject()

Specified by:

getProject in class org.apache.maven.reporting.AbstractMavenReport

See Also:

AbstractMavenReport.getProject()

getSiteRenderer

protected org.apache.maven.doxia.siterenderer.Renderer getSiteRenderer()

Specified by:

getSiteRenderer in class org.apache.maven.reporting.AbstractMavenReport

See Also:

AbstractMavenReport.getSiteRenderer()

getDescription

public String getDescription(Locale locale)

Specified by:

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

getName

public String getName(Locale locale)

Specified by:

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

getBundle

public ResourceBundle getBundle(Locale locale)

executeReport

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

do the report and send the mails

Specified by:

executeReport in class org.apache.maven.reporting.AbstractMavenReport

Throws:

org.apache.maven.reporting.MavenReportException

executePostmanReport

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

To be implemented by subclasses

Throws:

org.apache.maven.reporting.MavenReportException

getSubjectPostFix

protected abstract String getSubjectPostFix()

returns the postfix for the mail subject

getActualDocuSite

public String getActualDocuSite()

Returns the actual url to the documentation site

getMetaClass

public groovy.lang.MetaClass getMetaClass()

Specified by:

getMetaClass in interface groovy.lang.GroovyObject

setMetaClass

public void setMetaClass(groovy.lang.MetaClass metaClass)

Specified by:

setMetaClass in interface groovy.lang.GroovyObject

invokeMethod

public Object invokeMethod(String name,
                           Object args)

Specified by:

invokeMethod in interface groovy.lang.GroovyObject

getProperty

public Object getProperty(String name)

Specified by:

getProperty in interface groovy.lang.GroovyObject

setProperty

public void setProperty(String name,
                        Object value)

Specified by:

setProperty in interface groovy.lang.GroovyObject