Package com.atlassian.bamboo.notification.recipients

Class GroupRecipient

java.lang.Object

com.atlassian.bamboo.notification.recipients.AbstractNotificationRecipient

com.atlassian.bamboo.notification.recipients.GroupRecipient

All Implemented Interfaces:

NotificationRecipient, NotificationRecipient.UserRecipientExpandable, BambooPluginModule, Comparable

public class GroupRecipient
extends AbstractNotificationRecipient
implements NotificationRecipient.UserRecipientExpandable

Represents a group recipient. Knows how to evaluate the group into relavent users.

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.bamboo.notification.NotificationRecipient

NotificationRecipient.RequiresEvent, NotificationRecipient.RequiresPlan, NotificationRecipient.RequiresResultSummary, NotificationRecipient.Scope, NotificationRecipient.UserRecipientExpandable

Field Summary

Fields

Modifier and Type	Field	Description
static String	GROUP_FIELD

Fields inherited from class com.atlassian.bamboo.notification.recipients.AbstractNotificationRecipient

notificationRecipientModuleDescriptor

Constructor Summary

Constructors

Constructor	Description
GroupRecipient()

Method Summary

Modifier and Type	Method	Description
@NotNull String	getEditHtml()	Returns the html to be displayed on the edit screen (to input data into notification type)
@NotNull String	getRecipientConfig()	Retrieve string representation of data - if none exists return empty string
@NotNull List<NotificationTransport>	getTransports()	Evaluates the appropriate mediums for sending notifications for this recipient, returning a list of appropriate transports.
@NotNull Set<UserRecipient>	getUserRecipients()
@NotNull String	getViewHtml()	Returns the HTML representing the notification type for the notification
void	init(@Nullable String configurationData)	Initialise recipient with string based representation of its configuration data
void	populate(@NotNull Map<String,String[]> params)	takes the map of config data from action and extracts the parameters it needs
void	setBambooUserManager(BambooUserManager bambooUserManager)
void	setGroupName(String groupName)
void	setNotificationFactory(NotificationFactory notificationFactory)
void	setTemplateRenderer(TemplateRenderer templateRenderer)
void	setTextProvider(com.opensymphony.xwork2.TextProvider textProvider)
@NotNull ErrorCollection	validate(@NotNull Map<String,String[]> params)	Validate the data user provided.

Methods inherited from class com.atlassian.bamboo.notification.recipients.AbstractNotificationRecipient

compareTo, getDescription, getKey, getModuleDescriptor, getParam, getScopes, getTransports, init

Methods inherited from class java.lang.Object

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

Field Detail

GROUP_FIELD

public static final String GROUP_FIELD

See Also:

Constant Field Values

Constructor Detail

GroupRecipient

public GroupRecipient()

Method Detail

getTransports

@NotNull
public @NotNull List<NotificationTransport> getTransports()

Description copied from interface: NotificationRecipient

Evaluates the appropriate mediums for sending notifications for this recipient, returning a list of appropriate transports.

Specified by:

getTransports in interface NotificationRecipient

getUserRecipients

@NotNull
public @NotNull Set<UserRecipient> getUserRecipients()

Specified by:

getUserRecipients in interface NotificationRecipient.UserRecipientExpandable

init

public void init(@Nullable
                 @Nullable String configurationData)

Description copied from interface: NotificationRecipient

Initialise recipient with string based representation of its configuration data

Specified by:

init in interface NotificationRecipient

Overrides:

init in class AbstractNotificationRecipient

getRecipientConfig

@NotNull
public @NotNull String getRecipientConfig()

Description copied from interface: NotificationRecipient

Retrieve string representation of data - if none exists return empty string

Specified by:

getRecipientConfig in interface NotificationRecipient

Overrides:

getRecipientConfig in class AbstractNotificationRecipient

populate

public void populate(@NotNull
                     @NotNull Map<String,String[]> params)

Description copied from interface: NotificationRecipient

takes the map of config data from action and extracts the parameters it needs

Specified by:

populate in interface NotificationRecipient

Overrides:

populate in class AbstractNotificationRecipient

Parameters:

params - map of key (String), value (String []) pairs from action

validate

@NotNull
public @NotNull ErrorCollection validate(@NotNull
                                         @NotNull Map<String,String[]> params)

Description copied from interface: NotificationRecipient

Validate the data user provided.

Specified by:

validate in interface NotificationRecipient

Overrides:

validate in class AbstractNotificationRecipient

Parameters:

params - map of key (String), value (String []) pairs from action

Returns:

error collection of any errors to be reported back to the user

getEditHtml

@NotNull
public @NotNull String getEditHtml()

Description copied from interface: NotificationRecipient

Returns the html to be displayed on the edit screen (to input data into notification type)

Specified by:

getEditHtml in interface NotificationRecipient

Overrides:

getEditHtml in class AbstractNotificationRecipient

Returns:

String of html

getViewHtml

@NotNull
public @NotNull String getViewHtml()

Description copied from interface: NotificationRecipient

Returns the HTML representing the notification type for the notification

Specified by:

getViewHtml in interface NotificationRecipient

Overrides:

getViewHtml in class AbstractNotificationRecipient

Returns:

HTML of data for view configuration. If this returns null the description will be used.

setGroupName

public void setGroupName(String groupName)

setBambooUserManager

public void setBambooUserManager(BambooUserManager bambooUserManager)

setTemplateRenderer

public void setTemplateRenderer(TemplateRenderer templateRenderer)

setNotificationFactory

public void setNotificationFactory(NotificationFactory notificationFactory)

setTextProvider

public void setTextProvider(com.opensymphony.xwork2.TextProvider textProvider)