Package com.atlassian.bamboo.notification.chain

Class StageCompletedNotification

java.lang.Object

com.atlassian.bamboo.notification.AbstractNotification

com.atlassian.bamboo.notification.chain.StageCompletedNotification

All Implemented Interfaces:

ExtendedNotification, Notification, Notification.HtmlImContentProvidingNotification

@NotThreadSafe
public class StageCompletedNotification
extends AbstractNotification
implements ExtendedNotification

This class is used to generate content for All Completed Chain Stage Notifications and the Failed And First Successful Chain Stage Notifications. If you wish to customise the default notifications, please see the online Bamboo documentation: http://confluence.atlassian.com/display/BAMBOO/Modifying+Notification+Templates

The notification templates are written in Freemarker markup. The object context below provides information about Bamboo builds that you can insert in the Freemarker markup of your notification templates.

Object Context:

• chain - ImmutableChain
• chainExecution - ChainState

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.bamboo.notification.Notification

Notification.HtmlImContentProvidingNotification

Field Summary

Fields

Modifier and Type	Field	Description
protected ImmutableChain	chain
protected ChainExecution	chainExecution
static String	EMAIL_SUBJECT
static String	HTML_EMAIL_TEMPLATE
static String	HTML_IM_TEMPLATE
static String	IM_TEMPLATE
protected StageExecution	stageExecution
static String	TEXT_EMAIL_TEMPLATE

Fields inherited from class com.atlassian.bamboo.notification.AbstractNotification

NAVIGATION_SOURCE

Constructor Summary

Constructors

Constructor	Description
StageCompletedNotification()

Method Summary

Modifier and Type	Method	Description
@NotNull String	getDescription()	Text describing this notification object - used for logging/debugging purposes.
@Nullable String	getEmailSubject()	Retrieves the subject for the notification.
@Nullable String	getHtmlEmailContent()	Generates the html for the html part of an email notification.
@Nullable String	getHtmlImContent()
@Nullable String	getIMContent()	Retrieves the content for the IM notification
@Nullable String	getTextEmailContent()	Generates the text email content for the notifications
void	init()
protected void	populateContext(Map<String,Object> context)
@NotNull com.atlassian.mail.Email	updateEmail(@NotNull com.atlassian.mail.Email email)	Provides an email object after being populated with content from the Notification and Bamboo's defaults This email may be a text email, html email or a Multipart email

Methods inherited from class com.atlassian.bamboo.notification.AbstractNotification

addRecipient, applyDefaultCssStyles, excludeRecipient, getCommitUrl, getEvent, getExcludedNotificationRecipients, getNotificationRecipients, getPojoEvent, getRepositoryData, getRepositoryData, setEvent, setEvent, setExcludedNotificationRecipients, setNotificationRecipients

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.bamboo.notification.Notification

addRecipient, applyDefaultCssStyles, excludeRecipient, getEvent, getExcludedNotificationRecipients, getNotificationRecipients, getPojoEvent, setEvent, setEvent, setExcludedNotificationRecipients, setNotificationRecipients

Field Detail

TEXT_EMAIL_TEMPLATE

public static final String TEXT_EMAIL_TEMPLATE

See Also:

Constant Field Values

HTML_EMAIL_TEMPLATE

public static final String HTML_EMAIL_TEMPLATE

See Also:

Constant Field Values

IM_TEMPLATE

public static final String IM_TEMPLATE

See Also:

Constant Field Values

HTML_IM_TEMPLATE

public static final String HTML_IM_TEMPLATE

See Also:

Constant Field Values

EMAIL_SUBJECT

public static final String EMAIL_SUBJECT

See Also:

Constant Field Values

chainExecution

protected ChainExecution chainExecution

stageExecution

protected StageExecution stageExecution

chain

protected ImmutableChain chain

Constructor Detail

StageCompletedNotification

public StageCompletedNotification()

Method Detail

updateEmail

@NotNull
public @NotNull com.atlassian.mail.Email updateEmail(@NotNull
                                                     @NotNull com.atlassian.mail.Email email)

Description copied from interface: ExtendedNotification

Provides an email object after being populated with content from the Notification and Bamboo's defaults This email may be a text email, html email or a Multipart email

Specified by:

updateEmail in interface ExtendedNotification

Returns:

The email objected updated with anyt further information / changes required.

getDescription

@NotNull
public @NotNull String getDescription()

Description copied from interface: Notification

Text describing this notification object - used for logging/debugging purposes.

Specified by:

getDescription in interface Notification

Returns:

Notification's description

init

public void init()

getTextEmailContent

@Nullable
public @Nullable String getTextEmailContent()
                                     throws Exception

Description copied from interface: Notification

Generates the text email content for the notifications

Specified by:

getTextEmailContent in interface Notification

Returns:

Email content formatted as text for this notification

Throws:

Exception - if there is a problem preventing production of the e-mail content.

getHtmlEmailContent

@Nullable
public @Nullable String getHtmlEmailContent()
                                     throws Exception

Description copied from interface: Notification

Generates the html for the html part of an email notification.

Specified by:

getHtmlEmailContent in interface Notification

Returns:

Email content formatted as HTML for this notification

Throws:

Exception - if there is a problem preventing production of the e-mail content.

getIMContent

@Nullable
public @Nullable String getIMContent()

Description copied from interface: Notification

Retrieves the content for the IM notification

Specified by:

getIMContent in interface Notification

Returns:

IM message content for this notification

getHtmlImContent

@Nullable
public @Nullable String getHtmlImContent()

Specified by:

getHtmlImContent in interface Notification.HtmlImContentProvidingNotification

Overrides:

getHtmlImContent in class AbstractNotification

getEmailSubject

@Nullable
public @Nullable String getEmailSubject()

Description copied from interface: Notification

Retrieves the subject for the notification.

Specified by:

getEmailSubject in interface Notification

Returns:

Email subject for this notification

populateContext

protected void populateContext(Map<String,Object> context)