R
- The return type of this visitor's methods. Use
Void
for visitors that do not need to return
results.P
- The type of the additional parameter to this visitor's methods.
Use Void
for visitors that do not need an
additional parameter.public abstract class AbstractFilterVisitor<R,P> extends Object implements FilterVisitor<R,P>
Visitor
methods is to invoke visitDefaultFilter(Object)
.
Implementations can override the methods on a case by case behavior.
Modifier | Constructor and Description |
---|---|
protected |
AbstractFilterVisitor()
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
R |
visitAndFilter(P p,
List<Filter> subFilters)
Visits an
and filter. |
R |
visitApproxMatchFilter(P p,
String attributeDescription,
ByteString assertionValue)
Visits an
approximate match filter. |
R |
visitDefaultFilter(P p)
Visits any filters which are not explicitly handled by other visitor
methods.
|
R |
visitEqualityMatchFilter(P p,
String attributeDescription,
ByteString assertionValue)
Visits an
equality match filter. |
R |
visitExtensibleMatchFilter(P p,
String matchingRule,
String attributeDescription,
ByteString assertionValue,
boolean dnAttributes)
Visits an
extensible filter. |
R |
visitGreaterOrEqualFilter(P p,
String attributeDescription,
ByteString assertionValue)
Visits a
greater or equal filter. |
R |
visitLessOrEqualFilter(P p,
String attributeDescription,
ByteString assertionValue)
Visits a
less or equal filter. |
R |
visitNotFilter(P p,
Filter subFilter)
Visits a
not filter. |
R |
visitOrFilter(P p,
List<Filter> subFilters)
Visits an
or filter. |
R |
visitPresentFilter(P p,
String attributeDescription)
Visits a
present filter. |
R |
visitSubstringsFilter(P p,
String attributeDescription,
ByteString initialSubstring,
List<ByteString> anySubstrings,
ByteString finalSubstring)
Visits a
substrings filter. |
R |
visitUnrecognizedFilter(P p,
byte filterTag,
ByteString filterBytes)
Visits an
unrecognized filter. |
public R visitAndFilter(P p, List<Filter> subFilters)
and
filter.
Implementation note: for the purposes of matching an empty
sub-filter list should always evaluate to true
as per RFC 4526.
The default implementation is to call visitDefaultFilter(Object)
.
visitAndFilter
in interface FilterVisitor<R,P>
p
- A visitor specified parameter.subFilters
- The unmodifiable list of sub-filters.public R visitApproxMatchFilter(P p, String attributeDescription, ByteString assertionValue)
approximate match
filter.
The default implementation is to call visitDefaultFilter(Object)
.
visitApproxMatchFilter
in interface FilterVisitor<R,P>
p
- A visitor specified parameter.attributeDescription
- The attribute description.assertionValue
- The assertion value.public R visitDefaultFilter(P p)
The default implementation of this method is to return null
.
p
- A visitor specified parameter.public R visitEqualityMatchFilter(P p, String attributeDescription, ByteString assertionValue)
equality match
filter.
The default implementation is to call visitDefaultFilter(Object)
.
visitEqualityMatchFilter
in interface FilterVisitor<R,P>
p
- A visitor specified parameter.attributeDescription
- The attribute description.assertionValue
- The assertion value.public R visitExtensibleMatchFilter(P p, String matchingRule, String attributeDescription, ByteString assertionValue, boolean dnAttributes)
extensible
filter.
The default implementation is to call visitDefaultFilter(Object)
.
visitExtensibleMatchFilter
in interface FilterVisitor<R,P>
p
- A visitor specified parameter.matchingRule
- The matching rule name, may be null
if
attributeDescription
is specified.attributeDescription
- The attribute description, may be null
if
matchingRule
is specified.assertionValue
- The assertion value.dnAttributes
- Indicates whether DN matching should be performed.public R visitGreaterOrEqualFilter(P p, String attributeDescription, ByteString assertionValue)
greater or equal
filter.
The default implementation is to call visitDefaultFilter(Object)
.
visitGreaterOrEqualFilter
in interface FilterVisitor<R,P>
p
- A visitor specified parameter.attributeDescription
- The attribute description.assertionValue
- The assertion value.public R visitLessOrEqualFilter(P p, String attributeDescription, ByteString assertionValue)
less or equal
filter.
The default implementation is to call visitDefaultFilter(Object)
.
visitLessOrEqualFilter
in interface FilterVisitor<R,P>
p
- A visitor specified parameter.attributeDescription
- The attribute description.assertionValue
- The assertion value.public R visitNotFilter(P p, Filter subFilter)
not
filter.
The default implementation is to call visitDefaultFilter(Object)
.
visitNotFilter
in interface FilterVisitor<R,P>
p
- A visitor specified parameter.subFilter
- The sub-filter.public R visitOrFilter(P p, List<Filter> subFilters)
or
filter.
Implementation note: for the purposes of matching an empty
sub-filter list should always evaluate to false
as per RFC 4526.
The default implementation is to call visitDefaultFilter(Object)
.
visitOrFilter
in interface FilterVisitor<R,P>
p
- A visitor specified parameter.subFilters
- The unmodifiable list of sub-filters.public R visitPresentFilter(P p, String attributeDescription)
present
filter.
The default implementation is to call visitDefaultFilter(Object)
.
visitPresentFilter
in interface FilterVisitor<R,P>
p
- A visitor specified parameter.attributeDescription
- The attribute description.public R visitSubstringsFilter(P p, String attributeDescription, ByteString initialSubstring, List<ByteString> anySubstrings, ByteString finalSubstring)
substrings
filter.
The default implementation is to call visitDefaultFilter(Object)
.
visitSubstringsFilter
in interface FilterVisitor<R,P>
p
- A visitor specified parameter.attributeDescription
- The attribute description.initialSubstring
- The initial sub-string, may be null
.anySubstrings
- The unmodifiable list of any sub-strings, may be empty.finalSubstring
- The final sub-string, may be null
.public R visitUnrecognizedFilter(P p, byte filterTag, ByteString filterBytes)
unrecognized
filter.
The default implementation is to call visitDefaultFilter(Object)
.
visitUnrecognizedFilter
in interface FilterVisitor<R,P>
p
- A visitor specified parameter.filterTag
- The ASN.1 tag.filterBytes
- The filter content.Copyright 2010-2020 ForgeRock AS.