com.unboundid.ldap.sdk.unboundidds.controls

Class VirtualAttributesOnlyRequestControl

java.lang.Object

com.unboundid.ldap.sdk.Control

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

All Implemented Interfaces:

java.io.Serializable

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

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.

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.

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 Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 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

Fields

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 Summary

Constructors

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.

Method Summary

Modifier and Type	Method and Description
static VirtualAttributesOnlyRequestControl	decodeJSONControl(JSONObject controlObject, boolean strict) Attempts to decode the provided object as a JSON representation of a virtual attributes only request control.
java.lang.String	getControlName() Retrieves the user-friendly name for this control, if available.
JSONObject	toJSONControl() Retrieves a representation of this virtual attributes only request control as a JSON object.
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, decodeJSONControl, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, 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

@NotNull
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(@NotNull
                                           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

@NotNull
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.

toJSONControl

@NotNull
public JSONObject toJSONControl()

Retrieves a representation of this virtual attributes only request control as a JSON object. The JSON object uses the following fields (note that since this control does not have a value, neither the value-base64 nor value-json fields may be present):

• oid -- A mandatory string field whose value is the object identifier for this control. For the virtual attributes only request control, the OID is "2.16.840.1.113730.3.4.19".
• control-name -- An optional string field whose value is a human-readable name for this control. This field is only intended for descriptive purposes, and when decoding a control, the oid field should be used to identify the type of control.
• criticality -- A mandatory Boolean field used to indicate whether this control is considered critical.

Overrides:

toJSONControl in class Control

Returns:

A JSON object that contains a representation of this control.

decodeJSONControl

@NotNull
public static VirtualAttributesOnlyRequestControl decodeJSONControl(@NotNull
                                                                             JSONObject controlObject,
                                                                             boolean strict)
                                                                      throws LDAPException

Attempts to decode the provided object as a JSON representation of a virtual attributes only request control.

Parameters:

controlObject - The JSON object to be decoded. It must not be null.

strict - Indicates whether to use strict mode when decoding the provided JSON object. If this is true, then this method will throw an exception if the provided JSON object contains any unrecognized fields. If this is false, then unrecognized fields will be ignored.

Returns:

The virtual attributes only request control that was decoded from the provided JSON object.

Throws:

LDAPException - If the provided JSON object cannot be parsed as a valid virtual attributes only request control.

toString

public void toString(@NotNull
                     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.