jenkins.plugins.slack

Class SlackNotifier

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Notifier

jenkins.plugins.slack.SlackNotifier

All Implemented Interfaces:

ExtensionPoint, Describable<Publisher>, BuildStep

public class SlackNotifier
extends Notifier

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SlackNotifier.DescriptorImpl

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

Publisher.DescriptorExtensionListImpl

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

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

BuildStep.PublisherList

Field Summary

Fields

Modifier and Type	Field and Description
static String	MATRIX_PROJECT_CLASS_NAME
static String	MATRIX_RUN_CLASS_NAME

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
SlackNotifier(CommitInfoChoice commitInfoChoice)
SlackNotifier(String baseUrl, String teamDomain, String authToken, boolean botUser, String room, String tokenCredentialId, String sendAs, boolean startNotification, boolean notifyAborted, boolean notifyFailure, boolean notifyNotBuilt, boolean notifySuccess, boolean notifyUnstable, boolean notifyRegression, boolean notifyBackToNormal, boolean notifyRepeatedFailure, boolean includeTestSummary, boolean includeFailedTests, CommitInfoChoice commitInfoChoice, boolean includeCustomMessage, String customMessage) Deprecated.
SlackNotifier(String baseUrl, String teamDomain, String authToken, boolean botUser, String room, String tokenCredentialId, String sendAs, boolean startNotification, boolean notifyAborted, boolean notifyFailure, boolean notifyNotBuilt, boolean notifySuccess, boolean notifyUnstable, boolean notifyRegression, boolean notifyBackToNormal, boolean notifyRepeatedFailure, boolean includeTestSummary, boolean includeFailedTests, CommitInfoChoice commitInfoChoice, boolean includeCustomMessage, String customMessage, String customMessageSuccess, String customMessageAborted, String customMessageNotBuilt, String customMessageUnstable, String customMessageFailure) Deprecated.
SlackNotifier(String baseUrl, String teamDomain, String authToken, boolean botUser, String room, String tokenCredentialId, String sendAs, boolean startNotification, boolean notifyAborted, boolean notifyFailure, boolean notifyNotBuilt, boolean notifySuccess, boolean notifyUnstable, boolean notifyRegression, boolean notifyBackToNormal, boolean notifyRepeatedFailure, boolean includeTestSummary, boolean includeFailedTests, MatrixTriggerMode matrixTriggerMode, CommitInfoChoice commitInfoChoice, boolean includeCustomMessage, String customMessage, String customMessageSuccess, String customMessageAborted, String customMessageNotBuilt, String customMessageUnstable, String customMessageFailure) Deprecated.

Method Summary

Modifier and Type	Method and Description
static SlackNotifierBuilder	builder()
String	getArtifactIncludes()
String	getAuthToken()
String	getAuthTokenCredentialId()
String	getBaseUrl()
boolean	getBotUser()
CommitInfoChoice	getCommitInfoChoice()
String	getCustomMessage()
String	getCustomMessageAborted()
String	getCustomMessageFailure()
String	getCustomMessageNotBuilt()
String	getCustomMessageSuccess()
String	getCustomMessageUnstable()
SlackNotifier.DescriptorImpl	getDescriptor()
String	getIconEmoji()
boolean	getIncludeCustomMessage()
boolean	getIncludeFailedTests()
boolean	getIncludeTestSummary()
MatrixTriggerMode	getMatrixTriggerMode()
boolean	getNotifyAborted()
boolean	getNotifyBackToNormal()
boolean	getNotifyEveryFailure()
boolean	getNotifyFailure()
boolean	getNotifyNotBuilt()
boolean	getNotifyRegression()
boolean	getNotifyRepeatedFailure()
boolean	getNotifySuccess()
boolean	getNotifyUnstable()
BuildStepMonitor	getRequiredMonitorService()
String	getRoom()
String	getSendAs()
boolean	getSendAsText()
SlackUserIdResolver	getSlackUserIdResolver()
boolean	getStartNotification()
String	getTeamDomain()
String	getTokenCredentialId()
boolean	getUploadFiles()
String	getUsername()
boolean	isAnyCustomMessagePopulated()
boolean	isMatrixRun(AbstractBuild<?,?> build)
boolean	needsToRunAfterFinalized()
SlackService	newSlackService(AbstractBuild abstractBuild, BuildListener listener)
boolean	perform(AbstractBuild<?,?> build, Launcher launcher, BuildListener listener)
boolean	prebuild(AbstractBuild<?,?> build, BuildListener listener)
void	setArtifactIncludes(String artifactIncludes)
void	setAuthToken(String authToken)
void	setBaseUrl(String baseUrl)
void	setBotUser(boolean botUser)
void	setCommitInfoChoice(CommitInfoChoice commitInfoChoice)
void	setCustomMessage(String customMessage)
void	setCustomMessageAborted(String customMessageAborted)
void	setCustomMessageFailure(String customMessageFailure)
void	setCustomMessageNotBuilt(String customMessageNotBuilt)
void	setCustomMessageSuccess(String customMessageSuccess)
void	setCustomMessageUnstable(String customMessageUnstable)
void	setIconEmoji(String iconEmoji)
void	setIncludeCustomMessage(boolean includeCustomMessage)
void	setIncludeFailedTests(boolean includeFailedTests)
void	setIncludeTestSummary(boolean includeTestSummary)
void	setMatrixTriggerMode(MatrixTriggerMode matrixTriggerMode)
void	setNotifyAborted(boolean notifyAborted)
void	setNotifyBackToNormal(boolean notifyBackToNormal)
void	setNotifyEveryFailure(boolean notifyEveryFailure)
void	setNotifyFailure(boolean notifyFailure)
void	setNotifyNotBuilt(boolean notifyNotBuilt)
void	setNotifyRegression(boolean notifyRegression)
void	setNotifyRepeatedFailure(boolean notifyRepeatedFailure)
void	setNotifySuccess(boolean notifySuccess)
void	setNotifyUnstable(boolean notifyUnstable)
void	setRoom(String room)
void	setSendAs(String sendAs)
void	setSendAsText(boolean sendAsText)
void	setSlackUserIdResolver(SlackUserIdResolver slackUserIdResolver)
void	setStartNotification(boolean startNotification)
void	setTeamDomain(String teamDomain)
void	setTokenCredentialId(String tokenCredentialId)
void	setUploadFiles(boolean uploadFiles)
void	setUsername(String username)

Methods inherited from class hudson.tasks.Publisher

all, getProjectAction, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectActions, perform

Methods inherited from class java.lang.Object

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

Field Detail

MATRIX_PROJECT_CLASS_NAME

public static final String MATRIX_PROJECT_CLASS_NAME

See Also:

Constant Field Values

MATRIX_RUN_CLASS_NAME

public static final String MATRIX_RUN_CLASS_NAME

See Also:

Constant Field Values

Constructor Detail

SlackNotifier

@DataBoundConstructor
public SlackNotifier(CommitInfoChoice commitInfoChoice)

SlackNotifier

@Deprecated
public SlackNotifier(String baseUrl,
                                 String teamDomain,
                                 String authToken,
                                 boolean botUser,
                                 String room,
                                 String tokenCredentialId,
                                 String sendAs,
                                 boolean startNotification,
                                 boolean notifyAborted,
                                 boolean notifyFailure,
                                 boolean notifyNotBuilt,
                                 boolean notifySuccess,
                                 boolean notifyUnstable,
                                 boolean notifyRegression,
                                 boolean notifyBackToNormal,
                                 boolean notifyRepeatedFailure,
                                 boolean includeTestSummary,
                                 boolean includeFailedTests,
                                 CommitInfoChoice commitInfoChoice,
                                 boolean includeCustomMessage,
                                 String customMessage)

Deprecated.

SlackNotifier

@Deprecated
public SlackNotifier(String baseUrl,
                                 String teamDomain,
                                 String authToken,
                                 boolean botUser,
                                 String room,
                                 String tokenCredentialId,
                                 String sendAs,
                                 boolean startNotification,
                                 boolean notifyAborted,
                                 boolean notifyFailure,
                                 boolean notifyNotBuilt,
                                 boolean notifySuccess,
                                 boolean notifyUnstable,
                                 boolean notifyRegression,
                                 boolean notifyBackToNormal,
                                 boolean notifyRepeatedFailure,
                                 boolean includeTestSummary,
                                 boolean includeFailedTests,
                                 CommitInfoChoice commitInfoChoice,
                                 boolean includeCustomMessage,
                                 String customMessage,
                                 String customMessageSuccess,
                                 String customMessageAborted,
                                 String customMessageNotBuilt,
                                 String customMessageUnstable,
                                 String customMessageFailure)

Deprecated.

SlackNotifier

@Deprecated
public SlackNotifier(String baseUrl,
                                 String teamDomain,
                                 String authToken,
                                 boolean botUser,
                                 String room,
                                 String tokenCredentialId,
                                 String sendAs,
                                 boolean startNotification,
                                 boolean notifyAborted,
                                 boolean notifyFailure,
                                 boolean notifyNotBuilt,
                                 boolean notifySuccess,
                                 boolean notifyUnstable,
                                 boolean notifyRegression,
                                 boolean notifyBackToNormal,
                                 boolean notifyRepeatedFailure,
                                 boolean includeTestSummary,
                                 boolean includeFailedTests,
                                 MatrixTriggerMode matrixTriggerMode,
                                 CommitInfoChoice commitInfoChoice,
                                 boolean includeCustomMessage,
                                 String customMessage,
                                 String customMessageSuccess,
                                 String customMessageAborted,
                                 String customMessageNotBuilt,
                                 String customMessageUnstable,
                                 String customMessageFailure)

Deprecated.

Method Detail

getAuthTokenCredentialId

public String getAuthTokenCredentialId()

getDescriptor

public SlackNotifier.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface Describable<Publisher>

Overrides:

getDescriptor in class Notifier

getBaseUrl

public String getBaseUrl()

getTeamDomain

public String getTeamDomain()

setTeamDomain

@DataBoundSetter
public void setTeamDomain(String teamDomain)

getRoom

public String getRoom()

setRoom

@DataBoundSetter
public void setRoom(String room)

getAuthToken

public String getAuthToken()

setAuthToken

@DataBoundSetter
public void setAuthToken(String authToken)

getTokenCredentialId

public String getTokenCredentialId()

setTokenCredentialId

@DataBoundSetter
public void setTokenCredentialId(String tokenCredentialId)

getBotUser

public boolean getBotUser()

setBotUser

@DataBoundSetter
public void setBotUser(boolean botUser)

getSendAs

public String getSendAs()

setSendAs

@DataBoundSetter
public void setSendAs(String sendAs)

getSendAsText

public boolean getSendAsText()

setSendAsText

@DataBoundSetter
public void setSendAsText(boolean sendAsText)

getIconEmoji

public String getIconEmoji()

setIconEmoji

@DataBoundSetter
public void setIconEmoji(String iconEmoji)

getUsername

public String getUsername()

setUsername

@DataBoundSetter
public void setUsername(String username)

getStartNotification

public boolean getStartNotification()

getNotifySuccess

public boolean getNotifySuccess()

getCommitInfoChoice

public CommitInfoChoice getCommitInfoChoice()

getMatrixTriggerMode

@CheckForNull
public MatrixTriggerMode getMatrixTriggerMode()

getNotifyAborted

public boolean getNotifyAborted()

getNotifyFailure

public boolean getNotifyFailure()

getNotifyEveryFailure

public boolean getNotifyEveryFailure()

getNotifyNotBuilt

public boolean getNotifyNotBuilt()

getNotifyUnstable

public boolean getNotifyUnstable()

getNotifyRegression

public boolean getNotifyRegression()

getNotifyBackToNormal

public boolean getNotifyBackToNormal()

getIncludeTestSummary

public boolean getIncludeTestSummary()

getIncludeFailedTests

public boolean getIncludeFailedTests()

getUploadFiles

public boolean getUploadFiles()

getArtifactIncludes

public String getArtifactIncludes()

getNotifyRepeatedFailure

public boolean getNotifyRepeatedFailure()

getIncludeCustomMessage

public boolean getIncludeCustomMessage()

getCustomMessage

public String getCustomMessage()

getCustomMessageSuccess

public String getCustomMessageSuccess()

getCustomMessageAborted

public String getCustomMessageAborted()

getCustomMessageNotBuilt

public String getCustomMessageNotBuilt()

getCustomMessageUnstable

public String getCustomMessageUnstable()

getCustomMessageFailure

public String getCustomMessageFailure()

getSlackUserIdResolver

public SlackUserIdResolver getSlackUserIdResolver()

setBaseUrl

@DataBoundSetter
public void setBaseUrl(String baseUrl)

setStartNotification

@DataBoundSetter
public void setStartNotification(boolean startNotification)

setNotifySuccess

@DataBoundSetter
public void setNotifySuccess(boolean notifySuccess)

setCommitInfoChoice

@DataBoundSetter
public void setCommitInfoChoice(CommitInfoChoice commitInfoChoice)

setMatrixTriggerMode

@DataBoundSetter
public void setMatrixTriggerMode(MatrixTriggerMode matrixTriggerMode)

setNotifyAborted

@DataBoundSetter
public void setNotifyAborted(boolean notifyAborted)

setNotifyFailure

@DataBoundSetter
public void setNotifyFailure(boolean notifyFailure)

setNotifyEveryFailure

@DataBoundSetter
public void setNotifyEveryFailure(boolean notifyEveryFailure)

setNotifyNotBuilt

@DataBoundSetter
public void setNotifyNotBuilt(boolean notifyNotBuilt)

setNotifyUnstable

@DataBoundSetter
public void setNotifyUnstable(boolean notifyUnstable)

setNotifyRegression

@DataBoundSetter
public void setNotifyRegression(boolean notifyRegression)

setNotifyBackToNormal

@DataBoundSetter
public void setNotifyBackToNormal(boolean notifyBackToNormal)

setIncludeTestSummary

@DataBoundSetter
public void setIncludeTestSummary(boolean includeTestSummary)

setIncludeFailedTests

@DataBoundSetter
public void setIncludeFailedTests(boolean includeFailedTests)

setUploadFiles

@DataBoundSetter
public void setUploadFiles(boolean uploadFiles)

setArtifactIncludes

@DataBoundSetter
public void setArtifactIncludes(String artifactIncludes)

setNotifyRepeatedFailure

@DataBoundSetter
public void setNotifyRepeatedFailure(boolean notifyRepeatedFailure)

setIncludeCustomMessage

@DataBoundSetter
public void setIncludeCustomMessage(boolean includeCustomMessage)

setCustomMessage

@DataBoundSetter
public void setCustomMessage(String customMessage)

setCustomMessageSuccess

@DataBoundSetter
public void setCustomMessageSuccess(String customMessageSuccess)

setCustomMessageAborted

@DataBoundSetter
public void setCustomMessageAborted(String customMessageAborted)

setCustomMessageNotBuilt

@DataBoundSetter
public void setCustomMessageNotBuilt(String customMessageNotBuilt)

setCustomMessageUnstable

@DataBoundSetter
public void setCustomMessageUnstable(String customMessageUnstable)

setCustomMessageFailure

@DataBoundSetter
public void setCustomMessageFailure(String customMessageFailure)

setSlackUserIdResolver

@DataBoundSetter
public void setSlackUserIdResolver(SlackUserIdResolver slackUserIdResolver)

builder

public static SlackNotifierBuilder builder()

isAnyCustomMessagePopulated

public boolean isAnyCustomMessagePopulated()

getRequiredMonitorService

public BuildStepMonitor getRequiredMonitorService()

newSlackService

public SlackService newSlackService(AbstractBuild abstractBuild,
                                    BuildListener listener)

needsToRunAfterFinalized

public boolean needsToRunAfterFinalized()

Overrides:

needsToRunAfterFinalized in class Publisher

perform

public boolean perform(AbstractBuild<?,?> build,
                       Launcher launcher,
                       BuildListener listener)

Specified by:

perform in interface BuildStep

Overrides:

perform in class BuildStepCompatibilityLayer

prebuild

public boolean prebuild(AbstractBuild<?,?> build,
                        BuildListener listener)

Specified by:

prebuild in interface BuildStep

Overrides:

prebuild in class BuildStepCompatibilityLayer

isMatrixRun

public boolean isMatrixRun(AbstractBuild<?,?> build)