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
,java.io.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 aGetSubtreeAccessibilityExtendedRequest
.
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), ... }, bypassUserDN [2] LDAPDN OPTIONAL, effectiveTime [3] OCTET STRING, ... }
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
GET_SUBTREE_ACCESSIBILITY_RESULT_OID
The OID (1.3.6.1.4.1.30221.1.6.21) for the get subtree accessibility extended result.-
Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse
NO_CONTROLS
-
-
Constructor Summary
Constructors Constructor Description GetSubtreeAccessibilityExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, java.util.Collection<SubtreeAccessibilityRestriction> restrictions, Control... responseControls)
Creates a new get subtree accessibility extended result with the provided information.GetSubtreeAccessibilityExtendedResult(ExtendedResult extendedResult)
Creates a new get subtree accessibility extended result from the provided generic extended result.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<SubtreeAccessibilityRestriction>
getAccessibilityRestrictions()
Retrieves a list of the subtree accessibility restrictions defined in the server.java.lang.String
getExtendedResultName()
Retrieves the user-friendly name for the extended result, if available.void
toString(java.lang.StringBuilder buffer)
Appends a string representation of this extended response to the provided buffer.-
Methods inherited from class com.unboundid.ldap.sdk.ExtendedResult
getOID, getValue, hasValue, toString
-
Methods inherited from class com.unboundid.ldap.sdk.LDAPResult
getDiagnosticMessage, getMatchedDN, getMessageID, getReferralURLs, getResponseControl, getResponseControls, getResultCode, getResultString, hasResponseControl, hasResponseControl
-
-
-
-
Field Detail
-
GET_SUBTREE_ACCESSIBILITY_RESULT_OID
public static final java.lang.String GET_SUBTREE_ACCESSIBILITY_RESULT_OID
The OID (1.3.6.1.4.1.30221.1.6.21) for the get subtree accessibility extended result.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
GetSubtreeAccessibilityExtendedResult
public GetSubtreeAccessibilityExtendedResult(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, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, java.util.Collection<SubtreeAccessibilityRestriction> restrictions, 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 benull
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 Detail
-
getAccessibilityRestrictions
public java.util.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
public java.lang.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, thennull
will be returned.- Overrides:
getExtendedResultName
in classExtendedResult
- 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(java.lang.StringBuilder buffer)
Appends a string representation of this extended response to the provided buffer.- Specified by:
toString
in interfaceLDAPResponse
- Overrides:
toString
in classExtendedResult
- Parameters:
buffer
- The buffer to which a string representation of this extended response will be appended.
-
-