org.apache.geronimo.mavenplugins.geronimo.reporting
Class ReportingMojoSupport

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.geronimo.genesis.MojoSupport
          org.apache.geronimo.genesis.AntMojoSupport
              org.apache.geronimo.mavenplugins.geronimo.GeronimoMojoSupport
                  org.apache.geronimo.mavenplugins.geronimo.reporting.ReportingMojoSupport

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

InstallerMojoSupport, ModuleMojoSupport, StopServerMojo, WaitForServerMojo

public abstract class ReportingMojoSupport

extends GeronimoMojoSupport

Support for Geronimo mojos which can be processed by a set of Reporters.

Version:

$Rev: 451383 $ $Date: 2006-09-29 11:54:33 -0700 (Fri, 29 Sep 2006) $

Field Summary

protected File	logFile When logOutput is enabled, the output is logged to the file location specified here.
protected boolean	logOutput Enable logging mode.
protected File	logOutputDirectory The directory where log files will be put under.
protected Reporter[]	reporters A set of reporters which will do something interesting with the execution results.

Fields inherited from class org.apache.geronimo.mavenplugins.geronimo.GeronimoMojoSupport

artifactFactory, artifactRepository, artifactResolver, hostname, password, port, project, username

Fields inherited from class org.apache.geronimo.genesis.AntMojoSupport

ant

Fields inherited from class org.apache.geronimo.genesis.MojoSupport

log

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

ROLE

Constructor Summary

ReportingMojoSupport()

Method Summary

void	execute() Provides hooks into the reporting interface to allow for customized reports to be generated for goal executions.
protected abstract String	getGoalName() Sub-class must override to provide the goal name.
protected File	getLogFile()

Methods inherited from class org.apache.geronimo.mavenplugins.geronimo.GeronimoMojoSupport

getArtifactFactory, getArtifactRepository, getArtifactResolver, getProject

Methods inherited from class org.apache.geronimo.genesis.AntMojoSupport

createFileSet, createTask, inheritProperties, init, initAntLogger, mkdir, setProperty

Methods inherited from class org.apache.geronimo.genesis.MojoSupport

createArtifact, doExecute, getArtifact

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

Field Detail

logOutput

protected boolean logOutput

Enable logging mode.

logOutputDirectory

protected File logOutputDirectory

The directory where log files will be put under.

logFile

protected File logFile

When logOutput is enabled, the output is logged to the file location specified here. If this value is not present, then "${logOutputDirectory}/goal-name" log will be used.

reporters

protected Reporter[] reporters

A set of reporters which will do something interesting with the execution results.

Constructor Detail

ReportingMojoSupport

public ReportingMojoSupport()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Provides hooks into the reporting interface to allow for customized reports to be generated for goal executions.

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getLogFile

protected File getLogFile()

getGoalName

protected abstract String getGoalName()

Sub-class must override to provide the goal name.

Returns:

The name of the goal.