|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.IntermediateResponse
com.unboundid.ldap.sdk.unboundidds.extensions.StreamProxyValuesIntermediateResponse
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class StreamProxyValuesIntermediateResponse
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 proxy 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. This intermediate response has an OID of "1.3.6.1.4.1.30221.2.6.9" and the value is encoded as follows:
StreamProxyValuesIntermediateResponse ::= SEQUENCE { attributeName [0] LDAPString OPTIONAL, result [1] ENUMERATED { allValuesReturned (0), moreValuesToReturn (1), attributeNotIndexed (2), processingError (3), ... }, diagnosticMessage [2] OCTET STRING OPTIONAL, values [4] SET OF BackendSetValue OPTIONAL, ... } BackendSetValue ::= SEQUENCE { backendSetID OCTET STRING, value OCTET STRING }
Field Summary | |
---|---|
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_PROXY_VALUES_INTERMEDIATE_RESPONSE_OID
The OID (1.3.6.1.4.1.30221.2.6.9) for the get stream proxy values intermediate response. |
Fields inherited from class com.unboundid.ldap.sdk.IntermediateResponse |
---|
TYPE_INTERMEDIATE_RESPONSE_OID, TYPE_INTERMEDIATE_RESPONSE_VALUE |
Constructor Summary | |
---|---|
StreamProxyValuesIntermediateResponse(IntermediateResponse intermediateResponse)
Creates a new stream proxy values intermediate response with information from the provided generic intermediate response. |
|
StreamProxyValuesIntermediateResponse(java.lang.String attributeName,
int result,
java.lang.String diagnosticMessage,
java.util.Collection<StreamProxyValuesBackendSetValue> values,
Control... controls)
Creates a new stream proxy values intermediate response with the provided information. |
Method Summary | |
---|---|
java.lang.String |
getAttributeName()
Retrieves the name of the attribute with which this stream proxy values intermediate response is associated. |
java.lang.String |
getDiagnosticMessage()
Retrieves the diagnostic message for this stream proxy 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 proxy values intermediate response. |
java.util.List<StreamProxyValuesBackendSetValue> |
getValues()
Retrieves the list of values for this stream proxy 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 |
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_PROXY_VALUES_INTERMEDIATE_RESPONSE_OID
public static final int RESULT_ALL_VALUES_RETURNED
public static final int RESULT_MORE_VALUES_TO_RETURN
public static final int RESULT_ATTRIBUTE_NOT_INDEXED
public static final int RESULT_PROCESSING_ERROR
Constructor Detail |
---|
public StreamProxyValuesIntermediateResponse(java.lang.String attributeName, int result, java.lang.String diagnosticMessage, java.util.Collection<StreamProxyValuesBackendSetValue> values, Control... controls)
attributeName
- The name of the attribute with which the
included values are associated. This may be
null
if the provided values are DNs.result
- The integer value that provides information
about the state of the stream proxy values
response.diagnosticMessage
- The diagnostic message that provides more
information about the result, or null
if
none is required.values
- The set of values included in this stream proxy
values intermediate response. It may be
null
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 be null
or empty if there should not be any controls.public StreamProxyValuesIntermediateResponse(IntermediateResponse intermediateResponse) throws LDAPException
intermediateResponse
- The generic intermediate response that should
be used to create this new intermediate
response.
LDAPException
- If the provided intermediate response cannot be
parsed as a stream proxy values intermediate
response.Method Detail |
---|
public java.lang.String getAttributeName()
null
if the values
are entry DNs rather than attribute values.public int getResult()
public java.lang.String getDiagnosticMessage()
null
if there is none.public java.util.List<StreamProxyValuesBackendSetValue> getValues()
public java.lang.String getIntermediateResponseName()
null
will be returned.
getIntermediateResponseName
in class IntermediateResponse
null
if neither a user-friendly name
nor a response OID are available.public java.lang.String valueToString()
valueToString
in class IntermediateResponse
null
if there is
no value or no string representation is available.public void toString(java.lang.StringBuilder buffer)
toString
in interface LDAPResponse
toString
in class IntermediateResponse
buffer
- The buffer to which the string representation should be
appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |