@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class DraftLDUPSubentriesRequestControl extends Control
ldapSubentry
object
class should be included in the search results.
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.
// 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);
RFC3672SubentriesRequestControl
,
Serialized FormModifier 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 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.
|
Modifier and Type | Method and Description |
---|---|
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.
|
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, registerDecodeableControl, toString, writeTo
@NotNull public static final java.lang.String SUBENTRIES_REQUEST_OID
public DraftLDUPSubentriesRequestControl()
public DraftLDUPSubentriesRequestControl(boolean isCritical)
isCritical
- Indicates whether this control should be marked
critical.public DraftLDUPSubentriesRequestControl(@NotNull Control control) throws LDAPException
control
- The generic control to be decoded as a subentries request
control.LDAPException
- If the provided control cannot be decoded as a
subentries request control.@NotNull public java.lang.String getControlName()
getControlName
in class Control