Class StreamDirectoryValuesIntermediateResponse
- java.lang.Object
-
- com.unboundid.ldap.sdk.IntermediateResponse
-
- com.unboundid.ldap.sdk.unboundidds.extensions.StreamDirectoryValuesIntermediateResponse
-
- All Implemented Interfaces:
LDAPResponse
,java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class StreamDirectoryValuesIntermediateResponse extends IntermediateResponse
This class provides an implementation of the stream directory values intermediate response, which may be used to provide a partial or complete list of the values for a specified attribute, or DNs of entries contained in a specified portion of the server 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 intermediate response has an OID of "1.3.6.1.4.1.30221.2.6.7" and the value is encoded as follows:StreamDirectoryValuesIntermediateResponse ::= SEQUENCE { attributeName [0] LDAPString OPTIONAL, result [1] ENUMERATED { allValuesReturned (0), moreValuesToReturn (1), attributeNotIndexed (2), processingError (3), ... }, diagnosticMessage [2] OCTET STRING OPTIONAL, values [3] SET OF OCTET STRING OPTIONAL, ... }
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static int
RESULT_ALL_VALUES_RETURNED
The integer value for the "all values returned" result.static int
RESULT_ATTRIBUTE_NOT_INDEXED
The integer value for the "attribute not indexed" result.static int
RESULT_MORE_VALUES_TO_RETURN
The integer value for the "more values to return" result.static int
RESULT_PROCESSING_ERROR
The integer value for the "processing error" result.static java.lang.String
STREAM_DIRECTORY_VALUES_INTERMEDIATE_RESPONSE_OID
The OID (1.3.6.1.4.1.30221.2.6.7) for the get stream directory values intermediate response.-
Fields inherited from class com.unboundid.ldap.sdk.IntermediateResponse
TYPE_INTERMEDIATE_RESPONSE_OID, TYPE_INTERMEDIATE_RESPONSE_VALUE
-
-
Constructor Summary
Constructors Constructor Description StreamDirectoryValuesIntermediateResponse(IntermediateResponse intermediateResponse)
Creates a new stream directory values intermediate response with information from the provided generic intermediate response.StreamDirectoryValuesIntermediateResponse(java.lang.String attributeName, int result, java.lang.String diagnosticMessage, java.util.Collection<ASN1OctetString> values, Control... controls)
Creates a new stream directory values intermediate response with the provided information.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getAttributeName()
Retrieves the name of the attribute with which this stream directory values intermediate response is associated.java.lang.String
getDiagnosticMessage()
Retrieves the diagnostic message for this stream directory values intermediate response.java.lang.String
getIntermediateResponseName()
Retrieves the user-friendly name for the intermediate response, if available.int
getResult()
Retrieves the integer value of the result for this stream directory values intermediate response.java.util.List<ASN1OctetString>
getValues()
Retrieves the list of values for this stream directory values intermediate response.void
toString(java.lang.StringBuilder buffer)
Appends a string representation of this intermediate response to the provided buffer.java.lang.String
valueToString()
Retrieves a human-readable string representation for the contents of the value for this intermediate response, if appropriate.-
Methods inherited from class com.unboundid.ldap.sdk.IntermediateResponse
getControl, getControls, getMessageID, getOID, getValue, toString
-
-
-
-
Field Detail
-
STREAM_DIRECTORY_VALUES_INTERMEDIATE_RESPONSE_OID
public static final java.lang.String STREAM_DIRECTORY_VALUES_INTERMEDIATE_RESPONSE_OID
The OID (1.3.6.1.4.1.30221.2.6.7) for the get stream directory values intermediate response.- See Also:
- Constant Field Values
-
RESULT_ALL_VALUES_RETURNED
public static final int RESULT_ALL_VALUES_RETURNED
The integer value for the "all values returned" result.- See Also:
- Constant Field Values
-
RESULT_MORE_VALUES_TO_RETURN
public static final int RESULT_MORE_VALUES_TO_RETURN
The integer value for the "more values to return" result.- See Also:
- Constant Field Values
-
RESULT_ATTRIBUTE_NOT_INDEXED
public static final int RESULT_ATTRIBUTE_NOT_INDEXED
The integer value for the "attribute not indexed" result.- See Also:
- Constant Field Values
-
RESULT_PROCESSING_ERROR
public static final int RESULT_PROCESSING_ERROR
The integer value for the "processing error" result.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
StreamDirectoryValuesIntermediateResponse
public StreamDirectoryValuesIntermediateResponse(java.lang.String attributeName, int result, java.lang.String diagnosticMessage, java.util.Collection<ASN1OctetString> values, Control... controls)
Creates a new stream directory values intermediate response with the provided information.- Parameters:
attributeName
- The name of the attribute with which the included values are associated. This may benull
if the provided values are DNs.result
- The integer value that provides information about the state of the stream directory values response.diagnosticMessage
- The diagnostic message that provides more information about the result, ornull
if none is required.values
- The set of values included in this stream directory values intermediate response. It may benull
or empty if this is an error result, or there are no values of the specified type in the server.controls
- The set of controls to include in this intermediate response. It may benull
or empty if there should not be any controls.
-
StreamDirectoryValuesIntermediateResponse
public StreamDirectoryValuesIntermediateResponse(IntermediateResponse intermediateResponse) throws LDAPException
Creates a new stream directory values intermediate response with information from the provided generic intermediate response.- Parameters:
intermediateResponse
- The generic intermediate response that should be used to create this new intermediate response.- Throws:
LDAPException
- If the provided intermediate response cannot be parsed as a stream directory values intermediate response.
-
-
Method Detail
-
getAttributeName
public java.lang.String getAttributeName()
Retrieves the name of the attribute with which this stream directory values intermediate response is associated.- Returns:
- The name of the attribute with which this stream directory values
intermediate response is associated, or
null
if the values are entry DNs rather than attribute values.
-
getResult
public int getResult()
Retrieves the integer value of the result for this stream directory values intermediate response.- Returns:
- The integer value of the result for this stream directory values intermediate response.
-
getDiagnosticMessage
public java.lang.String getDiagnosticMessage()
Retrieves the diagnostic message for this stream directory values intermediate response.- Returns:
- The diagnostic message for this stream directory values
intermediate response, or
null
if there is none.
-
getValues
public java.util.List<ASN1OctetString> getValues()
Retrieves the list of values for this stream directory values intermediate response.- Returns:
- The list of values for this stream directory values intermediate response, or an empty list if there are no values.
-
getIntermediateResponseName
public java.lang.String getIntermediateResponseName()
Retrieves the user-friendly name for the intermediate response, 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:
getIntermediateResponseName
in classIntermediateResponse
- Returns:
- The user-friendly name for this intermediate response, 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.
-
valueToString
public java.lang.String valueToString()
Retrieves a human-readable string representation for the contents of the value for this intermediate response, if appropriate. If one is provided, then it should be a relatively compact single-line representation of the most important elements of the value.- Overrides:
valueToString
in classIntermediateResponse
- Returns:
- A human-readable string representation for the contents of the
value for this intermediate response, or
null
if there is no value or no string representation is available.
-
toString
public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this intermediate response to the provided buffer.- Specified by:
toString
in interfaceLDAPResponse
- Overrides:
toString
in classIntermediateResponse
- Parameters:
buffer
- The buffer to which the string representation should be appended.
-
-