com.unboundid.ldap.sdk.controls
Class MatchedValuesRequestControl

java.lang.Object
  com.unboundid.ldap.sdk.Control
      com.unboundid.ldap.sdk.controls.MatchedValuesRequestControl

All Implemented Interfaces:

java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class MatchedValuesRequestControl
extends Control

This class provides an implementation of the matched values request control as defined in RFC 3876. It should only be used with a search request, in which case it indicates that only attribute values matching at least one of the provided MatchedValuesFilters should be included in matching entries. That is, this control may be used to restrict the set of values included in the entries that are returned. This is particularly useful for multivalued attributes with a large number of values when only a small number of values are of interest to the client.

There are no corresponding response controls included in the search result entry, search result reference, or search result done messages returned for the associated search request.

Example

The following example demonstrates the use of the matched values request control. It will cause only values of the "myIntValues" attribute to be returned in which those values are greater than or equal to five:

   SearchRequest searchRequest =
        new SearchRequest("uid=john.doe,ou=People,dc=example,dc=com",
                          SearchScope.BASE, "(objectClass=*)", "myIntValues");
   searchRequest.addControl(new MatchedValuesRequestControl(
        MatchedValuesFilter.createGreaterOrEqualFilter("myIntValues", "5"));
   SearchResult result = connection.search(searchRequest);
 

See Also:

Serialized Form

Field Summary

static java.lang.String

MATCHED_VALUES_REQUEST_OID The OID (1.2.826.0.1.3344810.2.3) for the matched values request control.

Constructor Summary

MatchedValuesRequestControl(boolean isCritical, MatchedValuesFilter... filters)
Creates a new matched values request control with the provided criticality and set of filters.

MatchedValuesRequestControl(Control control)
Creates a new matched values request control which is decoded from the provided generic control.

MatchedValuesRequestControl(MatchedValuesFilter... filters)
Creates a new matched values request control with the provided set of filters.

Method Summary

java.lang.String	getControlName() Retrieves the user-friendly name for this control, if available.
MatchedValuesFilter[]	getFilters() Retrieves the set of filters for this matched values request control.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this LDAP control to the provided buffer.

Methods inherited from class com.unboundid.ldap.sdk.Control

decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, toString, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MATCHED_VALUES_REQUEST_OID

public static final java.lang.String MATCHED_VALUES_REQUEST_OID

The OID (1.2.826.0.1.3344810.2.3) for the matched values request control.

See Also:

Constant Field Values

Constructor Detail

MatchedValuesRequestControl

public MatchedValuesRequestControl(MatchedValuesFilter... filters)

Creates a new matched values request control with the provided set of filters. It will not be be marked as critical.

Parameters:

filters - The set of filters to use for this control. At least one filter must be provided.

MatchedValuesRequestControl

public MatchedValuesRequestControl(boolean isCritical,
                                   MatchedValuesFilter... filters)

Creates a new matched values request control with the provided criticality and set of filters.

Parameters:

isCritical - Indicates whether this control should be marked critical.

filters - The set of filters to use for this control. At least one filter must be provided.

MatchedValuesRequestControl

public MatchedValuesRequestControl(Control control)
                            throws LDAPException

Creates a new matched values request control which is decoded from the provided generic control.

Parameters:

control - The generic control to be decoded as a matched values request control.

Throws:

LDAPException - If the provided control cannot be decoded as a matched values request control.

Method Detail

getFilters

public MatchedValuesFilter[] getFilters()

Retrieves the set of filters for this matched values request control.

Returns:

The set of filters for this matched values request control.

getControlName

public java.lang.String getControlName()

Retrieves the user-friendly name for this control, if available. If no user-friendly name has been defined, then the OID will be returned.

Overrides:

getControlName in class Control

Returns:

The user-friendly name for this control, or the OID if no user-friendly name is available.

toString

public void toString(java.lang.StringBuilder buffer)

Appends a string representation of this LDAP control to the provided buffer.

Overrides:

toString in class Control

Parameters:

buffer - The buffer to which to append the string representation of this buffer.