|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.controls.MatchedValuesRequestControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class MatchedValuesRequestControl
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
MatchedValuesFilter
s 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.
description
" attribute
to be returned in which those values start with the letter f:
// Ensure that a test user has multiple description values. LDAPResult modifyResult = connection.modify( "uid=test.user,ou=People,dc=example,dc=com", new Modification(ModificationType.REPLACE, "description", // Attribute name "first", "second", "third", "fourth")); // Attribute values. assertResultCodeEquals(modifyResult, ResultCode.SUCCESS); // Perform a search to retrieve the test user entry without using the // matched values request control. This should return all four description // values. SearchRequest searchRequest = new SearchRequest( "uid=test.user,ou=People,dc=example,dc=com", // Base DN SearchScope.BASE, // Scope Filter.createPresenceFilter("objectClass"), // Filter "description"); // Attributes to return. SearchResultEntry entryRetrievedWithoutControl = connection.searchForEntry(searchRequest); Attribute fullDescriptionAttribute = entryRetrievedWithoutControl.getAttribute("description"); int numFullDescriptionValues = fullDescriptionAttribute.size(); // Update the search request to include a matched values control that will // only return values that start with the letter "f". In our test entry, // this should just match two values ("first" and "fourth"). searchRequest.addControl(new MatchedValuesRequestControl( MatchedValuesFilter.createSubstringFilter("description", // Attribute "f", // subInitial component null, // subAny components null))); // subFinal component SearchResultEntry entryRetrievedWithControl = connection.searchForEntry(searchRequest); Attribute partialDescriptionAttribute = entryRetrievedWithControl.getAttribute("description"); int numPartialDescriptionValues = partialDescriptionAttribute.size();
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 |
---|
public static final java.lang.String MATCHED_VALUES_REQUEST_OID
Constructor Detail |
---|
public MatchedValuesRequestControl(MatchedValuesFilter... filters)
filters
- The set of filters to use for this control. At least one
filter must be provided.public MatchedValuesRequestControl(boolean isCritical, MatchedValuesFilter... filters)
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.public MatchedValuesRequestControl(Control control) throws LDAPException
control
- The generic control to be decoded as a matched values
request control.
LDAPException
- If the provided control cannot be decoded as a
matched values request control.Method Detail |
---|
public MatchedValuesFilter[] getFilters()
public java.lang.String getControlName()
getControlName
in class Control
public void toString(java.lang.StringBuilder buffer)
toString
in class Control
buffer
- The buffer to which to append the string representation of
this buffer.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |