|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.LDAPRequest
com.unboundid.ldap.sdk.ExtendedRequest
com.unboundid.ldap.sdk.unboundidds.extensions.StreamDirectoryValuesExtendedRequest
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class StreamDirectoryValuesExtendedRequest
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.This class provides an implementation of the stream directory values extended request as used in the UnboundID 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. 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, ..... }
Field Summary | |
---|---|
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 | |
---|---|
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 | |
---|---|
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, writeTo |
Methods inherited from class com.unboundid.ldap.sdk.LDAPRequest |
---|
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setResponseTimeoutMillis, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String STREAM_DIRECTORY_VALUES_REQUEST_OID
Constructor Detail |
---|
public StreamDirectoryValuesExtendedRequest(java.lang.String baseDN, SearchScope dnScope, boolean returnRelativeDNs, java.util.List<java.lang.String> attributes, int valuesPerResponse, Control... controls)
baseDN
- The base DN which indicates the portion of the
DIT to target. It must not be null
.dnScope
- The scope for which to return information about
entry DNs in the specified portion of the DIT.
This may be null
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 be null
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 be null
or empty if no controls
should be included in the request.public StreamDirectoryValuesExtendedRequest(ExtendedRequest extendedRequest) throws LDAPException
extendedRequest
- The generic extended request to use to create this
stream directory values extended request.
LDAPException
- If a problem occurs while decoding the request.Method Detail |
---|
public java.lang.String getBaseDN()
public SearchScope getDNScope()
null
if information about entry DNs should not be
returned.public boolean returnRelativeDNs()
true
if entry DN values returned should be relative to the
provided base DN, or false
if they should be complete DNs.public java.util.List<java.lang.String> getAttributes()
public int getValuesPerResponse()
public StreamDirectoryValuesExtendedRequest duplicate()
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class ExtendedRequest
public StreamDirectoryValuesExtendedRequest duplicate(Control[] controls)
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class ExtendedRequest
controls
- The set of controls to include in the duplicate request.
public java.lang.String getExtendedRequestName()
getExtendedRequestName
in class ExtendedRequest
public void toString(java.lang.StringBuilder buffer)
toString
in interface ProtocolOp
toString
in interface ReadOnlyLDAPRequest
toString
in class ExtendedRequest
buffer
- The buffer to which to append a string representation of
this request.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |