Package htmlpublisher

Class HtmlPublisher

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Recorder

htmlpublisher.HtmlPublisher

All Implemented Interfaces:

ExtensionPoint, Describable<Publisher>, BuildStep

public class HtmlPublisher
extends Recorder

Saves HTML reports for the project and publishes them.

Author:

Kohsuke Kawaguchi, Mike Rooney

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HtmlPublisher.DescriptorImpl

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

Publisher.DescriptorExtensionListImpl

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

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
HtmlPublisher(List<HtmlPublisherTarget> reportTargets)

Method Summary

Modifier and Type	Method	Description
static DirScanner	dirScannerGlob(String includes, String excludes, boolean useDefaultExcludes, OpenOption... openOptions)
Collection<? extends Action>	getProjectActions(AbstractProject<?,?> project)
List<HtmlPublisherTarget>	getReportTargets()
BuildStepMonitor	getRequiredMonitorService()
boolean	perform(AbstractBuild<?,?> build, Launcher launcher, BuildListener listener)
static boolean	publishReports(Run<?,?> build, FilePath workspace, TaskListener listener, List<HtmlPublisherTarget> reportTargets, Class<?> publisherClass)	Runs HTML the publishing operation for specified HtmlPublisherTargets.
List<String>	readFile(String filePath)
static List<String>	readFile(String filePath, Class<?> publisherClass)
protected static String	resolveParametersInString(EnvVars envVars, TaskListener listener, String input)
protected static String	resolveParametersInString(Run<?,?> build, 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(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public HtmlPublisher(List<HtmlPublisherTarget> reportTargets)

Method Detail

getReportTargets

public List<HtmlPublisherTarget> getReportTargets()

readFile

public List<String> readFile(String filePath)
                      throws IOException

Throws:

IOException

readFile

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

Throws:

IOException

resolveParametersInString

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

resolveParametersInString

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

perform

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

Specified by:

perform in interface BuildStep

Overrides:

perform in class BuildStepCompatibilityLayer

Throws:

InterruptedException

publishReports

public static boolean publishReports(Run<?,?> build,
                                     FilePath workspace,
                                     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

getProjectActions

@NonNull
public Collection<? extends Action> getProjectActions(AbstractProject<?,?> project)

Specified by:

getProjectActions in interface BuildStep

Overrides:

getProjectActions in class BuildStepCompatibilityLayer

dirScannerGlob

@SuppressRestrictedWarnings(org.kohsuke.accmod.restrictions.NoExternalUse.class)
public static DirScanner dirScannerGlob(String includes,
                                        String excludes,
                                        boolean useDefaultExcludes,
                                        OpenOption... openOptions)
                                 throws Exception

Throws:

Exception

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()