com.unboundid.ldap.sdk.unboundidds.controls
Class VirtualAttributesOnlyRequestControl

java.lang.Object
  extended by com.unboundid.ldap.sdk.Control
      extended by com.unboundid.ldap.sdk.unboundidds.controls.VirtualAttributesOnlyRequestControl
All Implemented Interfaces:
java.io.Serializable

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

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.

This control is not based on any public standard, but was first introduced in the Netscape/iPlanet Directory Server. It is also supported in the Sun Java System Directory Server, OpenDS, and the UnboundID Directory Server. It does not have a value.

Example

The following example demonstrates the use of the virtual attributes only request control:
 SearchRequest searchRequest = new SearchRequest("dc=example,dc=com",
      SearchScope.SUB, Filter.createEqualityFilter("uid", "john.doe"));

 searchRequest.addControl(new VirtualAttributesOnlyRequestControl());
 SearchResult searchResult = connection.search(searchRequest);
 

See Also:
Serialized Form

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

VIRTUAL_ATTRIBUTES_ONLY_REQUEST_OID

public static final 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.

See Also:
Constant Field Values
Constructor Detail

VirtualAttributesOnlyRequestControl

public VirtualAttributesOnlyRequestControl()
Creates a new virtual attributes only request control. It will not be marked critical.


VirtualAttributesOnlyRequestControl

public VirtualAttributesOnlyRequestControl(boolean isCritical)
Creates a new virtual attributes only request control with the specified criticality.

Parameters:
isCritical - Indicates whether this control should be marked critical.

VirtualAttributesOnlyRequestControl

public VirtualAttributesOnlyRequestControl(Control control)
                                    throws LDAPException
Creates a new virtual attributes only request control which is decoded from the provided generic control.

Parameters:
control - The generic control to be decoded as a virtual attributes only request control.
Throws:
LDAPException - If the provided control cannot be decoded as a virtual attributes only request control.
Method Detail

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.