com.unboundid.ldap.sdk.controls

Class DraftLDUPSubentriesRequestControl

java.lang.Object

com.unboundid.ldap.sdk.Control

com.unboundid.ldap.sdk.controls.DraftLDUPSubentriesRequestControl

All Implemented Interfaces:

java.io.Serializable

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

This class provides an implementation of the LDAP subentries request control as defined in draft-ietf-ldup-subentry. It may be included in a search request to indicate that the entries with the ldapSubentry object class should be included in the search results.

Entries containing the ldapSubentry object class are special in that they are normally excluded from search results, unless the target entry is requested with a base-level search. They are used to store operational information that controls how the server should behave rather than user data. Because they do not hold user data, it is generally desirable to have them excluded from search results, but for cases in which a client needs to retrieve such an entry, then this subentries request control may be included in the search request. This control differs from the RFC3672SubentriesRequestControl in that it will cause only entries with the ldapSubEntry object class to be returned, while the RFC3672SubentriesRequestControl may optionally return both regular entries and subentries.

There is no corresponding response control.

Example

The following example illustrates the use of the subentries request control to retrieve subentries that may not otherwise be returned.

 // First, perform a search to retrieve an entry with a cn of "test subentry"
 // but without including the subentries request control.  This should not
 // return any matching entries.
 SearchRequest searchRequest = new SearchRequest("dc=example,dc=com",
      SearchScope.SUB, Filter.createEqualityFilter("cn", "test subentry"));
 SearchResult resultWithoutControl = connection.search(searchRequest);
 LDAPTestUtils.assertResultCodeEquals(resultWithoutControl,
      ResultCode.SUCCESS);
 LDAPTestUtils.assertEntriesReturnedEquals(resultWithoutControl, 0);

 // Update the search request to add a subentries request control so that
 // subentries should be included in search results.  This should cause the
 // subentry to be returned.
 searchRequest.addControl(new DraftLDUPSubentriesRequestControl());
 SearchResult resultWithControl = connection.search(searchRequest);
 LDAPTestUtils.assertResultCodeEquals(resultWithControl, ResultCode.SUCCESS);
 LDAPTestUtils.assertEntriesReturnedEquals(resultWithControl, 1);
 

See Also:

RFC3672SubentriesRequestControl, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SUBENTRIES_REQUEST_OID The OID (1.3.6.1.4.1.7628.5.101.1) for the LDAP subentries request control.

Constructor Summary

Constructors

Constructor and Description
DraftLDUPSubentriesRequestControl() Creates a new subentries request control.
DraftLDUPSubentriesRequestControl(boolean isCritical) Creates a new subentries request control with the specified criticality.
DraftLDUPSubentriesRequestControl(Control control) Creates a new subentries request control which is decoded from the provided generic control.

Method Summary

Modifier and Type	Method and Description
static DraftLDUPSubentriesRequestControl	decodeJSONControl(JSONObject controlObject, boolean strict) Attempts to decode the provided object as a JSON representation of an subentries request control.
java.lang.String	getControlName() Retrieves the user-friendly name for this control, if available.
JSONObject	toJSONControl() Retrieves a representation of this subentries 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

SUBENTRIES_REQUEST_OID

@NotNull
public static final java.lang.String SUBENTRIES_REQUEST_OID

The OID (1.3.6.1.4.1.7628.5.101.1) for the LDAP subentries request control.

See Also:

Constant Field Values

Constructor Detail

DraftLDUPSubentriesRequestControl

public DraftLDUPSubentriesRequestControl()

Creates a new subentries request control. it will not be marked critical.

DraftLDUPSubentriesRequestControl

public DraftLDUPSubentriesRequestControl(boolean isCritical)

Creates a new subentries request control with the specified criticality.

Parameters:

isCritical - Indicates whether this control should be marked critical.

DraftLDUPSubentriesRequestControl

public DraftLDUPSubentriesRequestControl(@NotNull
                                         Control control)
                                  throws LDAPException

Creates a new subentries request control which is decoded from the provided generic control.

Parameters:

control - The generic control to be decoded as a subentries request control.

Throws:

LDAPException - If the provided control cannot be decoded as a subentries 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 subentries 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 subentries control, the OID is "1.3.6.1.4.1.7628.5.101.1".
• 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 DraftLDUPSubentriesRequestControl decodeJSONControl(@NotNull
                                                                           JSONObject controlObject,
                                                                           boolean strict)
                                                                    throws LDAPException

Attempts to decode the provided object as a JSON representation of an subentries 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 subentries request control that was decoded from the provided JSON object.

Throws:

LDAPException - If the provided JSON object cannot be parsed as a valid subentries 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.