Package hudson.maven.reporters

Class MavenSiteArchiver

java.lang.Object

hudson.maven.MavenReporter

hudson.maven.reporters.MavenSiteArchiver

All Implemented Interfaces:

ExtensionPoint, MavenProjectActionBuilder, Describable<MavenReporter>, Serializable

public class MavenSiteArchiver
extends MavenReporter

Watches out for the execution of maven-site-plugin and records its output. Simple projects with one POM will find the site directly beneath site. For multi module projects the project whose pom is referenced in the configuration (i.e. the MavenBuild.getParentBuild() will be recorded to the site, module projects' sites will be stored beneath site/${moduleProject.artifactId}.

Author:

Kohsuke Kawaguchi

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MavenSiteArchiver.DescriptorImpl
static class	MavenSiteArchiver.SiteAction

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
MavenSiteArchiver()

Method Summary

Modifier and Type	Method	Description
Action	getAggregatedProjectAction(MavenModuleSet project)	Works like MavenReporter.getProjectAction(MavenModule) but works at MavenModuleSet level.
Collection<? extends Action>	getProjectActions(MavenModule project)	Equivalent of BuildStep.getProjectActions(AbstractProject) for MavenReporter.
boolean	postExecute(MavenBuildProxy build, org.apache.maven.project.MavenProject pom, MojoInfo mojo, BuildListener listener, Throwable error)	Called after execution of a single mojo.

Methods inherited from class hudson.maven.MavenReporter

end, enterModule, getDescriptor, getProjectAction, leaveModule, postBuild, preBuild, preExecute, reportGenerated

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MavenSiteArchiver

public MavenSiteArchiver()

Method Details

postExecute

public boolean postExecute(MavenBuildProxy build,
 org.apache.maven.project.MavenProject pom,
 MojoInfo mojo,
 BuildListener listener,
 Throwable error)
                    throws InterruptedException,
IOException

Description copied from class: MavenReporter

Called after execution of a single mojo.

See MavenReporter.preExecute(hudson.maven.MavenBuildProxy, org.apache.maven.project.MavenProject, hudson.maven.MojoInfo, hudson.model.BuildListener) for the contract.

Overrides:

postExecute in class MavenReporter

error - If mojo execution failed with MojoFailureException or MojoExecutionException, this method is still invoked with those error objects. If mojo executed successfully, this parameter is null.

Throws:

InterruptedException

IOException

getProjectActions

public Collection<? extends Action> getProjectActions(MavenModule project)

Description copied from class: MavenReporter

Equivalent of BuildStep.getProjectActions(AbstractProject) for MavenReporter.

Registers a transient action to MavenModule when it's rendered. This is useful if you'd like to display an action at the module level.

Since this contributes a transient action, the returned Action will not be serialized.

For this method to be invoked, your MavenReporter has to invoke MavenBuildProxy.registerAsProjectAction(MavenReporter) during the build.

Specified by:

getProjectActions in interface MavenProjectActionBuilder

Overrides:

getProjectActions in class MavenReporter

Returns:

can be empty but never null.

getAggregatedProjectAction

public Action getAggregatedProjectAction(MavenModuleSet project)

Description copied from class: MavenReporter

Works like MavenReporter.getProjectAction(MavenModule) but works at MavenModuleSet level.

For this method to be invoked, your MavenReporter has to invoke MavenBuildProxy.registerAsAggregatedProjectAction(MavenReporter) during the build.

Overrides:

getAggregatedProjectAction in class MavenReporter

Returns:

null not to contribute an action, which is the default.