com.atlassian.bamboo.notification.conditions
Class AllBuildsCondition

java.lang.Object
  com.atlassian.bamboo.notification.conditions.AbstractNotificationCondition
      com.atlassian.bamboo.notification.conditions.AllBuildsCondition

All Implemented Interfaces:

NotificationCondition, BambooPluginModule

public class AllBuildsCondition
extends AbstractNotificationCondition

Field Summary

static java.lang.String	DESCRIPTION
static java.lang.String	KEY
static java.lang.String	TEXT_EMAIL_TEMPLATE

Constructor Summary

AllBuildsCondition()

Method Summary

java.lang.String	getDescription() Returns generic string description of this condition
java.lang.String	getEmailSubject(com.atlassian.event.Event event)
java.lang.String	getIMContent(com.atlassian.event.Event event)
java.lang.String	getKey() returns key for this condition object
com.atlassian.mail.Email	getTextEmail(com.atlassian.event.Event event, com.atlassian.mail.Email email) Takes in email object and sets body, subject and mimeType (and any other details you want eg.
org.apache.velocity.app.VelocityEngine	getVelocityEngine()
java.io.Writer	getWriter()
boolean	isNotificationRequired(com.atlassian.event.Event event) determines whether or not a notification should be sent based on the event
void	setExtendedAuthorManager(ExtendedAuthorManager extendedAuthorManager)

Methods inherited from class com.atlassian.bamboo.notification.conditions.AbstractNotificationCondition

getConfigurationData, getEditHtml, getViewHtml, init, init, populate, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DESCRIPTION

public static final java.lang.String DESCRIPTION

See Also:

Constant Field Values

KEY

public static final java.lang.String KEY

See Also:

Constant Field Values

TEXT_EMAIL_TEMPLATE

public static final java.lang.String TEXT_EMAIL_TEMPLATE

See Also:

Constant Field Values

Constructor Detail

AllBuildsCondition

public AllBuildsCondition()

Method Detail

getDescription

@NotNull
public java.lang.String getDescription()

Description copied from interface: NotificationCondition

Returns generic string description of this condition

Returns:

string description - can not be null

getKey

@NotNull
public java.lang.String getKey()

Description copied from interface: NotificationCondition

returns key for this condition object

Returns:

string key (as in plugin definition), can not be null

isNotificationRequired

public boolean isNotificationRequired(@NotNull
                                      com.atlassian.event.Event event)

Description copied from interface: NotificationCondition

determines whether or not a notification should be sent based on the event

Returns:

true or false - to send or not to send.

getTextEmail

public com.atlassian.mail.Email getTextEmail(@NotNull
                                             com.atlassian.event.Event event,
                                             @NotNull
                                             com.atlassian.mail.Email email)

Description copied from interface: NotificationCondition

Takes in email object and sets body, subject and mimeType (and any other details you want eg. attachments).

Specified by:

getTextEmail in interface NotificationCondition

Overrides:

getTextEmail in class AbstractNotificationCondition

Parameters:

event - Event Object (eg BuildCompletedEvent) that the notification is fired on

email - Email object for condition to add body and attachments etc

Returns:

Email with content

getIMContent

@NotNull
public java.lang.String getIMContent(@NotNull
                                             com.atlassian.event.Event event)

Parameters:

event - Event Object that the notification is fired based on

Returns:

string im message

getEmailSubject

@NotNull
public java.lang.String getEmailSubject(@NotNull
                                                com.atlassian.event.Event event)

Parameters:

event - Event Object that the notification is fired based on

Returns:

String subject for emails.

setExtendedAuthorManager

public void setExtendedAuthorManager(ExtendedAuthorManager extendedAuthorManager)

getWriter

public java.io.Writer getWriter()

getVelocityEngine

public org.apache.velocity.app.VelocityEngine getVelocityEngine()