Class GetSubtreeAccessibilityExtendedRequest
- java.lang.Object
-
- com.unboundid.ldap.sdk.LDAPRequest
-
- com.unboundid.ldap.sdk.ExtendedRequest
-
- com.unboundid.ldap.sdk.unboundidds.extensions.GetSubtreeAccessibilityExtendedRequest
-
- All Implemented Interfaces:
ProtocolOp
,ReadOnlyLDAPRequest
,java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetSubtreeAccessibilityExtendedRequest extends ExtendedRequest
This class provides an implementation of the get subtree accessibility extended request, which may be used to request information about all subtree accessibility restrictions currently defined in the server, including for subtrees that are hidden or read-only. Subtree accessibility may be altered using theSetSubtreeAccessibilityExtendedRequest
.
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.
This extended request has an OID of 1.3.6.1.4.1.30221.1.6.20 and does not have a value.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
GET_SUBTREE_ACCESSIBILITY_REQUEST_OID
The OID (1.3.6.1.4.1.30221.1.6.20) for the get subtree accessibility extended request.-
Fields inherited from class com.unboundid.ldap.sdk.ExtendedRequest
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE
-
-
Constructor Summary
Constructors Constructor Description GetSubtreeAccessibilityExtendedRequest(Control... controls)
Creates a new get subtree accessibility extended request.GetSubtreeAccessibilityExtendedRequest(ExtendedRequest extendedRequest)
Creates a new get subtree accessibility extended request from the provided generic extended request.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GetSubtreeAccessibilityExtendedRequest
duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request.GetSubtreeAccessibilityExtendedRequest
duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request.java.lang.String
getExtendedRequestName()
Retrieves the user-friendly name for the extended request, if available.GetSubtreeAccessibilityExtendedResult
process(LDAPConnection connection, int depth)
Sends this extended request to the directory server over the provided connection and returns the associated response.void
toString(java.lang.StringBuilder buffer)
Appends a string representation of this request to the provided buffer.-
Methods inherited from class com.unboundid.ldap.sdk.ExtendedRequest
encodeProtocolOp, getLastMessageID, getOID, getOperationType, getProtocolOpType, getValue, hasValue, responseReceived, toCode, writeTo
-
Methods inherited from class com.unboundid.ldap.sdk.LDAPRequest
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getReferralConnector, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setReferralConnector, setResponseTimeoutMillis, toString
-
-
-
-
Field Detail
-
GET_SUBTREE_ACCESSIBILITY_REQUEST_OID
public static final java.lang.String GET_SUBTREE_ACCESSIBILITY_REQUEST_OID
The OID (1.3.6.1.4.1.30221.1.6.20) for the get subtree accessibility extended request.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
GetSubtreeAccessibilityExtendedRequest
public GetSubtreeAccessibilityExtendedRequest(Control... controls)
Creates a new get subtree accessibility extended request.- Parameters:
controls
- The set of controls to include in the request. It may benull
or empty if no controls are needed.
-
GetSubtreeAccessibilityExtendedRequest
public GetSubtreeAccessibilityExtendedRequest(ExtendedRequest extendedRequest) throws LDAPException
Creates a new get subtree accessibility extended request from the provided generic extended request.- Parameters:
extendedRequest
- The generic extended request to use to create this get subtree accessibility extended request.- Throws:
LDAPException
- If a problem occurs while decoding the request.
-
-
Method Detail
-
process
public GetSubtreeAccessibilityExtendedResult process(LDAPConnection connection, int depth) throws LDAPException
Sends this extended request to the directory server over the provided connection and returns the associated response.- Overrides:
process
in classExtendedRequest
- Parameters:
connection
- The connection to use to communicate with the directory server.depth
- The current referral depth for this request. It should always be one for the initial request, and should only be incremented when following referrals.- Returns:
- An LDAP result object that provides information about the result of the extended operation processing.
- Throws:
LDAPException
- If a problem occurs while sending the request or reading the response.
-
duplicate
public GetSubtreeAccessibilityExtendedRequest duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request.. Subclasses should override this method to return a duplicate of the appropriate type.- Specified by:
duplicate
in interfaceReadOnlyLDAPRequest
- Overrides:
duplicate
in classExtendedRequest
- Returns:
- A new instance of this LDAP request that may be modified without impacting this request.
-
duplicate
public GetSubtreeAccessibilityExtendedRequest duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request. The provided controls will be used for the new request instead of duplicating the controls from this request.. Subclasses should override this method to return a duplicate of the appropriate type.- Specified by:
duplicate
in interfaceReadOnlyLDAPRequest
- Overrides:
duplicate
in classExtendedRequest
- Parameters:
controls
- The set of controls to include in the duplicate request.- Returns:
- A new instance of this LDAP request that may be modified without impacting this request.
-
getExtendedRequestName
public java.lang.String getExtendedRequestName()
Retrieves the user-friendly name for the extended request, if available. If no user-friendly name has been defined, then the OID will be returned.- Overrides:
getExtendedRequestName
in classExtendedRequest
- Returns:
- The user-friendly name for this extended request, or the OID if no user-friendly name is available.
-
toString
public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this request to the provided buffer.- Specified by:
toString
in interfaceProtocolOp
- Specified by:
toString
in interfaceReadOnlyLDAPRequest
- Overrides:
toString
in classExtendedRequest
- Parameters:
buffer
- The buffer to which to append a string representation of this request.
-
-