jenkins.plugins.hipchat

Class HipChatNotifier

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Publisher

hudson.tasks.Notifier

jenkins.plugins.hipchat.HipChatNotifier

All Implemented Interfaces:

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

public class HipChatNotifier
extends hudson.tasks.Notifier
implements hudson.matrix.MatrixAggregatable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HipChatNotifier.DescriptorImpl
static class	HipChatNotifier.HipChatJobProperty Deprecated. The plugin configuration should be stored in HipChatNotifier. This class only exists, so configurations can be migrated for the build jobs.

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
HipChatNotifier(String credentialId, String room, List<NotificationConfig> notifications, MatrixTriggerMode matrixTriggerMode, String startJobMessage, String completeJobMessage)

Method Summary

Modifier and Type	Method and Description
hudson.matrix.MatrixAggregator	createAggregator(hudson.matrix.MatrixBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener)
String	getCompleteJobMessage()
String	getCredentialId()
HipChatNotifier.DescriptorImpl	getDescriptor()
static HipChatService	getHipChatService(String server, String token, boolean v2Enabled, String room, String sendAs) Obtains a HipChatService implementation corresponding to the provided settings.
MatrixTriggerMode	getMatrixTriggerMode()
List<NotificationConfig>	getNotifications()
hudson.tasks.BuildStepMonitor	getRequiredMonitorService()
String	getResolvedRoom(hudson.model.AbstractBuild<?,?> build) Return the room name defined in the job configuration, or if that's empty return the room name from the global configuration.
String	getRoom()
String	getStartJobMessage()
String	getToken()
static String	migrateMessageTemplate(String oldMessageTemplate)
boolean	needsToRunAfterFinalized()
boolean	perform(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener)
boolean	prebuild(hudson.model.AbstractBuild<?,?> build, hudson.model.BuildListener listener)
Object	readResolve()
void	setCompleteJobMessage(String completeJobMessage)
void	setCredentialId(String credentialId)
void	setMatrixTriggerMode(MatrixTriggerMode matrixTriggerMode)
void	setNotifications(List<NotificationConfig> notifications)
void	setNotifyAborted(boolean notifyAborted)
void	setNotifyBackToNormal(boolean notifyBackToNormal)
void	setNotifyFailure(boolean notifyFailure)
void	setNotifyNotBuilt(boolean notifyNotBuilt)
void	setNotifySuccess(boolean notifySuccess)
void	setNotifyUnstable(boolean notifyUnstable)
void	setRoom(String room)
void	setStartJobMessage(String startJobMessage)
void	setStartNotification(boolean startNotification)
void	setToken(String token)

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

Constructor Detail

HipChatNotifier

@DataBoundConstructor
public HipChatNotifier(String credentialId,
                                             String room,
                                             List<NotificationConfig> notifications,
                                             MatrixTriggerMode matrixTriggerMode,
                                             String startJobMessage,
                                             String completeJobMessage)

Method Detail

getCredentialId

public String getCredentialId()

setCredentialId

public void setCredentialId(String credentialId)

setStartNotification

public void setStartNotification(boolean startNotification)

setNotifySuccess

public void setNotifySuccess(boolean notifySuccess)

setNotifyAborted

public void setNotifyAborted(boolean notifyAborted)

setNotifyNotBuilt

public void setNotifyNotBuilt(boolean notifyNotBuilt)

setNotifyUnstable

public void setNotifyUnstable(boolean notifyUnstable)

setNotifyFailure

public void setNotifyFailure(boolean notifyFailure)

setNotifyBackToNormal

public void setNotifyBackToNormal(boolean notifyBackToNormal)

getMatrixTriggerMode

public MatrixTriggerMode getMatrixTriggerMode()

setMatrixTriggerMode

public void setMatrixTriggerMode(MatrixTriggerMode matrixTriggerMode)

setNotifications

public void setNotifications(List<NotificationConfig> notifications)

getNotifications

public List<NotificationConfig> getNotifications()

getStartJobMessage

public String getStartJobMessage()

setStartJobMessage

public void setStartJobMessage(String startJobMessage)

getCompleteJobMessage

public String getCompleteJobMessage()

setCompleteJobMessage

public void setCompleteJobMessage(String completeJobMessage)

getRoom

public String getRoom()

setRoom

public void setRoom(String room)

readResolve

public Object readResolve()

getResolvedRoom

public String getResolvedRoom(hudson.model.AbstractBuild<?,?> build)

Return the room name defined in the job configuration, or if that's empty return the room name from the global configuration. If the room name is parameterized, this will also try to resolve those parameters.

Parameters:

build - The current build for which we need to get the room.

Returns:

The room name tied to the current build.

getToken

public String getToken()

setToken

public void setToken(String token)

getDescriptor

public HipChatNotifier.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Publisher>

Overrides:

getDescriptor in class hudson.tasks.Notifier

needsToRunAfterFinalized

public boolean needsToRunAfterFinalized()

Overrides:

needsToRunAfterFinalized in class hudson.tasks.Publisher

getRequiredMonitorService

public hudson.tasks.BuildStepMonitor getRequiredMonitorService()

Specified by:

getRequiredMonitorService in interface hudson.tasks.BuildStep

prebuild

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

Specified by:

prebuild in interface hudson.tasks.BuildStep

Overrides:

prebuild in class hudson.tasks.BuildStepCompatibilityLayer

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

migrateMessageTemplate

public static String migrateMessageTemplate(String oldMessageTemplate)

getHipChatService

public static HipChatService getHipChatService(String server,
                                               String token,
                                               boolean v2Enabled,
                                               String room,
                                               String sendAs)

Obtains a HipChatService implementation corresponding to the provided settings.

Parameters:

server - The URL for the HipChat server.

token - The auth token to use when sending the notification.

v2Enabled - Whether v1 or v2 API should be used.

room - The room to notify.

sendAs - The username to use as the sender when using the v1 API.

Returns:

An API version specific HipChatService instance.

createAggregator

public hudson.matrix.MatrixAggregator createAggregator(hudson.matrix.MatrixBuild build,
                                                       hudson.Launcher launcher,
                                                       hudson.model.BuildListener listener)

Specified by:

createAggregator in interface hudson.matrix.MatrixAggregatable