Package com.atlassian.bamboo.notification.buildcompleted

Class BuildCompletedNotification

java.lang.Object

com.atlassian.bamboo.notification.AbstractNotification

com.atlassian.bamboo.notification.buildcompleted.AbstractCompletedNotification

com.atlassian.bamboo.notification.buildcompleted.BuildCompletedNotification

All Implemented Interfaces:

CommitUrlProvider, ExtendedNotification, Notification, Notification.HtmlImContentProvidingNotification

@NotThreadSafe
public class BuildCompletedNotification
extends AbstractCompletedNotification

This class is used to generate content for All Completed Builds Notifications, the Failed And First Successful Notifications and First Failed Job 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
• buildResult - BuildResults
• build - Plan
• jiraIssues - List of LinkedJiraIssue containing details from JIRA server if available
• triggerReasonDescription - String description of the trigger reason for this build (html for html emails, plain text for text emails)
• shortErrorSummary - List of String containing a truncated version of the build's error summary

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

Fields inherited from class com.atlassian.bamboo.notification.buildcompleted.AbstractCompletedNotification

plan, resultsSummary

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

NAVIGATION_SOURCE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
@NotNull String	getDescription()	Text describing this notification object - used for logging/debugging purposes.
protected String	getEmailSubjectTemplate()
protected String	getHtmlEmailTemplate()
protected String	getHtmlImTemplate()
protected String	getImTemplate()
protected String	getTextEmailTemplate()
void	init()
protected void	populateContext(Map<String,Object> context)

Methods inherited from class com.atlassian.bamboo.notification.buildcompleted.AbstractCompletedNotification

getCommitUrl, getEmailSubject, getHtmlEmailContent, getHtmlImContent, getIMContent, getTextEmailContent, setResultsSummary, setTemplateRenderer, setTriggerManager, updateEmail

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

addRecipient, applyDefaultCssStyles, excludeRecipient, getCommitUrl, getEvent, getExcludedNotificationRecipients, getNotificationRecipients, getPojoEvent, 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

buildResults

protected BuildResults buildResults

Constructor Details

BuildCompletedNotification

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

Method Details

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

Overrides:

getDescription in class AbstractCompletedNotification

Returns:

Notification's description

init

public void init()

Overrides:

init in class AbstractCompletedNotification

populateContext

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

Overrides:

populateContext in class AbstractCompletedNotification

getTextEmailTemplate

protected String getTextEmailTemplate()

Specified by:

getTextEmailTemplate in class AbstractCompletedNotification

getHtmlEmailTemplate

protected String getHtmlEmailTemplate()

Specified by:

getHtmlEmailTemplate in class AbstractCompletedNotification

getImTemplate

protected String getImTemplate()

Specified by:

getImTemplate in class AbstractCompletedNotification

getEmailSubjectTemplate

protected String getEmailSubjectTemplate()

Specified by:

getEmailSubjectTemplate in class AbstractCompletedNotification

getHtmlImTemplate

protected String getHtmlImTemplate()

Overrides:

getHtmlImTemplate in class AbstractCompletedNotification