com.atlassian.bamboo.notification.chain

Class AfterXFailedNotification

java.lang.Object

com.atlassian.bamboo.notification.AbstractNotification

com.atlassian.bamboo.notification.chain.AfterXFailedNotification

All Implemented Interfaces:

ExtendedNotification, Notification, Notification.HtmlImContentProvidingNotification

@NotThreadSafe
public class AfterXFailedNotification
extends AbstractNotification
implements ExtendedNotification

This class is used to generate content for After X Failed Bulid 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:

• buildSummary - ResultsSummary
• build - ImmutablePlan
• numFailures - Number of times the build has failed so far
• firstFailedBuildSummary - ResultsSummary of the first build that failed
• triggerReasonDescription - String description of the trigger reason for this build (html for html emails, plain text for text emails)
• firstFailedTriggerReasonDescription - String description of the trigger reason for the first build that failed (html for html emails, plain text for text emails)

Nested Class Summary

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

Notification.HtmlImContentProvidingNotification

Field Summary

Fields

Modifier and Type	Field and Description
static String	HTML_EMAIL_TEMPLATE
static String	HTML_IM_TEMPLATE
static String	IM_TEMPLATE
static String	SUBJECT_TEMPLATE
static String	TEXT_EMAIL_TEMPLATE

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

NAVIGATION_SOURCE

Constructor Summary

Constructors

Constructor and Description
AfterXFailedNotification()

Method Summary

Modifier and Type	Method and Description
String	getCommitUrl(RepositoryDataEntity repositoryDataEntity, String revision)
String	getDescription() Text describing this notification object - used for logging/debugging purposes.
String	getEmailSubject() Retrieves the subject for the notification.
String	getHtmlEmailContent() Generates the html for the html part of an email notification.
String	getHtmlImContent()
String	getIMContent() Retrieves the content for the IM notification
String	getTextEmailContent() Generates the text email content for the notifications
void	init()
void	setPlan(ImmutablePlan plan)
void	setResultsSummary(ResultsSummary resultSummary)
com.atlassian.mail.Email	updateEmail(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

HTML_EMAIL_TEMPLATE

public static final String HTML_EMAIL_TEMPLATE

See Also:

Constant Field Values

TEXT_EMAIL_TEMPLATE

public static final String TEXT_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

SUBJECT_TEMPLATE

public static final String SUBJECT_TEMPLATE

See Also:

Constant Field Values

Constructor Detail

AfterXFailedNotification

public AfterXFailedNotification()

Method Detail

updateEmail

@NotNull
public com.atlassian.mail.Email updateEmail(@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 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 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 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 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 String getHtmlImContent()

Specified by:

getHtmlImContent in interface Notification.HtmlImContentProvidingNotification

Overrides:

getHtmlImContent in class AbstractNotification

getEmailSubject

public 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

getCommitUrl

public String getCommitUrl(@NotNull
                           RepositoryDataEntity repositoryDataEntity,
                           String revision)

setPlan

public void setPlan(@Nullable
                    ImmutablePlan plan)

setResultsSummary

public void setResultsSummary(@Nullable
                              ResultsSummary resultSummary)