com.atlassian.bamboo.notification.recipients

Class UserRecipientImpl

java.lang.Object

com.atlassian.bamboo.notification.recipients.AbstractNotificationRecipient

com.atlassian.bamboo.notification.recipients.UserRecipientImpl

All Implemented Interfaces:

NotificationRecipient, UserRecipient, BambooPluginModule, Comparable

public class UserRecipientImpl
extends AbstractNotificationRecipient
implements UserRecipient

Represents a user notification recipient. Knows how to obtain user notification preferences and generate NotificationTransports accordingly.

Nested Class Summary

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

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

Field Summary

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

notificationRecipientModuleDescriptor

Fields inherited from interface com.atlassian.bamboo.notification.recipients.UserRecipient

USER_FIELD, USER_LONG_FIELD

Constructor Summary

Constructors

Constructor and Description
UserRecipientImpl()

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.bamboo.notification.NotificationRecipient

getDescription, getKey, getModuleDescriptor, init

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

UserRecipientImpl

public UserRecipientImpl()

Method Detail

getTransports

@NotNull
public 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

Returns:

init

public void init(@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 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

Returns:

populate

public void populate(@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 ErrorCollection validate(@NotNull
                                         Map<String,String[]> params)

Description copied from interface: NotificationRecipient

validate the user inputed data

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 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 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.

setUsername

public void setUsername(String username)

Specified by:

setUsername in interface UserRecipient

getUsername

public String getUsername()

Specified by:

getUsername in interface UserRecipient

setBambooUserManager

public void setBambooUserManager(BambooUserManager bambooUserManager)

setNotificationFactory

public void setNotificationFactory(NotificationFactory notificationFactory)

setTemplateRenderer

public void setTemplateRenderer(TemplateRenderer templateRenderer)

setTextProvider

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

toString

public String toString()

Overrides:

toString in class Object