com.atlassian.bamboo.notification

Class NotificationManagerImpl

java.lang.Object

com.atlassian.bamboo.notification.NotificationManagerImpl

All Implemented Interfaces:

NotificationManager

public class NotificationManagerImpl
extends Object
implements NotificationManager

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMITTER_RECIPIENT
static String	FAILED_CHAIN_NOTIFICATION
static String	USER_RECIPIENT
static String	WATCHER_RECIPIENT

Constructor Summary

Constructors

Constructor and Description
NotificationManagerImpl()

Method Summary

Modifier and Type	Method and Description
NotificationSet	cloneNotificationSet(NotificationSet oldSet) Clone notification set and rules for use when cloning Plan
NotificationRule	createNotificationRule(Class<? extends NotificationType> notificationTypeClass, String conditionData, Class<? extends NotificationRecipient> recipientTypeClass, String recipientString) Creates a new NotificationRule from the NotificationType and NotificationRecipient specificed.
NotificationRule	createNotificationRule(String conditionKey, String conditionData, String recipientString, String recipientType) Create notification rule and provide required managers.
NotificationRule	createNotificationRuleFromAction(String notificationTypeKey, String notificationRecipientKey, Map<String,String[]> actionParams) Creates a notification rule based on the keys and params passed in from the action
NotificationSet	createOrGetSystemNotificationSet() Get the system notification set for this bamboo and if one doesn't exist create it!
List<NotificationRecipient>	getAllNotificationRecipients()
List<NotificationType>	getAllNotificationTypes()
List<NotificationType>	getChainNotificationTypes() Return notification types marked explicitly as "chain" notification in plugin xml description
List<NotificationType>	getDeploymentNotificationTypes()
NotificationRecipient	getNotificationRecipient(NotificationRule rule) Instantiate and populate notification recipient from a rule.
NotificationRecipient	getNotificationRecipientFromKey(String notificationRecipientKey)
NotificationRule	getNotificationRuleById(long notificationId) Get a specific notification rule
Set<NotificationRule>	getNotificationRules(ImmutablePlan plan) Extract notification rules for a plan.
Set<NotificationRule>	getNotificationRules(Plan plan)
List<UsersNotification>	getNotificationRulesForUser(BambooUser user) Retrieves all notification rules associated with a given user searches for notification rules: * assigned to the user * assigned to a group the user belongs to * assigned to the user's email or user's im address * assigned to watchers of a build the user has marked as their favourite
List<NotificationSet>	getNotificationSetsForType(NotificationSet.NotificationSetType type)
NotificationType	getNotificationType(NotificationRule rule) Instantiate and populate notification type from a rule.
NotificationType	getNotificationTypeFromKey(String key) Retrieve a specific NotificationType plugin module based on the given key.
List<NotificationType>	getPlanNotificationTypes()
List<NotificationType>	getSystemNotificationTypes()
boolean	isRecipientUserBase(NotificationRule notificationRule) Determines whether or not a notification rule recipient evaluates to a bamboo user and therefore comply with the users notification preference.
void	replaceNotificationRule(NotificationSet notificationSet, long existingNotificationId, NotificationRule newNotificationRule) Replaces a notification rule with the new definition.
void	saveNotificationSet(NotificationSet notificationSet) Saves a notification set without requiring a build.
void	saveSystemNotificationRule(NotificationRule notificationRule) Do not use this method.
void	setBambooUserManager(BambooUserManager bambooUserManager)
void	setLabelManager(LabelManager labelManager)
void	setNotificationDao(NotificationDao notificationRuleDao)
void	setPluginAccessor(com.atlassian.plugin.PluginAccessor pluginAccessor)

Methods inherited from class java.lang.Object

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

Field Detail

USER_RECIPIENT

public static final String USER_RECIPIENT

See Also:

Constant Field Values

COMMITTER_RECIPIENT

public static final String COMMITTER_RECIPIENT

See Also:

Constant Field Values

WATCHER_RECIPIENT

public static final String WATCHER_RECIPIENT

See Also:

Constant Field Values

FAILED_CHAIN_NOTIFICATION

public static final String FAILED_CHAIN_NOTIFICATION

See Also:

Constant Field Values

Constructor Detail

NotificationManagerImpl

public NotificationManagerImpl()

Method Detail

saveNotificationSet

public void saveNotificationSet(NotificationSet notificationSet)

Description copied from interface: NotificationManager

Saves a notification set without requiring a build.

Specified by:

saveNotificationSet in interface NotificationManager

Parameters:

notificationSet - the notification set to save

createNotificationRule

public NotificationRule createNotificationRule(String conditionKey,
                                               String conditionData,
                                               String recipientString,
                                               String recipientType)

Description copied from interface: NotificationManager

Create notification rule and provide required managers.

Specified by:

createNotificationRule in interface NotificationManager

Parameters:

conditionKey - - key representation of the notification type

conditionData - - any data the notification type requires

recipientString - - data the recipient type requires (e.g user or group name)

recipientType - - key representing the type of recipient

Returns:

a newly created notification rule

createNotificationRule

@NotNull
public NotificationRule createNotificationRule(@NotNull
                                                        Class<? extends NotificationType> notificationTypeClass,
                                                        @Nullable
                                                        String conditionData,
                                                        @NotNull
                                                        Class<? extends NotificationRecipient> recipientTypeClass,
                                                        @Nullable
                                                        String recipientString)

Description copied from interface: NotificationManager

Creates a new NotificationRule from the NotificationType and NotificationRecipient specificed.

Specified by:

createNotificationRule in interface NotificationManager

Parameters:

notificationTypeClass - NotificationType

conditionData - - any data the notification type requires

recipientTypeClass - NotificationRecipient

recipientString - - data the recipient type requires (e.g user or group name)

Returns:

a newly created notification rule

createNotificationRuleFromAction

@NotNull
public NotificationRule createNotificationRuleFromAction(String notificationTypeKey,
                                                                  String notificationRecipientKey,
                                                                  Map<String,String[]> actionParams)
                                                           throws IllegalArgumentException

Description copied from interface: NotificationManager

Creates a notification rule based on the keys and params passed in from the action

Specified by:

createNotificationRuleFromAction in interface NotificationManager

Parameters:

notificationTypeKey - - the plugin key for the notification type selected

notificationRecipientKey - - the plugin key for the notification recipient type selected

actionParams - - the action params.

Returns:

a new notification rule

Throws:

IllegalArgumentException - if either of the keys provided is invalid

getNotificationRules

public Set<NotificationRule> getNotificationRules(@Nullable
                                                  Plan plan)

Specified by:

getNotificationRules in interface NotificationManager

getNotificationRules

@NotNull
public Set<NotificationRule> getNotificationRules(@Nullable
                                                           ImmutablePlan plan)

Description copied from interface: NotificationManager

Extract notification rules for a plan.

Specified by:

getNotificationRules in interface NotificationManager

Parameters:

plan - to get notifications for

Returns:

a set of notification rules belonging to the given plan.

cloneNotificationSet

public NotificationSet cloneNotificationSet(NotificationSet oldSet)

Description copied from interface: NotificationManager

Clone notification set and rules for use when cloning Plan

Specified by:

cloneNotificationSet in interface NotificationManager

Parameters:

oldSet - - the notification set to clone

Returns:

a new notification set containing the same notifications as in the original set.

getNotificationSetsForType

@NotNull
public List<NotificationSet> getNotificationSetsForType(NotificationSet.NotificationSetType type)

getAllNotificationTypes

public List<NotificationType> getAllNotificationTypes()

Specified by:

getAllNotificationTypes in interface NotificationManager

Returns:

a list of all enabled NotificationType plugin modules regardless of scope.

getSystemNotificationTypes

public List<NotificationType> getSystemNotificationTypes()

Specified by:

getSystemNotificationTypes in interface NotificationManager

Returns:

a list of all enabled NotificationType plugin modules which have the "system" scope

getDeploymentNotificationTypes

public List<NotificationType> getDeploymentNotificationTypes()

Specified by:

getDeploymentNotificationTypes in interface NotificationManager

Returns:

a list of all enabled NotificationType plugin modules which have the "deployment" scope

getPlanNotificationTypes

public List<NotificationType> getPlanNotificationTypes()

Specified by:

getPlanNotificationTypes in interface NotificationManager

Returns:

a list of all enabled NotificationType plugin modules which have the "plan" scope

getChainNotificationTypes

public List<NotificationType> getChainNotificationTypes()

Description copied from interface: NotificationManager

Return notification types marked explicitly as "chain" notification in plugin xml description

Specified by:

getChainNotificationTypes in interface NotificationManager

Returns:

a list of all enabled NotificationType plugin modules which have the "chain" scope

getAllNotificationRecipients

public List<NotificationRecipient> getAllNotificationRecipients()

Specified by:

getAllNotificationRecipients in interface NotificationManager

Returns:

a list of all enabled NotificationRecipient plugin modules

getNotificationRecipientFromKey

public NotificationRecipient getNotificationRecipientFromKey(String notificationRecipientKey)

Specified by:

getNotificationRecipientFromKey in interface NotificationManager

Parameters:

notificationRecipientKey - representing the NotificationRecipient required

Returns:

a specific NotificationRecipient plugin module based on the given key.

getNotificationRecipient

@Nullable
public NotificationRecipient getNotificationRecipient(NotificationRule rule)

Description copied from interface: NotificationManager

Instantiate and populate notification recipient from a rule.

Specified by:

getNotificationRecipient in interface NotificationManager

getNotificationType

@Nullable
public NotificationType getNotificationType(NotificationRule rule)

Description copied from interface: NotificationManager

Instantiate and populate notification type from a rule.

Specified by:

getNotificationType in interface NotificationManager

getNotificationTypeFromKey

@Nullable
public NotificationType getNotificationTypeFromKey(String key)

Description copied from interface: NotificationManager

Retrieve a specific NotificationType plugin module based on the given key.

Specified by:

getNotificationTypeFromKey in interface NotificationManager

Parameters:

key - of the notification type

Returns:

a specific NotificationType plugin module based on the given key.

getNotificationRulesForUser

@NotNull
public List<UsersNotification> getNotificationRulesForUser(@NotNull
                                                                    BambooUser user)

Description copied from interface: NotificationManager

Retrieves all notification rules associated with a given user searches for notification rules: * assigned to the user * assigned to a group the user belongs to * assigned to the user's email or user's im address * assigned to watchers of a build the user has marked as their favourite

Specified by:

getNotificationRulesForUser in interface NotificationManager

Parameters:

user - BambooUser to look up notifications for

Returns:

all notification rules associated with a given user following the above rules

isRecipientUserBase

public boolean isRecipientUserBase(NotificationRule notificationRule)

Description copied from interface: NotificationManager

Determines whether or not a notification rule recipient evaluates to a bamboo user and therefore comply with the users notification preference.

Specified by:

isRecipientUserBase in interface NotificationManager

Parameters:

notificationRule - to check

Returns:

true if the recipient evaluates to a user

replaceNotificationRule

public void replaceNotificationRule(@NotNull
                                    NotificationSet notificationSet,
                                    long existingNotificationId,
                                    @NotNull
                                    NotificationRule newNotificationRule)

Description copied from interface: NotificationManager

Replaces a notification rule with the new definition. This method should always be preferred when replacing an existing rule instead of operating on the NotificationSet manually. Reason: as of current Hibernate, queries which modify collections (such as NotificationSet) are batched and executed in a specific order. In particular, inserts are executed before deletes. Due to constraints on the NotificationRule class/table this may lead to database constraint violations, resulting in unsuccessful updates and exceptions.

Specified by:

replaceNotificationRule in interface NotificationManager

Parameters:

notificationSet - notification set on which the operation should be executed

existingNotificationId - id of the existing notification rule

newNotificationRule - new notification rule to replace the existing one

See Also:

HHH-2801

createOrGetSystemNotificationSet

@NotNull
public NotificationSet createOrGetSystemNotificationSet()

Description copied from interface: NotificationManager

Get the system notification set for this bamboo and if one doesn't exist create it!

Specified by:

createOrGetSystemNotificationSet in interface NotificationManager

Returns:

saveSystemNotificationRule

public void saveSystemNotificationRule(@NotNull
                                       NotificationRule notificationRule)

Description copied from interface: NotificationManager

Do not use this method. Use SystemNotificationService.saveSystemNotificationRule(); Save an individual system notification rule.

Specified by:

saveSystemNotificationRule in interface NotificationManager

Parameters:

notificationRule - to be added

getNotificationRuleById

@Nullable
public NotificationRule getNotificationRuleById(long notificationId)

Description copied from interface: NotificationManager

Get a specific notification rule

Specified by:

getNotificationRuleById in interface NotificationManager

Parameters:

notificationId - of the notification to get.

Returns:

the notification rule with the given ID, or null if one doesn't eixst

setNotificationDao

public void setNotificationDao(NotificationDao notificationRuleDao)

setPluginAccessor

public void setPluginAccessor(com.atlassian.plugin.PluginAccessor pluginAccessor)

setBambooUserManager

public void setBambooUserManager(BambooUserManager bambooUserManager)

setLabelManager

public void setLabelManager(LabelManager labelManager)