Package com.atlassian.jira.dev.reference.plugin.notifications

Class ReferenceNotificationFilter

java.lang.Object

com.atlassian.jira.dev.reference.plugin.notifications.ReferenceNotificationFilter

All Implemented Interfaces:

NotificationFilter

public class ReferenceNotificationFilter
extends Object
implements NotificationFilter

Constructor Summary

Constructors

Constructor	Description
ReferenceNotificationFilter(JiraProperties jiraSystemProperties)

Method Summary

Modifier and Type	Method	Description
Iterable<NotificationRecipient>	addRecipient(NotificationFilterContext context, Iterable<NotificationRecipient> intendedRecipients)	This called called to add possible new NotificationRecipients to a notification event.
boolean	removeRecipient(NotificationRecipient recipient, NotificationFilterContext context)	This called called to remove NotificationRecipients from a notification event.

Methods inherited from class java.lang.Object

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

Constructor Details

ReferenceNotificationFilter

public ReferenceNotificationFilter(JiraProperties jiraSystemProperties)

Method Details

addRecipient

public Iterable<NotificationRecipient> addRecipient(NotificationFilterContext context,
 Iterable<NotificationRecipient> intendedRecipients)

Description copied from interface: NotificationFilter

This called called to add possible new NotificationRecipients to a notification event. Its possible that event is null in which case this means that there is no JIRA issue event in play but rather some other adhoc call to the JIRA AdhocNotificationService.

Specified by:

addRecipient in interface NotificationFilter

Parameters:

context - the context of this possible notification

intendedRecipients - this list of recipients that has been build up to this point.

Returns:

an iterable of new NotificationRecipients

removeRecipient

public boolean removeRecipient(NotificationRecipient recipient,
 NotificationFilterContext context)

Description copied from interface: NotificationFilter

This called called to remove NotificationRecipients from a notification event. Its possible that event is null in which case this means that tyhere is no JIRA issue event in play but rather some other ahoc call to the JIRA AdhocNotificationService.

This is ALWAYS called after NotificationFilter.addRecipient(NotificationFilterContext, Iterable) has been called for all plugins.

Specified by:

removeRecipient in interface NotificationFilter

context - the context of this possible notification

Returns:

true when recipient should be removed (shouldn't get notification), false when user should not be removed (should get notification).