Class OakEventFilterImpl
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaggregator
(EventAggregator aggregator) builder()
Returns theabsPath
parameter of the filter.getAdditionalIncludeConditions
(Set<String> includePaths) String[]
Returns theabsPaths
parameter of the filter.int
Returns theeventTypes
parameter of the filter.String[]
Returns theexcludedPaths
parameter of the filter.String[]
Returns theuuids
parameter of the filter.boolean
Returns theisDeep
parameter of the filter.String[]
Returns thenodeTypeName
parameter of the filter.boolean
Returns thenoExternal
parameter of the filter.boolean
Returns thenoInternal
parameter of the filter.boolean
Returns thenoLocal
parameter of the filter.setAbsPath
(String absPath) Sets theabsPath
parameter of the filter.setAdditionalPaths
(String... absPaths) Sets theabsPaths
parameter of the filter.setEventTypes
(int eventTypes) Sets theeventTypes
parameter of the filter.setExcludedPaths
(String... excludedPaths) Sets theexcludedPaths
parameter of the filter.setIdentifiers
(String[] identifiers) Sets theidentifiers
parameter of the filter.setIsDeep
(boolean isDeep) Sets theisDeep
parameter of the filter.setNodeTypes
(String[] nodeTypeNames) Sets thenodeTypeNames
parameter of the filter.setNoExternal
(boolean noExternal) Sets thenoExternal
parameter of the filter.setNoInternal
(boolean noInternal) Sets thenoInternal
parameter of the filter.setNoLocal
(boolean noLocal) Sets thenoLocal
parameter of the filter.This causes the node type filter to be applied on 'this' node instead of the 'parent' node, thus allows to create a filter which listens on adding/removing/etc on nodes of a particular node type (while the default was that the node type was applicable on the parent).This causes the registration of independent, additional !deep NODE_REMOVED filter-conditions of all parents of the include paths (both normal and glob).withIncludeGlobPaths
(String... globPaths) Adds the provided glob paths to the set of include paths.This flag causes remove events to be sent for all nodes and properties of an entire subtree (hence use with care!).withNodeTypeAggregate
(String[] nodeTypes, String[] relativeGlobPaths) Greedy aggregating filter which upon first (hence greedy) hit of provided nodeTypes checks if the child subtree leading to the actual change matches any of the provided relativeGlobPaths.wrapMainCondition
(FilterBuilder.Condition mainCondition, FilterBuilder filterBuilder, PermissionProviderFactory permissionProviderFactory)
-
Constructor Details
-
OakEventFilterImpl
-
-
Method Details
-
getAbsPath
Description copied from class:JackrabbitEventFilter
Returns theabsPath
parameter of the filter.- Overrides:
getAbsPath
in classJackrabbitEventFilter
- Returns:
- a
String
.
-
setAbsPath
Description copied from class:JackrabbitEventFilter
Sets theabsPath
parameter of the filter. If left unset, this parameter defaults tonull
.- Overrides:
setAbsPath
in classJackrabbitEventFilter
- Parameters:
absPath
- an absolute pathString
.- Returns:
- This EventFilter object with the
absPath
parameter set.
-
getAdditionalPaths
Description copied from class:JackrabbitEventFilter
Returns theabsPaths
parameter of the filter.- Overrides:
getAdditionalPaths
in classJackrabbitEventFilter
- Returns:
- a
String
array.
-
setAdditionalPaths
Description copied from class:JackrabbitEventFilter
Sets theabsPaths
parameter of the filter. If left unset, this parameter defaults to an empty array.- Overrides:
setAdditionalPaths
in classJackrabbitEventFilter
- Parameters:
absPaths
- an absolute pathString
array.- Returns:
- This EventFilter object with the
absPaths
parameter set.
-
getEventTypes
public int getEventTypes()Description copied from class:JackrabbitEventFilter
Returns theeventTypes
parameter of the filter.- Overrides:
getEventTypes
in classJackrabbitEventFilter
- Returns:
- an
int
.
-
setEventTypes
Description copied from class:JackrabbitEventFilter
Sets theeventTypes
parameter of the filter. If left unset, this parameter defaults to0
.- Overrides:
setEventTypes
in classJackrabbitEventFilter
- Parameters:
eventTypes
- anint
.- Returns:
- This EventFilter object with the
eventTypes
parameter set.
-
getExcludedPaths
Description copied from class:JackrabbitEventFilter
Returns theexcludedPaths
parameter of the filter.- Overrides:
getExcludedPaths
in classJackrabbitEventFilter
- Returns:
- a
String
array.
-
setExcludedPaths
Description copied from class:JackrabbitEventFilter
Sets theexcludedPaths
parameter of the filter. If left unset, this parameter defaults to an empty array.- Overrides:
setExcludedPaths
in classJackrabbitEventFilter
- Parameters:
excludedPaths
- an absolute pathString
array.- Returns:
- This EventFilter object with the
excludedPaths
parameter set.
-
getIdentifiers
Description copied from class:JackrabbitEventFilter
Returns theuuids
parameter of the filter.- Overrides:
getIdentifiers
in classJackrabbitEventFilter
- Returns:
- a
String
array.
-
setIdentifiers
Description copied from class:JackrabbitEventFilter
Sets theidentifiers
parameter of the filter. If left unset, this parameter defaults tonull
.- Overrides:
setIdentifiers
in classJackrabbitEventFilter
- Parameters:
identifiers
- aString
array.- Returns:
- This EventFilter object with the
identifiers
parameter set.
-
getIsDeep
public boolean getIsDeep()Description copied from class:JackrabbitEventFilter
Returns theisDeep
parameter of the filter.- Overrides:
getIsDeep
in classJackrabbitEventFilter
- Returns:
- a
boolean
.
-
setIsDeep
Description copied from class:JackrabbitEventFilter
Sets theisDeep
parameter of the filter. If left unset, this parameter defaults tofalse
.- Overrides:
setIsDeep
in classJackrabbitEventFilter
- Parameters:
isDeep
- aboolean
.- Returns:
- This EventFilter object with the
isDeep
parameter set.
-
getNodeTypes
Description copied from class:JackrabbitEventFilter
Returns thenodeTypeName
parameter of the filter.- Overrides:
getNodeTypes
in classJackrabbitEventFilter
- Returns:
- a
String
array.
-
setNodeTypes
Description copied from class:JackrabbitEventFilter
Sets thenodeTypeNames
parameter of the filter. If left unset, this parameter defaults tonull
.- Overrides:
setNodeTypes
in classJackrabbitEventFilter
- Parameters:
nodeTypeNames
- aString
array.- Returns:
- This EventFilter object with the
nodeTypes
parameter set.
-
getNoExternal
public boolean getNoExternal()Description copied from class:JackrabbitEventFilter
Returns thenoExternal
parameter of the filter.- Overrides:
getNoExternal
in classJackrabbitEventFilter
- Returns:
- a
boolean
.
-
setNoExternal
Description copied from class:JackrabbitEventFilter
Sets thenoExternal
parameter of the filter. If left unset, this parameter defaults tofalse
.- Overrides:
setNoExternal
in classJackrabbitEventFilter
- Parameters:
noExternal
- aboolean
.- Returns:
- This EventFilter object with the
noExternal
parameter set.
-
getNoInternal
public boolean getNoInternal()Description copied from class:JackrabbitEventFilter
Returns thenoInternal
parameter of the filter.- Overrides:
getNoInternal
in classJackrabbitEventFilter
- Returns:
- a
boolean
.
-
setNoInternal
Description copied from class:JackrabbitEventFilter
Sets thenoInternal
parameter of the filter. If left unset, this parameter defaults tofalse
.- Overrides:
setNoInternal
in classJackrabbitEventFilter
- Parameters:
noInternal
- aboolean
.- Returns:
- This EventFilter object with the
noExternal
parameter set.
-
getNoLocal
public boolean getNoLocal()Description copied from class:JackrabbitEventFilter
Returns thenoLocal
parameter of the filter.- Overrides:
getNoLocal
in classJackrabbitEventFilter
- Returns:
- a
boolean
.
-
setNoLocal
Description copied from class:JackrabbitEventFilter
Sets thenoLocal
parameter of the filter. If left unset, this parameter defaults tofalse
.- Overrides:
setNoLocal
in classJackrabbitEventFilter
- Parameters:
noLocal
- aboolean
.- Returns:
- This EventFilter object with the
noLocal
parameter set.
-
withApplyNodeTypeOnSelf
Description copied from class:OakEventFilter
This causes the node type filter to be applied on 'this' node instead of the 'parent' node, thus allows to create a filter which listens on adding/removing/etc on nodes of a particular node type (while the default was that the node type was applicable on the parent).Note that this is an 'either/or' thing: either the node type is applied on the parent (default) or on 'self/this' (via this switch) but not both.
Also note that this is independent from the nodeTypeAggregate, and will only be applied to the (main) node types set on this filter, not on the nodeTypeAggregate's node types.
- Specified by:
withApplyNodeTypeOnSelf
in classOakEventFilter
- Returns:
- this filter with the filter change applied
-
withIncludeAncestorsRemove
Description copied from class:OakEventFilter
This causes the registration of independent, additional !deep NODE_REMOVED filter-conditions of all parents of the include paths (both normal and glob). (These additional filter-conditions are added in 'OR' mode to the otherwise resulting filter-conditions, thus you can still have an independentdeep/!deep
flag too)- include path /a/b/c/d results in additional !deep NODE_REMOVED filters on /a/b/c, on /a/b and on /a
- include path /a/b/** results in additional !deep NODE_REMOVED filter on /a, /a/b and /a/b/**
- include path /a/b/**
/
*.jsp results in additional deep NODE_REMOVED filter on /a, /a/b and /a/b/**
Note that this and the above result in the same additional include paths since all this includeAncestorsRemove flag does is include potential ancestors, it doesn't guarantee that there are children matching the given paths (eg it doesn't traverse down) - additionally for paths with globs (eg /a/b/**
/
*.jsp) it adds a deep NODE_REMOVED filter explicitly for that path using the same method as withIncludeSubtreeOnRemove does, but only limited to said path. So in this case you get a NODE_REMOVED for all *.jsp that are deleted in a subtree individually
Note that unlike 'normal' include and exclude paths, this variant doesn't apply Oak's NamePathMapper on the ancestors of the registers paths.
Also note that this might disable 'observation prefiltering based on paths' (OAK-4796) on this listener.
- Specified by:
withIncludeAncestorsRemove
in classOakEventFilter
- Returns:
- this filter with the filter change applied
-
wrapMainCondition
public FilterBuilder.Condition wrapMainCondition(FilterBuilder.Condition mainCondition, FilterBuilder filterBuilder, PermissionProviderFactory permissionProviderFactory) -
withIncludeSubtreeOnRemove
Description copied from class:OakEventFilter
This flag causes remove events to be sent for all nodes and properties of an entire subtree (hence use with care!).It is only applied when a parent node is actually removed. For a parent node move this is not applied.
- Specified by:
withIncludeSubtreeOnRemove
in classOakEventFilter
- Returns:
- this filter with the filter change applied
-
withIncludeGlobPaths
Description copied from class:OakEventFilter
Adds the provided glob paths to the set of include paths.The definition of a glob path is here
Note that unlike 'normal' include and exclude paths, this variant doesn't apply Oak's NamePathMapper.
This filter property is added in 'or' mode.
- Specified by:
withIncludeGlobPaths
in classOakEventFilter
- Parameters:
globPaths
- glob paths that should be added as include path pattern. Note that the NamePathMapper is not applied on these globPaths.- Returns:
- this filter with the filter change applied
-
builder
-
aggregator
-
getAdditionalIncludeConditions
-
getAggregator
-
withNodeTypeAggregate
Description copied from class:OakEventFilter
Greedy aggregating filter which upon first (hence greedy) hit of provided nodeTypes checks if the child subtree leading to the actual change matches any of the provided relativeGlobPaths.Note that unlike 'normal' include and exclude paths, this variant doesn't apply Oak's NamePathMapper.
This filter property is added in 'and' mode.
- Specified by:
withNodeTypeAggregate
in classOakEventFilter
- Parameters:
nodeTypes
- note that these nodeTypes are not mapped to oak nor validatedrelativeGlobPaths
- glob paths that are added to the set of include paths. To match the node with the desired node type itself, add an empty String ("") as one of the relativeGlobPaths too. Note that Oak's NamePathMapper is not applied to these relativeGlobPaths.- Returns:
- this filter with the filter change applied
-