org.xwiki.notifications.filters

Interface NotificationFilter

All Superinterfaces:

Comparable

@Role
public interface NotificationFilter
extends Comparable

Enable or disable notifications from the event stream (for customization purpose). A NotificationFilter has two goals :

• Pre-Filtering : Generate a query (made with AbstractNode) that will be used to retrieve a specific subset of notifications from a provider.
• Post-Filtering : given an Event, determine if this event should be filtered or not.

Since:

9.5RC1

Version:

$Id: ac2ab32d5bf6715e75e82eced4efff59f8333455 $

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	NotificationFilter.FilteringPhase The different phases when a filter can be called.
static class	NotificationFilter.FilterPolicy The different behaviours a filter could have regarding an event.

Field Summary

Fields

Modifier and Type	Field and Description
static Set<NotificationFilter.FilteringPhase>	SUPPORT_BOTH_FILTERING_PHASE A static set containing both NotificationFilter.FilteringPhase.POST_FILTERING and NotificationFilter.FilteringPhase.PRE_FILTERING.
static Set<NotificationFilter.FilteringPhase>	SUPPORT_ONLY_POST_FILTERING_PHASE A static set containing only NotificationFilter.FilteringPhase.POST_FILTERING.
static Set<NotificationFilter.FilteringPhase>	SUPPORT_ONLY_PRE_FILTERING_PHASE A static set containing only NotificationFilter.FilteringPhase.PRE_FILTERING.

Method Summary

Modifier and Type	Method and Description
default int	compareTo(Object o)
NotificationFilter.FilterPolicy	filterEvent(org.xwiki.eventstream.Event event, DocumentReference user, Collection<NotificationFilterPreference> filterPreferences, NotificationFormat format) Enable or disable an event in the notification list (post-filter).
ExpressionNode	filterExpression(DocumentReference user, Collection<NotificationFilterPreference> filterPreferences, NotificationFilterType type, NotificationFormat format) Filtering expression to use when retrieving notifications.
default ExpressionNode	filterExpression(DocumentReference user, Collection<NotificationFilterPreference> filterPreferences, NotificationFilterType type, NotificationFormat format, Collection<NotificationPreference> preferences) Filtering expression to use when retrieving notifications.
ExpressionNode	filterExpression(DocumentReference user, Collection<NotificationFilterPreference> filterPreferences, NotificationPreference preference) Filtering expression to use when retrieving notifications.
default Set<NotificationFilter.FilteringPhase>	getFilteringPhases()
String	getName() Get the name of the filter.
default int	getPriority()
boolean	matchesPreference(NotificationPreference preference) Determine if the current filter can be applied to the given preference.

Field Detail

SUPPORT_BOTH_FILTERING_PHASE

static final Set<NotificationFilter.FilteringPhase> SUPPORT_BOTH_FILTERING_PHASE

A static set containing both NotificationFilter.FilteringPhase.POST_FILTERING and NotificationFilter.FilteringPhase.PRE_FILTERING. To be used in overrides of getFilteringPhases() for performance reasons.

SUPPORT_ONLY_POST_FILTERING_PHASE

static final Set<NotificationFilter.FilteringPhase> SUPPORT_ONLY_POST_FILTERING_PHASE

A static set containing only NotificationFilter.FilteringPhase.POST_FILTERING. To be used in overrides of getFilteringPhases() for performance reasons.

SUPPORT_ONLY_PRE_FILTERING_PHASE

static final Set<NotificationFilter.FilteringPhase> SUPPORT_ONLY_PRE_FILTERING_PHASE

A static set containing only NotificationFilter.FilteringPhase.PRE_FILTERING. To be used in overrides of getFilteringPhases() for performance reasons.

Method Detail

filterEvent

NotificationFilter.FilterPolicy filterEvent(org.xwiki.eventstream.Event event,
                                            DocumentReference user,
                                            Collection<NotificationFilterPreference> filterPreferences,
                                            NotificationFormat format)

Enable or disable an event in the notification list (post-filter).

Parameters:

event - an event

user - the user interested in the notification

filterPreferences - the collection of all preferences to take into account

format - format of the notification

Returns:

true if the event should be dismiss

Since:

9.11.5, 10.3

matchesPreference

boolean matchesPreference(NotificationPreference preference)

Determine if the current filter can be applied to the given preference. In order to do so, the NotificationFilter can rely on the different parameters of the NotificationPreference.

Parameters:

preference - the preference to use

Returns:

true if the filter is compatible with the preference

Since:

9.7RC1

filterExpression

ExpressionNode filterExpression(DocumentReference user,
                                Collection<NotificationFilterPreference> filterPreferences,
                                NotificationPreference preference)

Filtering expression to use when retrieving notifications.

Parameters:

user - the user interested in the notifications

filterPreferences - the collection of all preferences to take into account

preference - the notification preference associated with the filter

Returns:

the updated query

Since:

9.7RC1

filterExpression

ExpressionNode filterExpression(DocumentReference user,
                                Collection<NotificationFilterPreference> filterPreferences,
                                NotificationFilterType type,
                                NotificationFormat format)

Filtering expression to use when retrieving notifications. Note that this filtering expression will not be bound to any notification preference.

Parameters:

user - the user interested in the notifications

filterPreferences - the collection of all preferences to take into account

type - of the expected notification filter

format - format of the notification

Returns:

a filtering expression or null

Since:

9.10RC1

filterExpression

default ExpressionNode filterExpression(DocumentReference user,
                                        Collection<NotificationFilterPreference> filterPreferences,
                                        NotificationFilterType type,
                                        NotificationFormat format,
                                        Collection<NotificationPreference> preferences)

Filtering expression to use when retrieving notifications. Note that this filtering expression will not be bound to any notification preference.

Parameters:

user - the user interested in the notifications

filterPreferences - the collection of all preferences to take into account

type - of the expected notification filter

format - format of the notification

preferences - list of preferences

Returns:

a filtering expression or null

Since:

10.8RC1, 9.11.8

getName

String getName()

Get the name of the filter. This is useful as NotificationFilterPreference will be able to be linked to this filter using its name. If the NotificationFilter is used as a component, consider defining the hint of this component as the name of the filter.

Returns:

the name of the filter

Since:

9.7RC1

getPriority

default int getPriority()

Returns:

the priority of the filter. The higher it is, the more important the result of filterEvent(Event, DocumentReference, Collection, NotificationFormat) is.

Since:

9.11.5, 10.3

compareTo

default int compareTo(Object o)

Specified by:

compareTo in interface Comparable

getFilteringPhases

@Unstable
default Set<NotificationFilter.FilteringPhase> getFilteringPhases()

Returns:

the set of pĥase(s) when the filter can be used.

Since:

12.9RC1, 12.6.3