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:

jxpearce

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
BuildNotifier	addGithubNotifier(GithubNotificationConfig config) Adds a Github repository for notifications
BuildNotifier	addInfluxDbNotifier(InfluxDbNotifierConfig influxDbNotifierConfig) Adds an influx DB notifier
void	notifyBuildStageStatus(String stageName, BuildState buildState, long nodeDuration) Send stage status notification
void	notifyFinalBuildStatus(BuildState buildState, long buildDuration) Send overall build status notification
void	sendNonStageError(String nodeName) 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 object

addInfluxDbNotifier

public BuildNotifier addInfluxDbNotifier(InfluxDbNotifierConfig influxDbNotifierConfig)

Adds an influx DB notifier

Parameters:

influxDbNotifierConfig - influx db notification configuration

Returns:

notifyBuildStageStatus

public void notifyBuildStageStatus(String stageName,
                                   BuildState buildState,
                                   long nodeDuration)

Send stage status notification

Parameters:

stageName - the stage name

buildState - the build status

nodeDuration - elapsed time for this node

notifyFinalBuildStatus

public void notifyFinalBuildStatus(BuildState buildState,
                                   long buildDuration)

Send overall build status notification

Parameters:

buildState - the build status

buildDuration - elapsed time for this build

sendNonStageError

public void sendNonStageError(String nodeName)

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:

nodeName - the name of the node that failed