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 (jxpearce@godaddy.com)

Constructor Summary

Constructors

Constructor and Description
BuildNotifierManager(String jobName, String targetUrl) Constructs a BuildNotifierManager

Method Summary

Modifier and Type	Method and Description
BuildNotifier	addGenericNofifier(BuildNotifier buildNotifier)
BuildNotifier	addGithubNotifier(GithubNotificationConfig config) Adds a GitHub repository for notifications
BuildNotifier	addInfluxDbNotifier(InfluxDbNotifierConfig influxDbNotifierConfig) Adds an influx DB notifier
BuildNotifier	addStatsdBuildNotifier(StatsdNotifierConfig statsdNotifierConfig) Adds an Statsd notifier
void	notifyBuildStageStatus(BuildStageModel stageItem) Send stage status notification
void	notifyFinalBuildStatus(BuildState buildState, Map<String,Object> parameters) Send overall build status notification
void	sendNonStageError(BuildStageModel 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

Constructor Detail

BuildNotifierManager

public BuildNotifierManager(String jobName,
                            String targetUrl)

Constructs a BuildNotifierManager

Parameters:

jobName - the job notifications are for

targetUrl - link back to Jenkins

Method Detail

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 influx DB notifier

Parameters:

influxDbNotifierConfig - influx db notification configuration

Returns:

The notifier object which was added

addGenericNofifier

public BuildNotifier addGenericNofifier(BuildNotifier buildNotifier)

addStatsdBuildNotifier

public BuildNotifier addStatsdBuildNotifier(StatsdNotifierConfig statsdNotifierConfig)

Adds an Statsd notifier

Parameters:

statsdNotifierConfig - Statsd notification configuration

Returns:

the notifier object configured for Statsd

notifyBuildStageStatus

public void notifyBuildStageStatus(BuildStageModel stageItem)

Send stage status notification

Parameters:

stageItem - stage item

notifyFinalBuildStatus

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

Send overall build status notification

Parameters:

buildState - the build status

parameters - build parameters

sendNonStageError

public void sendNonStageError(BuildStageModel 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