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 interface FilterVisitor<R,P>
Filter
s, in the style of the visitor design pattern.
Classes implementing this interface can query filters in a type-safe manner. When a visitor is passed to a filter's accept method, the corresponding visit method most applicable to that filter is invoked.
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 |
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. |
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.
p
- A visitor specified parameter.subFilters
- The unmodifiable list of sub-filters.R visitApproxMatchFilter(P p, String attributeDescription, ByteString assertionValue)
approximate match
filter.p
- A visitor specified parameter.attributeDescription
- The attribute description.assertionValue
- The assertion value.R visitEqualityMatchFilter(P p, String attributeDescription, ByteString assertionValue)
equality match
filter.p
- A visitor specified parameter.attributeDescription
- The attribute description.assertionValue
- The assertion value.R visitExtensibleMatchFilter(P p, String matchingRule, String attributeDescription, ByteString assertionValue, boolean dnAttributes)
extensible
filter.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.R visitGreaterOrEqualFilter(P p, String attributeDescription, ByteString assertionValue)
greater or equal
filter.p
- A visitor specified parameter.attributeDescription
- The attribute description.assertionValue
- The assertion value.R visitLessOrEqualFilter(P p, String attributeDescription, ByteString assertionValue)
less or equal
filter.p
- A visitor specified parameter.attributeDescription
- The attribute description.assertionValue
- The assertion value.R visitNotFilter(P p, Filter subFilter)
not
filter.p
- A visitor specified parameter.subFilter
- The sub-filter.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.
p
- A visitor specified parameter.subFilters
- The unmodifiable list of sub-filters.R visitPresentFilter(P p, String attributeDescription)
present
filter.p
- A visitor specified parameter.attributeDescription
- The attribute description.R visitSubstringsFilter(P p, String attributeDescription, ByteString initialSubstring, List<ByteString> anySubstrings, ByteString finalSubstring)
substrings
filter.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
.R visitUnrecognizedFilter(P p, byte filterTag, ByteString filterBytes)
unrecognized
filter.p
- A visitor specified parameter.filterTag
- The ASN.1 tag.filterBytes
- The filter content.Copyright 2010-2020 ForgeRock AS.