Package com.unboundid.ldap.sdk.controls
Class RFC3672SubentriesRequestControl
- java.lang.Object
-
- com.unboundid.ldap.sdk.Control
-
- com.unboundid.ldap.sdk.controls.RFC3672SubentriesRequestControl
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class RFC3672SubentriesRequestControl extends Control
This class provides an implementation of the LDAP subentries request control as defined in RFC 3672. It may be included in a search request to indicate that entries with theldapSubEntry
object class should be included in the search results. The value of the control indicates whether entries matching the filter but not containing that object class (but ) should also be returned.
Entries containing theldapSubentry
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 theDraftLDUPSubentriesRequestControl
in that you can optionally also return entries that do not contain theldapSubEntry
object class, whereas theDraftLDUPSubentriesRequestControl
will cause only subentries to be returned.
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 RFC3672SubentriesRequestControl(true)); SearchResult resultWithControl = connection.search(searchRequest); LDAPTestUtils.assertResultCodeEquals(resultWithControl, ResultCode.SUCCESS); LDAPTestUtils.assertEntriesReturnedEquals(resultWithControl, 1);
- See Also:
DraftLDUPSubentriesRequestControl
, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
SUBENTRIES_REQUEST_OID
The OID (1.3.6.1.4.1.4203.1.10.1) for the LDAP subentries request control.
-
Constructor Summary
Constructors Constructor Description RFC3672SubentriesRequestControl(boolean returnOnlySubEntries)
Creates a new subentries request control.RFC3672SubentriesRequestControl(boolean returnOnlySubEntries, boolean isCritical)
Creates a new subentries request control with the specified criticality.RFC3672SubentriesRequestControl(Control control)
Creates a new subentries request control which is decoded from the provided generic control.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getControlName()
Retrieves the user-friendly name for this control, if available.boolean
returnOnlySubEntries()
Indicates whether the server should only return matching entries that have theldapSubEntry
object class.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, toJSONControl, toString, writeTo
-
-
-
-
Field Detail
-
SUBENTRIES_REQUEST_OID
@NotNull public static final java.lang.String SUBENTRIES_REQUEST_OID
The OID (1.3.6.1.4.1.4203.1.10.1) for the LDAP subentries request control.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
RFC3672SubentriesRequestControl
public RFC3672SubentriesRequestControl(boolean returnOnlySubEntries)
Creates a new subentries request control. it will not be marked critical.- Parameters:
returnOnlySubEntries
- Indicates whether to return only matching entries that contain theldapSubEntry
object class. If this istrue
, then only subentries will be returned. If this isfalse
, then both both regular entries and subentries may be returned.
-
RFC3672SubentriesRequestControl
public RFC3672SubentriesRequestControl(boolean returnOnlySubEntries, boolean isCritical)
Creates a new subentries request control with the specified criticality.- Parameters:
returnOnlySubEntries
- Indicates whether to return only matching entries that contain theldapSubEntry
object class. If this istrue
, then only subentries will be returned. If this isfalse
, then both both regular entries and subentries may be returned.isCritical
- Indicates whether this control should be marked critical.
-
RFC3672SubentriesRequestControl
public RFC3672SubentriesRequestControl(@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
-
returnOnlySubEntries
public boolean returnOnlySubEntries()
Indicates whether the server should only return matching entries that have theldapSubEntry
object class.- Returns:
true
if the server should only return matching entries that contain theldapSubEntry
object class, orfalse
if the server may return both regular entries and subentries.
-
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 classControl
- Returns:
- The user-friendly name for this control, or the OID if no user-friendly name is available.
-
-