Package com.unboundid.ldap.sdk.controls

Class SubentriesRequestControl

java.lang.Object
com.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.controls.SubentriesRequestControl
All Implemented Interfaces:
Serializable
@Deprecated @NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class SubentriesRequestControl extends Control
Deprecated.
This class has been deprecated because there are two competing specifications that can affect the visibility of entries with the ldapSubEntry object class: RFC 3672 and draft-ietf-lddup-subentry. This class implements support for the latter and remains fully functional, but you should use either the RFC3672SubentriesRequestControl class or the DraftLDUPSubentriesRequestControl class to avoid ambiguity.
NOTE: This class has been deprecated because there are two competing specifications that can affect the visibility of entries with the ldapSubEntry object class: RFC 3672 and draft-ietf-ldup-subentry. This class implements support for the latter and remains fully functional, but you should use either the RFC3672SubentriesRequestControl class or the DraftLDUPSubentriesRequestControl class to avoid ambiguity.

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.

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 SubentriesRequestControl());
 SearchResult resultWithControl = connection.search(searchRequest);
 LDAPTestUtils.assertResultCodeEquals(resultWithControl, ResultCode.SUCCESS);
 LDAPTestUtils.assertEntriesReturnedEquals(resultWithControl, 1);
See Also:

  • Field Details

  • Constructor Details

    • SubentriesRequestControl

      public SubentriesRequestControl()
      Deprecated.
      Creates a new subentries request control. it will not be marked critical.

    • SubentriesRequestControl

      public SubentriesRequestControl(boolean isCritical)
      Deprecated.
      Creates a new subentries request control with the specified criticality.
      Parameters:
      isCritical - Indicates whether this control should be marked critical.

    • SubentriesRequestControl

      public SubentriesRequestControl(@NotNull Control control) throws LDAPException
      Deprecated.
      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 Details

    • getControlName

      @NotNull public String getControlName()
      Deprecated.
      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.

    • toString

      public void toString(@NotNull StringBuilder buffer)
      Deprecated.
      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.