org.forgerock.opendj.ldap.controls

Class SubentriesRequestControl

java.lang.Object

org.forgerock.opendj.ldap.controls.SubentriesRequestControl

All Implemented Interfaces:

Control

public final class SubentriesRequestControl
extends Object
implements Control

The sub-entries request control as defined in RFC 3672. This control may be included in a search request to indicate that sub-entries should be included in the search results.

In the absence of the sub-entries request control, sub-entries are not visible to search operations unless the target/base of the operation is a sub-entry. In the presence of the sub-entry request control, sub-entries are visible if and only if the control's value is TRUE.

Consider "Class of Service" sub-entries such as the following:

 dn: cn=Gold Class of Service,dc=example,dc=com
 objectClass: collectiveAttributeSubentry
 objectClass: extensibleObject
 objectClass: subentry
 objectClass: top
 cn: Gold Class of Service
 diskQuota;collective: 100 GB
 mailQuota;collective: 10 GB
 subtreeSpecification: { base "ou=People", specificationFilter "(classOfService=
  gold)" }
 

To access the sub-entries in your search, use the control with value TRUE.

 Connection connection = ...;

 SearchRequest request = Requests.newSearchRequest("dc=example,dc=com",
         SearchScope.WHOLE_SUBTREE, "cn=*Class of Service", "cn", "subtreeSpecification")
         .addControl(SubentriesRequestControl.newControl(true, true));
  
 ConnectionEntryReader reader = connection.search(request);
 while (reader.hasNext()) {
     if (reader.isEntry()) {
         SearchResultEntry entry = reader.readEntry();
         // ...
     }
 }
 

See Also:

RFC 3672 - Subentries in the Lightweight Directory Access Protocol

Field Summary

Fields

Modifier and Type	Field and Description
static ControlDecoder<SubentriesRequestControl>	DECODER A decoder which can be used for decoding the sub-entries request control.
static String	OID The OID for the sub-entries request control.

Method Summary

Modifier and Type	Method and Description
String	getOid() Returns the numeric OID associated with this control.
ByteString	getValue() Returns the value, if any, associated with this control.
boolean	getVisibility() Returns a boolean indicating whether sub-entries should be included in the search results.
boolean	hasValue() Returns true if this control has a value.
boolean	isCritical() Returns true if it is unacceptable to perform the operation without applying the semantics of this control.
static SubentriesRequestControl	newControl(boolean isCritical, boolean visibility) Creates a new sub-entries request control having the provided criticality and sub-entry visibility.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

OID

public static final String OID

The OID for the sub-entries request control.

See Also:

Constant Field Values

DECODER

public static final ControlDecoder<SubentriesRequestControl> DECODER

A decoder which can be used for decoding the sub-entries request control.

Method Detail

newControl

public static SubentriesRequestControl newControl(boolean isCritical,
                                                  boolean visibility)

Creates a new sub-entries request control having the provided criticality and sub-entry visibility.

Parameters:

isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored.

visibility - true if sub-entries should be included in the search results and normal entries excluded, or false if normal entries should be included and sub-entries excluded.

Returns:

The new control.

getOid

public String getOid()

Description copied from interface: Control

Returns the numeric OID associated with this control.

Specified by:

getOid in interface Control

Returns:

The numeric OID associated with this control.

getValue

public ByteString getValue()

Description copied from interface: Control

Returns the value, if any, associated with this control. Its format is defined by the specification of this control.

Specified by:

getValue in interface Control

Returns:

The value associated with this control, or null if there is no value.

getVisibility

public boolean getVisibility()

Returns a boolean indicating whether sub-entries should be included in the search results.

Returns:

true if sub-entries should be included in the search results and normal entries excluded, or false if normal entries should be included and sub-entries excluded.

hasValue

public boolean hasValue()

Description copied from interface: Control

Returns true if this control has a value. In some circumstances it may be useful to determine if a control has a value, without actually calculating the value and incurring any performance costs.

Specified by:

hasValue in interface Control

Returns:

true if this control has a value, or false if there is no value.

isCritical

public boolean isCritical()

Description copied from interface: Control

Returns true if it is unacceptable to perform the operation without applying the semantics of this control.

The criticality field only has meaning in controls attached to request messages (except UnbindRequest). For controls attached to response messages and the UnbindRequest, the criticality field SHOULD be false, and MUST be ignored by the receiving protocol peer. A value of true indicates that it is unacceptable to perform the operation without applying the semantics of the control.

Specified by:

isCritical in interface Control

Returns:

true if this control must be processed by the Directory Server, or false if it can be ignored.

toString

public String toString()

Overrides:

toString in class Object