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, InfluxDbNotifier

public abstract class BuildNotifier
extends Object
implements hudson.ExtensionPoint

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

Author:

Jeff Pearce (jxpearce@godaddy.com)

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
BuildNotifier()

Method Summary

Modifier and Type	Method and Description
static hudson.ExtensionList<BuildNotifier>	all()
abstract boolean	isEnabled() Determine whether notifier is enabled.
abstract void	notifyBuildStageStatus(String jobName, BuildStageModel stageItem) Send a state change, such as from Pending to Success or Pending to Error.
abstract void	notifyFinalBuildStatus(BuildState buildState, Map<String,Object> parameters) Send a notification when the job is complete

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildNotifier

public BuildNotifier()

Method Detail

isEnabled

public abstract boolean isEnabled()

Determine whether notifier is enabled.

Returns:

true if enabled; false otherwise.

notifyBuildStageStatus

public abstract void notifyBuildStageStatus(String jobName,
                                            BuildStageModel stageItem)

Send a state change, such as from Pending to Success or Pending to Error.

Parameters:

jobName - the name of the job

stageItem - stage item

notifyFinalBuildStatus

public abstract void notifyFinalBuildStatus(BuildState buildState,
                                            Map<String,Object> parameters)

Send a notification when the job is complete

Parameters:

buildState - state indicating success or failure

parameters - build parameters

all

public static hudson.ExtensionList<BuildNotifier> all()