org.jenkinsci.plugins.githubautostatus.notifiers

Class BuildNotifierManager

java.lang.Object

org.jenkinsci.plugins.githubautostatus.notifiers.BuildNotifierManager

public class BuildNotifierManager
extends Object

Manages send build notifications to one or more notifiers.

Author:

Jeff Pearce (GitHub jeffpearce)

Method Summary

Modifier and Type	Method and Description
BuildNotifier	addGenericNotifier(BuildNotifier buildNotifier)
BuildNotifier	addGithubNotifier(GithubNotificationConfig config) Adds a GitHub repository for notifications.
BuildNotifier	addHttpNotifier(HttpNotifierConfig httpNotifierConfig) Adds an HTTP notifier.
BuildNotifier	addInfluxDbNotifier(InfluxDbNotifierConfig influxDbNotifierConfig) Adds an InfluxDB notifier.
BuildNotifier	addStatsdBuildNotifier(StatsdNotifierConfig statsdNotifierConfig) Adds a StatsD notifier.
static BuildNotifierManager	newInstance(String jobName, String targetUrl)
void	notifyBuildStageStatus(BuildStage stageItem) Sends stage status notification.
void	notifyFinalBuildStatus(BuildStage.State buildState, Map<String,Object> parameters) Sends overall build status notification.
void	sendNonStageError(BuildStage stageItem) Sends a notification for an error regardless of whether initial pending status was sent.

Methods inherited from class java.lang.Object

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

Method Detail

newInstance

public static BuildNotifierManager newInstance(String jobName,
                                               String targetUrl)

addGithubNotifier

public BuildNotifier addGithubNotifier(GithubNotificationConfig config)

Adds a GitHub repository for notifications.

Parameters:

config - GitHub notification configuration

Returns:

the notifier which was added

addInfluxDbNotifier

public BuildNotifier addInfluxDbNotifier(InfluxDbNotifierConfig influxDbNotifierConfig)

Adds an InfluxDB notifier.

Parameters:

influxDbNotifierConfig - InfluxDB notification configuration

Returns:

the notifier which was added

addHttpNotifier

public BuildNotifier addHttpNotifier(HttpNotifierConfig httpNotifierConfig)

Adds an HTTP notifier.

Parameters:

httpNotifierConfig - HTTP notification configuration

Returns:

the notifier which was added

addGenericNotifier

public BuildNotifier addGenericNotifier(BuildNotifier buildNotifier)

addStatsdBuildNotifier

public BuildNotifier addStatsdBuildNotifier(StatsdNotifierConfig statsdNotifierConfig)

Adds a StatsD notifier.

Parameters:

statsdNotifierConfig - StatsD notification configuration

Returns:

the notifier which was added

notifyBuildStageStatus

public void notifyBuildStageStatus(BuildStage stageItem)

Sends stage status notification.

Parameters:

stageItem - stage item

notifyFinalBuildStatus

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

Sends overall build status notification.

Parameters:

buildState - the build status

parameters - build parameters

sendNonStageError

public void sendNonStageError(BuildStage stageItem)

Sends a notification for an error regardless of whether initial pending status was sent. Useful for reporting errors for non-declarative pipelines when they happen outside of a stage.

Parameters:

stageItem - stage item