Package 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

Fields

Modifier and Type	Field	Description
protected ImmutablePlan	plan
protected ResultsSummary	resultsSummary

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

NAVIGATION_SOURCE

Constructor Summary

Constructors

Constructor	Description
AbstractCompletedNotification(BranchStatusService branchStatusService, CachedPlanManager cachedPlanManager, VcsRepositoryViewerManager vcsRepositoryViewerManager, RepositoryDefinitionManager repositoryDefinitionManager, CustomVariableContext customVariableContext, ResultsSummaryManager resultsSummaryManager)

Method Summary

Modifier and Type	Method	Description
String	getCommitUrl(@NotNull RepositoryDataEntity repositoryDataEntity, String revision)
@NotNull String	getDescription()	Text describing this notification object - used for logging/debugging purposes.
@Nullable String	getEmailSubject()	Retrieves the subject for the notification.
protected abstract String	getEmailSubjectTemplate()
@Nullable String	getHtmlEmailContent()	Generates the html for the html part of an email notification.
protected abstract String	getHtmlEmailTemplate()
@Nullable String	getHtmlImContent()
protected String	getHtmlImTemplate()
@Nullable String	getIMContent()	Retrieves the content for the IM notification
protected abstract String	getImTemplate()
@Nullable String	getTextEmailContent()	Generates the text email content for the notifications
protected abstract String	getTextEmailTemplate()
void	init()
protected void	populateContext(Map<String,Object> context)
void	setResultsSummary(ResultsSummary resultsSummary)
void	setTemplateRenderer(TemplateRenderer templateRenderer)
void	setTriggerManager(TriggerManager triggerManager)
@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 Details

resultsSummary

protected ResultsSummary resultsSummary

plan

protected ImmutablePlan plan

Constructor Details

AbstractCompletedNotification

@Inject
public AbstractCompletedNotification(BranchStatusService branchStatusService,
 CachedPlanManager cachedPlanManager,
 VcsRepositoryViewerManager vcsRepositoryViewerManager,
 RepositoryDefinitionManager repositoryDefinitionManager,
 CustomVariableContext customVariableContext,
 ResultsSummaryManager resultsSummaryManager)

Method Details

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

getCommitUrl

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

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

setResultsSummary

public void setResultsSummary(ResultsSummary resultsSummary)

populateContext

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

getTextEmailTemplate

protected abstract String getTextEmailTemplate()

getHtmlEmailTemplate

protected abstract String getHtmlEmailTemplate()

getImTemplate

protected abstract String getImTemplate()

getEmailSubjectTemplate

protected abstract String getEmailSubjectTemplate()

getHtmlImTemplate

protected String getHtmlImTemplate()

setTemplateRenderer

public void setTemplateRenderer(TemplateRenderer templateRenderer)

setTriggerManager

public void setTriggerManager(TriggerManager triggerManager)