Package org.ldaptive.control
Class MatchedValuesRequestControl
- java.lang.Object
-
- org.ldaptive.control.AbstractControl
-
- org.ldaptive.control.MatchedValuesRequestControl
-
- All Implemented Interfaces:
Control
,RequestControl
public class MatchedValuesRequestControl extends AbstractControl implements RequestControl
Request control for limiting the attribute values returned by a search request. See https://tools.ietf.org/html/rfc3876. Control is defined as:ValuesReturnFilter ::= SEQUENCE OF SimpleFilterItem SimpleFilterItem ::= CHOICE { equalityMatch [3] AttributeValueAssertion, substrings [4] SubstringFilter, greaterOrEqual [5] AttributeValueAssertion, lessOrEqual [6] AttributeValueAssertion, present [7] AttributeDescription, approxMatch [8] AttributeValueAssertion, extensibleMatch [9] SimpleMatchingAssertion } SimpleMatchingAssertion ::= SEQUENCE { matchingRule [1] MatchingRuleId OPTIONAL, type [2] AttributeDescription OPTIONAL, --- at least one of the above must be present matchValue [3] AssertionValue}
- Author:
- Middleware Services
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
OID
OID of this control.-
Fields inherited from class org.ldaptive.control.AbstractControl
logger
-
-
Constructor Summary
Constructors Constructor Description MatchedValuesRequestControl()
Default constructor.MatchedValuesRequestControl(java.lang.String... filters)
Creates a new matched values request control.MatchedValuesRequestControl(java.lang.String[] filters, boolean critical)
Creates a new matched values request control.MatchedValuesRequestControl(Filter... filters)
Creates a new matched values request control.MatchedValuesRequestControl(Filter[] filters, boolean critical)
Creates a new matched values request control.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description byte[]
encode()
Provides the BER encoding of this control.boolean
equals(java.lang.Object o)
Filter[]
getMatchedValuesFilters()
Returns the filters to use for matching values.int
hashCode()
Returns the hash code for this object.boolean
hasValue()
Returns whether the control has a value associated with it.void
setMatchedValuesFilters(java.lang.String... filters)
Sets the filters to use for matching values.void
setMatchedValuesFilters(Filter... filters)
Sets the filters to use for matching values.java.lang.String
toString()
-
Methods inherited from class org.ldaptive.control.AbstractControl
getCriticality, getOID
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.ldaptive.control.Control
getCriticality, getOID
-
-
-
-
Field Detail
-
OID
public static final java.lang.String OID
OID of this control.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
MatchedValuesRequestControl
public MatchedValuesRequestControl()
Default constructor.
-
MatchedValuesRequestControl
public MatchedValuesRequestControl(java.lang.String... filters)
Creates a new matched values request control.- Parameters:
filters
- to use for value matching
-
MatchedValuesRequestControl
public MatchedValuesRequestControl(java.lang.String[] filters, boolean critical)
Creates a new matched values request control.- Parameters:
filters
- to use for value matchingcritical
- whether this control is critical
-
MatchedValuesRequestControl
public MatchedValuesRequestControl(Filter... filters)
Creates a new matched values request control.- Parameters:
filters
- to use for value matching
-
MatchedValuesRequestControl
public MatchedValuesRequestControl(Filter[] filters, boolean critical)
Creates a new matched values request control.- Parameters:
filters
- to use for value matchingcritical
- whether this control is critical
-
-
Method Detail
-
hasValue
public boolean hasValue()
Description copied from interface:RequestControl
Returns whether the control has a value associated with it.- Specified by:
hasValue
in interfaceRequestControl
- Returns:
- whether the control has a value
-
getMatchedValuesFilters
public Filter[] getMatchedValuesFilters()
Returns the filters to use for matching values.- Returns:
- matched values filters
-
setMatchedValuesFilters
public void setMatchedValuesFilters(java.lang.String... filters)
Sets the filters to use for matching values.- Parameters:
filters
- for matching values- Throws:
java.lang.IllegalArgumentException
- if the filter cannot be parsed or is not allowed
-
setMatchedValuesFilters
public void setMatchedValuesFilters(Filter... filters)
Sets the filters to use for matching values.- Parameters:
filters
- for matching values- Throws:
java.lang.IllegalArgumentException
- if the filter is not allowed
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classAbstractControl
-
hashCode
public int hashCode()
Description copied from class:AbstractControl
Returns the hash code for this object.- Specified by:
hashCode
in classAbstractControl
- Returns:
- hash code
-
toString
public java.lang.String toString()
- Overrides:
toString
in classAbstractControl
-
encode
public byte[] encode()
Description copied from interface:RequestControl
Provides the BER encoding of this control.- Specified by:
encode
in interfaceRequestControl
- Returns:
- BER encoded request control
-
-