com.atlassian.bamboo.notification.buildcompleted
Class BuildCompletedNotification

java.lang.Object
  extended by com.atlassian.bamboo.notification.AbstractNotification
      extended by com.atlassian.bamboo.notification.buildcompleted.AbstractCompletedNotification
          extended by com.atlassian.bamboo.notification.buildcompleted.BuildCompletedNotification
All Implemented Interfaces:
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:


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.atlassian.bamboo.notification.Notification
Notification.HtmlImContentProvidingNotification
 
Field Summary
 
Fields inherited from class com.atlassian.bamboo.notification.buildcompleted.AbstractCompletedNotification
plan, resultsSummary
 
Constructor Summary
BuildCompletedNotification()
           
 
Method Summary
 java.lang.String getDescription()
          Text describing this notification object - used for logging/debugging purposes.
protected  java.lang.String getEmailSubjectTemplate()
           
protected  java.lang.String getHtmlEmailTemplate()
           
protected  java.lang.String getHtmlImTemplate()
           
protected  java.lang.String getImTemplate()
           
protected  java.lang.String getTextEmailTemplate()
           
 void init()
           
protected  void populateContext(java.util.Map<java.lang.String,java.lang.Object> context)
           
 
Methods inherited from class com.atlassian.bamboo.notification.buildcompleted.AbstractCompletedNotification
getEmailSubject, getHtmlEmailContent, getHtmlImContent, getIMContent, getTextEmailContent, setPlanManager, setResultsSummaryManager, setTemplateRenderer, setTriggerManager, updateEmail
 
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
 

Constructor Detail

BuildCompletedNotification

public BuildCompletedNotification()
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
Overrides:
getDescription in class AbstractCompletedNotification
Returns:
Notification's description

init

public void init()
Overrides:
init in class AbstractCompletedNotification

populateContext

protected void populateContext(java.util.Map<java.lang.String,java.lang.Object> context)
Overrides:
populateContext in class AbstractCompletedNotification

getTextEmailTemplate

protected java.lang.String getTextEmailTemplate()
Specified by:
getTextEmailTemplate in class AbstractCompletedNotification

getHtmlEmailTemplate

protected java.lang.String getHtmlEmailTemplate()
Specified by:
getHtmlEmailTemplate in class AbstractCompletedNotification

getImTemplate

protected java.lang.String getImTemplate()
Specified by:
getImTemplate in class AbstractCompletedNotification

getEmailSubjectTemplate

protected java.lang.String getEmailSubjectTemplate()
Specified by:
getEmailSubjectTemplate in class AbstractCompletedNotification

getHtmlImTemplate

protected java.lang.String getHtmlImTemplate()
Overrides:
getHtmlImTemplate in class AbstractCompletedNotification


Copyright © 2013 Atlassian Software Systems Pty Ltd. All Rights Reserved.