oracle.oud.controls

Interface MatchedValuesRequestControl

All Superinterfaces:

Control

public interface MatchedValuesRequestControl
extends Control

The matched values request control as defined in RFC 3876. The matched values control may be included in a search request to indicate that only attribute values matching one or more filters contained in the matched values control should be returned to the client.

The matched values request control supports a subset of the LDAP filter type defined in RFC 4511, and is defined as follows:

 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}
 

See Also:

RFC 3876 - Returning Matched Values with the Lightweight Directory Access Protocol version 3 (LDAPv3)

Field Summary

Fields

Modifier and Type	Field and Description
static ControlDecoder<MatchedValuesRequestControl>	DECODER A decoder which can be used for decoding the matched values request control.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<Filter>	getFilters() Returns an unmodifiable collection containing the list of filters associated with this matched values control.

Methods inherited from interface oracle.oud.controls.Control

getAPIValue, getDetails, getOID, hasValue, isCritical

Field Detail

DECODER

static final ControlDecoder<MatchedValuesRequestControl> DECODER

A decoder which can be used for decoding the matched values request control.

Method Detail

getFilters

java.util.Collection<Filter> getFilters()

Returns an unmodifiable collection containing the list of filters associated with this matched values control.

Returns:

An unmodifiable collection containing the list of filters associated with this matched values control.