Package io.jenkins.plugins.explain_error

Class ConsolePageDecorator

java.lang.Object

hudson.model.Descriptor<PageDecorator>

hudson.model.PageDecorator

io.jenkins.plugins.explain_error.ConsolePageDecorator

All Implemented Interfaces:

ExtensionPoint, Describable<PageDecorator>, Saveable, Loadable, OnMaster

Direct Known Subclasses:

PipelineGraphViewDecorator

@Extension
public class ConsolePageDecorator
extends PageDecorator

Page decorator to add "Explain Error" functionality to console output pages.

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.PageDecorator

ALL

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Constructor	Description
ConsolePageDecorator()

Method Summary

Modifier and Type	Method	Description
ErrorExplanationAction	getExistingExplanation()
String	getProviderName()
String	getRunUrl()
boolean	isExplainErrorEnabled()	Whether the page offers to explain the build: explanation is enabled for it, its provider is configured and the user may build the job, which a new explanation requires.
boolean	isPluginActive()	Helper method used by jelly to checked if we're on a console url.

Methods inherited from class hudson.model.PageDecorator

all, getDescriptor, getUrl

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, bindJSON, calcAutoCompleteSettings, calcFillSettings, configure, configure, configure, doHelp, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getRequiredGlobalConfigPagePermission, getStaticHelpUrl, getStaticHelpUrl, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Constructor Details

ConsolePageDecorator

public ConsolePageDecorator()

Method Details

isExplainErrorEnabled

public boolean isExplainErrorEnabled()

Whether the page offers to explain the build: explanation is enabled for it, its provider is configured and the user may build the job, which a new explanation requires. Folder settings count, so a folder with a provider of its own gets the button while the global switch is off, and a folder that turns explanation off does not get it. An explanation the build has is shown to anyone who can read the build.

getProviderName

public String getProviderName()

Returns:

the name of the provider a new explanation of the build would come from, folder or global

isPluginActive

public boolean isPluginActive()

Helper method used by jelly to checked if we're on a console url.

getRunUrl

public String getRunUrl()

getExistingExplanation

public ErrorExplanationAction getExistingExplanation()