Package com.unboundid.ldap.sdk.unboundidds.extensions

Class GetSubtreeAccessibilityExtendedResult

java.lang.Object
com.unboundid.ldap.sdk.LDAPResult
com.unboundid.ldap.sdk.ExtendedResult
com.unboundid.ldap.sdk.unboundidds.extensions.GetSubtreeAccessibilityExtendedResult
All Implemented Interfaces:
LDAPResponse, Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetSubtreeAccessibilityExtendedResult extends ExtendedResult
This class provides an implementation of an extended result that holds information about the response returned from a GetSubtreeAccessibilityExtendedRequest.
NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

It has an OID of 1.3.6.1.4.1.30221.1.6.21, and successful responses will have a value with the following encoding: 

   GetSubtreeAccessibilityResultValue ::= SEQUENCE OF SEQUENCE {
        subtreeBaseDN            [0] LDAPDN,
        subtreeAccessibility     [1] ENUMERATED {
             accessible                 (0),
             read-only-bind-allowed     (1),
             read-only-bind-denied      (2),
             hidden                     (3),
             to-be-deleted              (4),
             ... },
        bypassUserDN             [2] LDAPDN OPTIONAL,
        effectiveTime            [3] OCTET STRING,
        ... }
See Also:

  • Field Details

  • Constructor Details

    • GetSubtreeAccessibilityExtendedResult

      public GetSubtreeAccessibilityExtendedResult(@NotNull ExtendedResult extendedResult) throws LDAPException
      Creates a new get subtree accessibility extended result from the provided generic extended result.
      Parameters:
      extendedResult - The generic extended result to be decoded.
      Throws:
      LDAPException - If a problem occurs while attempting to decode the provided extended result as a get connection ID result.

    • GetSubtreeAccessibilityExtendedResult

      public GetSubtreeAccessibilityExtendedResult(int messageID, @NotNull ResultCode resultCode, @Nullable String diagnosticMessage, @Nullable String matchedDN, @Nullable String[] referralURLs, @Nullable Collection<SubtreeAccessibilityRestriction> restrictions, @Nullable Control... responseControls)
      Creates a new get subtree accessibility extended result with the provided information.
      Parameters:
      messageID - The message ID for the LDAP message that is associated with this LDAP result.
      resultCode - The result code from the response.
      diagnosticMessage - The diagnostic message from the response, if available.
      matchedDN - The matched DN from the response, if available.
      referralURLs - The set of referral URLs from the response, if available.
      restrictions - The set of subtree accessibility restrictions to include in the response. It may be null if this represents an error response, or it may be empty if there are no subtree accessibility restrictions defined in the server.
      responseControls - The set of controls from the response, if available.

  • Method Details

    • getAccessibilityRestrictions

      @Nullable public List<SubtreeAccessibilityRestriction> getAccessibilityRestrictions()
      Retrieves a list of the subtree accessibility restrictions defined in the server.
      Returns:
      A list of the subtree accessibility restrictions defined in the server, an empty list if there are no restrictions defined, or null if no restriction data was included in the response from the server (e.g., because it was an error response).

    • getExtendedResultName

      @NotNull public String getExtendedResultName()
      Retrieves the user-friendly name for the extended result, if available. If no user-friendly name has been defined, but a response OID is available, then that will be returned. If neither a user-friendly name nor a response OID are available, then null will be returned.
      Overrides:
      getExtendedResultName in class ExtendedResult
      Returns:
      The user-friendly name for this extended request, the response OID if a user-friendly name is not available but a response OID is, or null if neither a user-friendly name nor a response OID are available.

    • toString

      public void toString(@NotNull StringBuilder buffer)
      Appends a string representation of this extended response to the provided buffer.
      Specified by:
      toString in interface LDAPResponse
      Overrides:
      toString in class ExtendedResult
      Parameters:
      buffer - The buffer to which a string representation of this extended response will be appended.