Interface FilterProvider
-
- All Superinterfaces:
ChangeSetFilter
public interface FilterProvider extends ChangeSetFilter
Instance of this class provide aEventFilter
for observation events and a filter for commits.In order to support OAK-4908 a FilterProvider extends ChangeSetFilter
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description FilterConfigMBean
getConfigMBean()
@Nullable EventAggregator
getEventAggregator()
Allows providers to supply an optional EventAggregator that is used to adjust (aggregate) the event identifier before event creation (ie after event filtering).@NotNull EventFilter
getFilter(@NotNull NodeState before, @NotNull NodeState after)
Factory method for creating aFilter
for the passed before and after states.@NotNull java.lang.Iterable<java.lang.String>
getSubTrees()
A set of paths whose subtrees include all events of this filter.boolean
includeCommit(@NotNull java.lang.String sessionId, @Nullable CommitInfo info)
Filter whole commits.-
Methods inherited from interface org.apache.jackrabbit.oak.plugins.observation.filter.ChangeSetFilter
excludes
-
-
-
-
Method Detail
-
includeCommit
boolean includeCommit(@NotNull @NotNull java.lang.String sessionId, @Nullable @Nullable CommitInfo info)
Filter whole commits. Only commits for which this method returnstrue
will be further processed to create individual events.- Parameters:
sessionId
- id of the filtering (this) sessioninfo
- commit info of the commit ornull
if not available- Returns:
true
if observation events should be created from this commit,false
otherwise.- See Also:
Observer
-
getFilter
@NotNull @NotNull EventFilter getFilter(@NotNull @NotNull NodeState before, @NotNull @NotNull NodeState after)
Factory method for creating aFilter
for the passed before and after states.- Parameters:
before
- before stateafter
- after state- Returns:
- new
Filter
instance
-
getSubTrees
@NotNull @NotNull java.lang.Iterable<java.lang.String> getSubTrees()
A set of paths whose subtrees include all events of this filter.- Returns:
- list of paths
- See Also:
FilterBuilder.addSubTree(String)
-
getConfigMBean
FilterConfigMBean getConfigMBean()
-
getEventAggregator
@Nullable @Nullable EventAggregator getEventAggregator()
Allows providers to supply an optional EventAggregator that is used to adjust (aggregate) the event identifier before event creation (ie after event filtering).
-
-