com.atlassian.bamboo.notification.buildcommented
Class CommentNotification

java.lang.Object
  com.atlassian.bamboo.notification.AbstractNotification
      com.atlassian.bamboo.notification.buildcommented.CommentNotification

All Implemented Interfaces:

ExtendedNotification, Notification

@NotThreadSafe
public class CommentNotification
extends AbstractNotification
implements ExtendedNotification

This class is used to generate content for Build Commented 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 - Plan
• plan - Plan
• addedComment - Comment The comment which was just added
• comments - List All comments on this build

Field Summary

static java.lang.String	HTML_EMAIL_TEMPLATE
static java.lang.String	IM_TEMPLATE
static java.lang.String	TEXT_EMAIL_TEMPLATE

Constructor Summary

CommentNotification()

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	setPlanManager(PlanManager planManager)
void	setResultsSummaryManager(ResultsSummaryManager resultsSummaryManager)
void	setTemplateRenderer(TemplateRenderer templateRenderer)
com.atlassian.mail.Email	updateEmail(com.atlassian.mail.Email email) Sets the email from-name to the user that wrote the comment (if the user exists)

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

addRecipient, excludeRecipient, getEvent, getExcludedNotificationRecipients, getNotificationRecipients, getRepositoryData, getRepositoryData, 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, excludeRecipient, getEvent, getExcludedNotificationRecipients, getNotificationRecipients, setEvent, setExcludedNotificationRecipients, setNotificationRecipients

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

Constructor Detail

CommentNotification

public CommentNotification()

Method Detail

getDescription

@NotNull
public java.lang.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

getTextEmailContent

@Nullable
public java.lang.String getTextEmailContent()
                                     throws java.lang.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:

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.

Specified by:

getHtmlEmailContent in interface 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.

getEmailSubject

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

Description copied from interface: Notification

Retrieves the subject for the notification.

Specified by:

getEmailSubject in interface Notification

Returns:

Email subject for this notification

Throws:

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

getIMContent

@Nullable
public java.lang.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

updateEmail

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

Sets the email from-name to the user that wrote the comment (if the user exists)

Specified by:

updateEmail in interface ExtendedNotification

Parameters:

email - - prepopulated email

Returns:

email with updated from-name

setPlanManager

public void setPlanManager(PlanManager planManager)

setResultsSummaryManager

public void setResultsSummaryManager(ResultsSummaryManager resultsSummaryManager)

setTemplateRenderer

public void setTemplateRenderer(TemplateRenderer templateRenderer)