tools.devnull.jenkins.plugins.buildnotifications

Class BaseNotifier

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Notifier

tools.devnull.jenkins.plugins.buildnotifications.BaseNotifier

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Publisher>, hudson.tasks.BuildStep

Direct Known Subclasses:

BotecoNotifier, PushoverNotifier, SlackNotifier, TelegramNotifier

public abstract class BaseNotifier
extends hudson.tasks.Notifier

A base class for all notifiers.

Author:

Ataxexe

Nested Class Summary

Nested classes/interfaces inherited from class hudson.tasks.Publisher

hudson.tasks.Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
BaseNotifier(String globalTarget, String successfulTarget, String brokenTarget, String stillBrokenTarget, String fixedTarget, boolean sendIfSuccess, String extraMessage) Creates a new notifier based on the given parameters

Method Summary

Modifier and Type	Method and Description
protected abstract Message	createMessage(String target, hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener) Creates the message for notifying users about the build.
protected BuildNotifier	createNotifier(hudson.model.AbstractBuild<?,?> build, Message message)
String	getBrokenTarget()
String	getExtraMessage()
String	getFixedTarget()
String	getGlobalTarget()
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
String	getStillBrokenTarget()
String	getSuccessfulTarget()
boolean	isSendIfSuccess()
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)
String	replaceEnvString(hudson.model.AbstractBuild build, String message) Replace Env variables to value.

Methods inherited from class hudson.tasks.Notifier

getDescriptor

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, needsToRunAfterFinalized, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectActions, perform, prebuild

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseNotifier

public BaseNotifier(String globalTarget,
                    String successfulTarget,
                    String brokenTarget,
                    String stillBrokenTarget,
                    String fixedTarget,
                    boolean sendIfSuccess,
                    String extraMessage)

Creates a new notifier based on the given parameters

Parameters:

globalTarget - the target for all notifications

successfulTarget - the target for build success notifications

brokenTarget - the target for broken build notifications

stillBrokenTarget - the target for still broken build notifications

fixedTarget - the target for fixed build notifications

sendIfSuccess - if the notification should be sent if the build succeed

extraMessage - the extra message

Method Detail

replaceEnvString

public String replaceEnvString(hudson.model.AbstractBuild build,
                               String message)

Replace Env variables to value.

Parameters:

build -

message -

Returns:

getGlobalTarget

public String getGlobalTarget()

getSuccessfulTarget

public String getSuccessfulTarget()

getBrokenTarget

public String getBrokenTarget()

getStillBrokenTarget

public String getStillBrokenTarget()

getFixedTarget

public String getFixedTarget()

isSendIfSuccess

public boolean isSendIfSuccess()

getExtraMessage

public String getExtraMessage()

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

perform

public boolean perform(hudson.model.AbstractBuild<?,?> build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)
                throws InterruptedException,
                       IOException

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Throws:

InterruptedException

IOException

createNotifier

protected BuildNotifier createNotifier(hudson.model.AbstractBuild<?,?> build,
                                       Message message)

createMessage

protected abstract Message createMessage(String target,
                                         hudson.model.AbstractBuild<?,?> build,
                                         hudson.Launcher launcher,
                                         hudson.model.BuildListener listener)

Creates the message for notifying users about the build. The parameters are the same passed to perform(AbstractBuild, Launcher, BuildListener) plus the target of the message.