htmlpublisher

Class HtmlPublisher

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

htmlpublisher.HtmlPublisher

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Publisher>, hudson.tasks.BuildStep

public class HtmlPublisher
extends hudson.tasks.Recorder

Saves HTML reports for the project and publishes them.

Author:

Kohsuke Kawaguchi, Mike Rooney

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HtmlPublisher.DescriptorImpl

Nested classes/interfaces inherited from class hudson.tasks.Publisher

hudson.tasks.Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
HtmlPublisher(List<HtmlPublisherTarget> reportTargets)

Method Summary

Modifier and Type	Method and Description
Collection<? extends hudson.model.Action>	getProjectActions(hudson.model.AbstractProject<?,?> project)
ArrayList<HtmlPublisherTarget>	getReportTargets()
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)
static boolean	publishReports(hudson.model.Run<?,?> build, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener, List<HtmlPublisherTarget> reportTargets, Class<?> publisherClass) Runs HTML the publishing operation for specified HtmlPublisherTargets.
ArrayList<String>	readFile(String filePath)
static ArrayList<String>	readFile(String filePath, Class<?> publisherClass)
protected static String	resolveParametersInString(hudson.EnvVars envVars, hudson.model.TaskListener listener, String input)
protected static String	resolveParametersInString(hudson.model.Run<?,?> build, hudson.model.TaskListener listener, String input)

Methods inherited from class hudson.tasks.Recorder

getDescriptor

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, perform, prebuild

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlPublisher

@DataBoundConstructor
 @Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
public HtmlPublisher(List<HtmlPublisherTarget> reportTargets)

Method Detail

getReportTargets

public ArrayList<HtmlPublisherTarget> getReportTargets()

readFile

public ArrayList<String> readFile(String filePath)
                           throws FileNotFoundException,
                                  IOException

Throws:

FileNotFoundException

IOException

readFile

public static ArrayList<String> readFile(String filePath,
                                         Class<?> publisherClass)
                                  throws FileNotFoundException,
                                         IOException

Throws:

FileNotFoundException

IOException

resolveParametersInString

protected static String resolveParametersInString(hudson.model.Run<?,?> build,
                                                  hudson.model.TaskListener listener,
                                                  String input)

resolveParametersInString

protected static String resolveParametersInString(hudson.EnvVars envVars,
                                                  hudson.model.TaskListener listener,
                                                  String input)

perform

public boolean perform(hudson.model.AbstractBuild<?,?> build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)
                throws InterruptedException

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Throws:

InterruptedException

publishReports

public static boolean publishReports(hudson.model.Run<?,?> build,
                                     hudson.FilePath workspace,
                                     hudson.Launcher launcher,
                                     hudson.model.TaskListener listener,
                                     List<HtmlPublisherTarget> reportTargets,
                                     Class<?> publisherClass)
                              throws InterruptedException

Runs HTML the publishing operation for specified HtmlPublisherTargets.

Returns:

False if the operation failed

Throws:

InterruptedException

Since:

TODO

getProjectActions

public Collection<? extends hudson.model.Action> getProjectActions(hudson.model.AbstractProject<?,?> project)

Specified by:

getProjectActions in interface hudson.tasks.BuildStep

Overrides:

getProjectActions in class hudson.tasks.BuildStepCompatibilityLayer

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()