Class StreamDirectoryValuesExtendedRequest
- java.lang.Object
-
- com.unboundid.ldap.sdk.LDAPRequest
-
- com.unboundid.ldap.sdk.ExtendedRequest
-
- com.unboundid.ldap.sdk.unboundidds.extensions.StreamDirectoryValuesExtendedRequest
-
- All Implemented Interfaces:
ProtocolOp
,ReadOnlyLDAPRequest
,java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class StreamDirectoryValuesExtendedRequest extends ExtendedRequest
This class provides an implementation of the stream directory values extended request as used in the Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 Directory Server. It may be used to obtain all entry DNs and/or all all values for one or more attributes for a specified portion of the DIT.
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.2.6.6" and the value is encoded as follows:StreamDirectoryValuesRequest ::= SEQUENCE { baseDN [0] LDAPDN, includeDNs [1] DNSelection OPTIONAL, attributes [2] SEQUENCE OF LDAPString OPTIONAL, valuesPerResponse [3] INTEGER (1 .. 32767) OPTIONAL, ... } DNSelection ::= SEQUENCE { scope [0] ENUMERATED { baseObject (0), singleLevel (1), wholeSubtree (2), subordinateSubtree (3), ... } relative [1] BOOLEAN DEFAULT TRUE, ..... }
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
STREAM_DIRECTORY_VALUES_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.6.6) for the get stream directory values extended request.-
Fields inherited from class com.unboundid.ldap.sdk.ExtendedRequest
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE
-
-
Constructor Summary
Constructors Constructor Description StreamDirectoryValuesExtendedRequest(ExtendedRequest extendedRequest)
Creates a new stream directory values extended request from the provided generic extended request.StreamDirectoryValuesExtendedRequest(java.lang.String baseDN, SearchScope dnScope, boolean returnRelativeDNs, java.util.List<java.lang.String> attributes, int valuesPerResponse, Control... controls)
Creates a new stream directory values extended request with the provided information.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StreamDirectoryValuesExtendedRequest
duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request.StreamDirectoryValuesExtendedRequest
duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request.java.util.List<java.lang.String>
getAttributes()
Retrieves the list of names of attributes whose values should be returned to the client.java.lang.String
getBaseDN()
Retrieves the base DN for this request.SearchScope
getDNScope()
Retrieves the scope for entry DNs to be included in intermediate responses.java.lang.String
getExtendedRequestName()
Retrieves the user-friendly name for the extended request, if available.int
getValuesPerResponse()
Retrieves the maximum number of values that should be included in each stream directory values intermediate response.boolean
returnRelativeDNs()
Indicates whether entry DN values returned should be relative to the provided base DN.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, process, 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
-
STREAM_DIRECTORY_VALUES_REQUEST_OID
@NotNull public static final java.lang.String STREAM_DIRECTORY_VALUES_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.6.6) for the get stream directory values extended request.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
StreamDirectoryValuesExtendedRequest
public StreamDirectoryValuesExtendedRequest(@NotNull java.lang.String baseDN, @Nullable SearchScope dnScope, boolean returnRelativeDNs, @Nullable java.util.List<java.lang.String> attributes, int valuesPerResponse, @Nullable Control... controls)
Creates a new stream directory values extended request with the provided information.- Parameters:
baseDN
- The base DN which indicates the portion of the DIT to target. It must not benull
.dnScope
- The scope for which to return information about entry DNs in the specified portion of the DIT. This may benull
if information about entry DNs should not be returned.returnRelativeDNs
- Indicates whether DNs returned should be relative to the base DN rather than full DNs.attributes
- The names of the attributes for which to retrieve the values. This may benull
or empty if only entry DNs should be retrieved.valuesPerResponse
- The maximum number of values to include per response. A value less than or equal to zero indicates that the server should choose an appropriate value.controls
- The set of controls to include in the request. It may benull
or empty if no controls should be included in the request.
-
StreamDirectoryValuesExtendedRequest
public StreamDirectoryValuesExtendedRequest(@NotNull ExtendedRequest extendedRequest) throws LDAPException
Creates a new stream directory values extended request from the provided generic extended request.- Parameters:
extendedRequest
- The generic extended request to use to create this stream directory values extended request.- Throws:
LDAPException
- If a problem occurs while decoding the request.
-
-
Method Detail
-
getBaseDN
@NotNull public java.lang.String getBaseDN()
Retrieves the base DN for this request.- Returns:
- The base DN for this request.
-
getDNScope
@Nullable public SearchScope getDNScope()
Retrieves the scope for entry DNs to be included in intermediate responses.- Returns:
- The scope for entry DNs to be included in intermediate responses,
or
null
if information about entry DNs should not be returned.
-
returnRelativeDNs
public boolean returnRelativeDNs()
Indicates whether entry DN values returned should be relative to the provided base DN.- Returns:
true
if entry DN values returned should be relative to the provided base DN, orfalse
if they should be complete DNs.
-
getAttributes
@NotNull public java.util.List<java.lang.String> getAttributes()
Retrieves the list of names of attributes whose values should be returned to the client.- Returns:
- The list of names of attributes whose values should be returned to the client, or an empty list if only information about entry DNs should be returned.
-
getValuesPerResponse
public int getValuesPerResponse()
Retrieves the maximum number of values that should be included in each stream directory values intermediate response.- Returns:
- The maximum number of values that should be included in each stream directory values intermediate response, or 0 if the server should choose the appropriate number of values per response.
-
duplicate
@NotNull public StreamDirectoryValuesExtendedRequest 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
@NotNull public StreamDirectoryValuesExtendedRequest duplicate(@Nullable 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
@NotNull 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(@NotNull 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.
-
-