org.jenkinsci.plugins.githubautostatus.notifiers

Class BuildNotifier

java.lang.Object

org.jenkinsci.plugins.githubautostatus.notifiers.BuildNotifier

All Implemented Interfaces:

hudson.ExtensionPoint

Direct Known Subclasses:

GithubBuildNotifier, HttpNotifier, InfluxDbNotifier, StatsdNotifier

public abstract class BuildNotifier
extends Object
implements hudson.ExtensionPoint

A notification subscriber which can send build stats to a particular sink.

Author:

Jeff Pearce (GitHub jeffpearce)

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
protected long	DEFAULT_LONG Establishing a default long for use in getLong.
protected String	DEFAULT_STRING Establishing a default string for use in notifiers.

Constructor Summary

Constructors

Constructor and Description
BuildNotifier()

Method Summary

Modifier and Type	Method and Description
static hudson.ExtensionList<BuildNotifier>	all()
long	getLong(Map<String,Object> map, String mapKey)
abstract boolean	isEnabled() Determines whether this notifier is enabled.
abstract void	notifyBuildStageStatus(String jobName, BuildStage stageItem) Sends a state change with timing info.
abstract void	notifyFinalBuildStatus(BuildStage.State buildState, Map<String,Object> parameters) Sends a notification when a job is complete.
boolean	wantsOutOfStageErrors() Get whether the notifier wants to know about errors that happen outside of a stage.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LONG

protected final long DEFAULT_LONG

Establishing a default long for use in getLong.

See Also:

Constant Field Values

DEFAULT_STRING

protected final String DEFAULT_STRING

Establishing a default string for use in notifiers.

See Also:

Constant Field Values

Constructor Detail

BuildNotifier

public BuildNotifier()

Method Detail

isEnabled

public abstract boolean isEnabled()

Determines whether this notifier is enabled.

Returns:

true if enabled; false otherwise

notifyBuildStageStatus

public abstract void notifyBuildStageStatus(String jobName,
                                            BuildStage stageItem)

Sends a state change with timing info.

Parameters:

jobName - the name of the job

stageItem - stage item

notifyFinalBuildStatus

public abstract void notifyFinalBuildStatus(BuildStage.State buildState,
                                            Map<String,Object> parameters)

Sends a notification when a job is complete.

Parameters:

buildState - state indicating success or failure

parameters - build parameters

wantsOutOfStageErrors

public boolean wantsOutOfStageErrors()

Get whether the notifier wants to know about errors that happen outside of a stage.

Returns:

whether the notifier wants to know about errors that happen outside of a stage

all

public static hudson.ExtensionList<BuildNotifier> all()

getLong

public long getLong(Map<String,Object> map,
                    String mapKey)