com.atlassian.bamboo.notification.buildqueuetimeout
Class BuildQueueTimeoutNotification

java.lang.Object
  extended by com.atlassian.bamboo.notification.AbstractNotification
      extended by com.atlassian.bamboo.notification.buildqueuetimeout.BuildQueueTimeoutNotification
All Implemented Interfaces:
ExtendedNotification, Notification, Notification.HtmlImContentProvidingNotification

public class BuildQueueTimeoutNotification
extends AbstractNotification
implements ExtendedNotification


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.atlassian.bamboo.notification.Notification
Notification.HtmlImContentProvidingNotification
 
Field Summary
static java.lang.String HTML_EMAIL_TEMPLATE
           
static java.lang.String HTML_IM_TEMPLATE
           
static java.lang.String IM_TEMPLATE
           
static java.lang.String TEXT_EMAIL_TEMPLATE
           
 
Constructor Summary
BuildQueueTimeoutNotification()
           
 
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.
 BuildQueueTimeoutEvent getEvent()
          Retrieves the event object that triggered this notification
 java.lang.String getHtmlEmailContent()
          Generates the html for the html part of an email notification.
 java.lang.String getHtmlImContent()
           
 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 setTemplateRenderer(TemplateRenderer templateRenderer)
           
 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, 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, 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

HTML_IM_TEMPLATE

public static final java.lang.String HTML_IM_TEMPLATE
See Also:
Constant Field Values
Constructor Detail

BuildQueueTimeoutNotification

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

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

getHtmlImContent

@Nullable
public java.lang.String getHtmlImContent()
Specified by:
getHtmlImContent in interface Notification.HtmlImContentProvidingNotification
Overrides:
getHtmlImContent in class AbstractNotification

getEvent

public BuildQueueTimeoutEvent getEvent()
Description copied from interface: Notification
Retrieves the event object that triggered this notification

Specified by:
getEvent in interface Notification
Overrides:
getEvent in class AbstractNotification
Returns:
Event object that triggered this notification

setPlanManager

public void setPlanManager(PlanManager planManager)

setTemplateRenderer

public void setTemplateRenderer(TemplateRenderer templateRenderer)


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