Skip navigation links

Oracle® Fusion Middleware Java API Reference for Oracle Unified Directory
11g Release 2 (11.1.2.2.0)

E38583-02


oracle.oud.types
Interface Filter


public interface Filter

A search filter as defined in RFC 4511.

Applications interact with a filter using FilterVisitor which is applied to a filter using the accept(FilterVisitor, Object) method.

The RFC 4515 string representation of a filter can be generated using the toString() method.

Creation of types of Filter is provided for

A generic builder of Filter is also available from newFilter(String)

See Also:
RFC 4511 - Lightweight Directory Access Protocol (LDAP): The Protocol , RFC 4515 - String Representation of Search Filters , RFC 4526 - Absolute True and False Filters

Method Summary
<R,P> R
accept(FilterVisitor<R,P> v, P p)
          Applies a FilterVisitor to this Filter.
 ConditionResult matches(Entry entry)
          Indicates whether this Filter matches the provided Entry.
 java.lang.String toString()
          Returns a String whose contents is the LDAP string representation of this Filter.

 

Method Detail

accept

<R,P> R accept(FilterVisitor<R,P> v,
               P p)
Applies a FilterVisitor to this Filter.
Type Parameters:
R - The return type of the visitor's methods.
P - The type of the additional parameters to the visitor's methods.
Parameters:
v - The filter visitor.
p - Optional additional visitor parameter.
Returns:
A result as specified by the visitor.

matches

ConditionResult matches(Entry entry)
                        throws PluginException
Indicates whether this Filter matches the provided Entry.
Parameters:
entry - The entry to be matched.
Returns:
true if this Filter matches the provided Entry.
Throws:
PluginException - if the provided entry is invalid.

toString

java.lang.String toString()
Returns a String whose contents is the LDAP string representation of this Filter.
Overrides:
toString in class java.lang.Object
Returns:
The LDAP string representation of this Filter.

Skip navigation links

Oracle® Fusion Middleware Java API Reference for Oracle Unified Directory
11g Release 2 (11.1.2.2.0)

E38583-02


Copyright © 2013, Oracle and/or its affiliates. All rights reserved.