@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class VirtualAttributesOnlyRequestControl extends Control
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only
supported for use against Ping Identity, UnboundID, and
Nokia/Alcatel-Lucent 8661 server products. These classes provide support
for proprietary functionality or for external specifications that are not
considered stable or mature enough to be guaranteed to work in an
interoperable way with other types of LDAP servers.
SearchRequest searchRequest = new SearchRequest("dc=example,dc=com", SearchScope.SUB, Filter.createEqualityFilter("uid", "john.doe")); searchRequest.addControl(new VirtualAttributesOnlyRequestControl()); SearchResult searchResult = connection.search(searchRequest);
Modifier and Type | Field and Description |
---|---|
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 and Description |
---|
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.
|
Modifier and Type | Method and Description |
---|---|
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.
|
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toString, writeTo
@NotNull public static final java.lang.String VIRTUAL_ATTRIBUTES_ONLY_REQUEST_OID
public VirtualAttributesOnlyRequestControl()
public VirtualAttributesOnlyRequestControl(boolean isCritical)
isCritical
- Indicates whether this control should be marked
critical.public VirtualAttributesOnlyRequestControl(@NotNull 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.@NotNull public java.lang.String getControlName()
getControlName
in class Control