com.atlassian.bamboo.notification.buildcompleted
Class AbstractCompletedNotification

java.lang.Object
  com.atlassian.bamboo.notification.AbstractNotification
      com.atlassian.bamboo.notification.buildcompleted.AbstractCompletedNotification

All Implemented Interfaces:

ExtendedNotification, Notification, Notification.HtmlImContentProvidingNotification

Direct Known Subclasses:

BuildCompletedNotification, ChainCompletedNotification

public abstract class AbstractCompletedNotification
extends AbstractNotification
implements ExtendedNotification

Nested Class Summary

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

Notification.HtmlImContentProvidingNotification

Field Summary

protected Plan	plan
protected ResultsSummary	resultsSummary

Constructor Summary

AbstractCompletedNotification()

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.
protected abstract java.lang.String	getEmailSubjectTemplate()
java.lang.String	getHtmlEmailContent() Generates the html for the html part of an email notification.
protected abstract java.lang.String	getHtmlEmailTemplate()
java.lang.String	getHtmlImContent()
protected java.lang.String	getHtmlImTemplate()
java.lang.String	getIMContent() Retrieves the content for the IM notification
protected abstract java.lang.String	getImTemplate()
java.lang.String	getTextEmailContent() Generates the text email content for the notifications
protected abstract java.lang.String	getTextEmailTemplate()
void	init()
protected void	populateContext(java.util.Map<java.lang.String,java.lang.Object> context)
void	setPlanManager(PlanManager planManager)
void	setResultsSummaryManager(ResultsSummaryManager resultsSummaryManager)
void	setTemplateRenderer(TemplateRenderer templateRenderer)
void	setTriggerManager(TriggerManager triggerManager)
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, 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

resultsSummary

protected ResultsSummary resultsSummary

plan

protected Plan plan

Constructor Detail

AbstractCompletedNotification

public AbstractCompletedNotification()

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 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

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

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.

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

getHtmlImContent

@Nullable
public java.lang.String getHtmlImContent()

Specified by:

getHtmlImContent in interface Notification.HtmlImContentProvidingNotification

Overrides:

getHtmlImContent in class AbstractNotification

getEmailSubject

@Nullable
public java.lang.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(java.util.Map<java.lang.String,java.lang.Object> context)

getTextEmailTemplate

protected abstract java.lang.String getTextEmailTemplate()

getHtmlEmailTemplate

protected abstract java.lang.String getHtmlEmailTemplate()

getImTemplate

protected abstract java.lang.String getImTemplate()

getEmailSubjectTemplate

protected abstract java.lang.String getEmailSubjectTemplate()

getHtmlImTemplate

protected java.lang.String getHtmlImTemplate()

setTemplateRenderer

public void setTemplateRenderer(TemplateRenderer templateRenderer)

setPlanManager

public void setPlanManager(PlanManager planManager)

setResultsSummaryManager

public void setResultsSummaryManager(ResultsSummaryManager resultsSummaryManager)

setTriggerManager

public void setTriggerManager(TriggerManager triggerManager)