com.atlassian.bamboo.notification.chain
Class StageCompletedNotification

java.lang.Object
  com.atlassian.bamboo.notification.AbstractNotification
      com.atlassian.bamboo.notification.chain.StageCompletedNotification

All Implemented Interfaces:

Notification

@NotThreadSafe
public class StageCompletedNotification
extends AbstractNotification

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 - Chain
• chainExecution - ChainState

Field Summary

protected Chain	chain
protected ChainExecution	chainExecution
static java.lang.String	EMAIL_SUBJECT
static java.lang.String	HTML_EMAIL_TEMPLATE
static java.lang.String	IM_TEMPLATE
protected StageExecution	stageExecution
static java.lang.String	TEXT_EMAIL_TEMPLATE

Constructor Summary

StageCompletedNotification()

Method Summary

java.lang.String	getDescription() Text describing this notification object - used for logging/debugging purposes.
java.lang.String	getEmailSubject() Retrieves the subject for the notification.
java.lang.String	getHtmlEmailContent() Generates the html for the html part of an email notification.
java.lang.String	getIMContent() Retrieves the content for the IM notification
java.lang.String	getTextEmailContent() Generates the text email content for the notifications
void	init()
protected void	populateContext(java.util.Map<java.lang.String,java.lang.Object> context)
void	setPlanManager(PlanManager planManager)
void	setTemplateRenderer(TemplateRenderer templateRenderer)

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

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

Methods inherited from class java.lang.Object

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

Field Detail

TEXT_EMAIL_TEMPLATE

public static final java.lang.String TEXT_EMAIL_TEMPLATE

See Also:

Constant Field Values

HTML_EMAIL_TEMPLATE

public static final java.lang.String HTML_EMAIL_TEMPLATE

See Also:

Constant Field Values

IM_TEMPLATE

public static final java.lang.String IM_TEMPLATE

See Also:

Constant Field Values

EMAIL_SUBJECT

public static final java.lang.String EMAIL_SUBJECT

See Also:

Constant Field Values

chainExecution

protected ChainExecution chainExecution

stageExecution

protected StageExecution stageExecution

chain

protected Chain chain

Constructor Detail

StageCompletedNotification

public StageCompletedNotification()

Method Detail

getDescription

@NotNull
public java.lang.String getDescription()

Description copied from interface: Notification

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

Returns:

Notification's description

init

public void init()

getTextEmailContent

@Nullable
public java.lang.String getTextEmailContent()
                                     throws java.lang.Exception

Description copied from interface: Notification

Generates the text email content for the notifications

Returns:

Email content formatted as text for this notification

Throws:

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

getHtmlEmailContent

@Nullable
public java.lang.String getHtmlEmailContent()
                                     throws java.lang.Exception

Description copied from interface: Notification

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

Returns:

Email content formatted as HTML for this notification

Throws:

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

getIMContent

@Nullable
public java.lang.String getIMContent()

Description copied from interface: Notification

Retrieves the content for the IM notification

Returns:

IM message content for this notification

getEmailSubject

@Nullable
public java.lang.String getEmailSubject()

Description copied from interface: Notification

Retrieves the subject for the notification.

Returns:

Email subject for this notification

populateContext

protected void populateContext(java.util.Map<java.lang.String,java.lang.Object> context)

setTemplateRenderer

public void setTemplateRenderer(TemplateRenderer templateRenderer)

setPlanManager

public void setPlanManager(PlanManager planManager)