|
|||||||||
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.unboundidds.controls.VirtualAttributesOnlyRequestControl
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class VirtualAttributesOnlyRequestControl
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.This class provides an implementation of the virtual attributes only request control, which may be included in a search request to indicate that only virtual attributes should be included in matching entries.
SearchRequest searchRequest = new SearchRequest("dc=example,dc=com", SearchScope.SUB, Filter.createEqualityFilter("uid", "john.doe")); searchRequest.addControl(new VirtualAttributesOnlyRequestControl()); SearchResult searchResult = connection.search(searchRequest);
Field Summary | |
---|---|
static java.lang.String |
VIRTUAL_ATTRIBUTES_ONLY_REQUEST_OID
The OID (2.16.840.1.113730.3.4.19) for the virtual attributes only request control. |
Constructor Summary | |
---|---|
VirtualAttributesOnlyRequestControl()
Creates a new virtual attributes only request control. |
|
VirtualAttributesOnlyRequestControl(boolean isCritical)
Creates a new virtual attributes only request control with the specified criticality. |
|
VirtualAttributesOnlyRequestControl(Control control)
Creates a new virtual attributes only request control which is decoded from the provided generic control. |
Method Summary | |
---|---|
java.lang.String |
getControlName()
Retrieves the user-friendly name for this control, if available. |
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 VIRTUAL_ATTRIBUTES_ONLY_REQUEST_OID
Constructor Detail |
---|
public VirtualAttributesOnlyRequestControl()
public VirtualAttributesOnlyRequestControl(boolean isCritical)
isCritical
- Indicates whether this control should be marked
critical.public VirtualAttributesOnlyRequestControl(Control control) throws LDAPException
control
- The generic control to be decoded as a virtual attributes
only request control.
LDAPException
- If the provided control cannot be decoded as a
virtual attributes only request control.Method Detail |
---|
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 |