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

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.codehaus.mojo.pluginsupport.MojoSupport
          extended by org.codehaus.mojo.pluginsupport.ant.AntMojoSupport
              extended by org.apache.geronimo.mavenplugins.geronimo.GeronimoMojoSupport
                  extended by org.apache.geronimo.mavenplugins.geronimo.reporting.ReportingMojoSupport
All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable
Direct Known Subclasses:
InstallerMojoSupport, ModuleMojoSupport, RunClientMojo, StopServerMojo, WaitForServerMojo

public abstract class ReportingMojoSupport
extends GeronimoMojoSupport

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


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.
protected  boolean stopOnFailure
          Whether to stop or proceed when errors and failures are encountered
 
Fields inherited from class org.apache.geronimo.mavenplugins.geronimo.GeronimoMojoSupport
artifactRepository, hostname, password, port, project, username
 
Fields inherited from class org.codehaus.mojo.pluginsupport.ant.AntMojoSupport
ant
 
Fields inherited from class org.codehaus.mojo.pluginsupport.MojoSupport
container, 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 getFullClassName()
          Sub-class must override to provide the goal name.
protected  File getLogFile()
           
 
Methods inherited from class org.apache.geronimo.mavenplugins.geronimo.GeronimoMojoSupport
getArtifactRepository, getProject
 
Methods inherited from class org.codehaus.mojo.pluginsupport.ant.AntMojoSupport
createFileSet, createTask, inheritProperties, init, initAntLogger, mkdir, setProperty, setSystemProperty, setSystemProperty
 
Methods inherited from class org.codehaus.mojo.pluginsupport.MojoSupport
contextualize, createArtifact, doExecute, getArtifact, getArtifactFactory, getArtifactResolver, getProjectArtifacts, getProjectArtifacts, getProjectArtifacts, resolveArtifact, resolveArtifact
 
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.


stopOnFailure

protected boolean stopOnFailure
Whether to stop or proceed when errors and failures are encountered

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.

Specified by:
execute in interface org.apache.maven.plugin.Mojo
Overrides:
execute in class org.codehaus.mojo.pluginsupport.MojoSupport
Throws:
org.apache.maven.plugin.MojoExecutionException
org.apache.maven.plugin.MojoFailureException

getLogFile

protected File getLogFile()

getFullClassName

protected abstract String getFullClassName()
Sub-class must override to provide the goal name.

Returns:
The name of the goal.


Copyright © 2003-2007 Apache Software Foundation. All Rights Reserved.