com.unboundid.ldap.sdk.unboundidds.extensions
Class StreamDirectoryValuesExtendedRequest

java.lang.Object
  extended by com.unboundid.ldap.sdk.LDAPRequest
      extended by com.unboundid.ldap.sdk.ExtendedRequest
          extended by 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

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,
        ..... }
 

See Also:
Serialized Form

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

STREAM_DIRECTORY_VALUES_REQUEST_OID

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(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.

Parameters:
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.

StreamDirectoryValuesExtendedRequest

public StreamDirectoryValuesExtendedRequest(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

public java.lang.String getBaseDN()
Retrieves the base DN for this request.

Returns:
The base DN for this request.

getDNScope

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, or false if they should be complete DNs.

getAttributes

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

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 interface ReadOnlyLDAPRequest
Overrides:
duplicate in class ExtendedRequest
Returns:
A new instance of this LDAP request that may be modified without impacting this request.

duplicate

public StreamDirectoryValuesExtendedRequest 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 interface ReadOnlyLDAPRequest
Overrides:
duplicate in class ExtendedRequest
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 class ExtendedRequest
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 interface ProtocolOp
Specified by:
toString in interface ReadOnlyLDAPRequest
Overrides:
toString in class ExtendedRequest
Parameters:
buffer - The buffer to which to append a string representation of this request.