|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.unboundidds.controls.IntermediateClientResponseValue
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class IntermediateClientResponseValue
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 implements a data structure which encapsulates the value of an intermediate client response value. It may recursively embed intermediate client response values from upstream servers.
IntermediateClientRequestControl
class
for an example of using the intermediate client request and response
controls.
Constructor Summary | |
---|---|
IntermediateClientResponseValue(IntermediateClientResponseValue upstreamResponse,
java.lang.String upstreamServerAddress,
java.lang.Boolean upstreamServerSecure,
java.lang.String serverName,
java.lang.String serverSessionID,
java.lang.String serverResponseID)
Creates a new intermediate client response value with the provided information. |
Method Summary | |
---|---|
static IntermediateClientResponseValue |
decode(ASN1Sequence sequence)
Decodes the provided ASN.1 sequence as an intermediate client response value. |
ASN1Sequence |
encode()
Encodes this intermediate client response value to a form that may be included in the response control. |
boolean |
equals(java.lang.Object o)
Indicates whether the provided object is equal to this intermediate client response value. |
java.lang.String |
getServerName()
Retrieves a string that identifies the server application that created this intermediate client response value. |
java.lang.String |
getServerResponseID()
Retrieves a string that may be used to identify the response in the server application. |
java.lang.String |
getServerSessionID()
Retrieves a string that may be used to identify the session in the server application. |
IntermediateClientResponseValue |
getUpstreamResponse()
Retrieves the wrapped response from an upstream server, if available. |
java.lang.String |
getUpstreamServerAddress()
Retrieves the IP address or resolvable name of the upstream server system, if available. |
int |
hashCode()
Generates a hash code for this intermediate client response value. |
java.lang.String |
toString()
Retrieves a string representation of this intermediate client response value. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this intermediate client response value to the provided buffer. |
java.lang.Boolean |
upstreamServerSecure()
Indicates whether the communication with the communication with the upstream server is secure (i.e., whether communication between the server application and the upstream server is safe from interpretation or undetectable alteration by a third party observer or interceptor). |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public IntermediateClientResponseValue(IntermediateClientResponseValue upstreamResponse, java.lang.String upstreamServerAddress, java.lang.Boolean upstreamServerSecure, java.lang.String serverName, java.lang.String serverSessionID, java.lang.String serverResponseID)
upstreamResponse
- A wrapped intermediate client response from
an upstream server. It may be null
if there is no wrapped upstream response.upstreamServerAddress
- The IP address or resolvable name of the
upstream server system. It may be
null
if there is no upstream server
or its address is not available.upstreamServerSecure
- Indicates whether communication with the
upstream server is secure. It may be
null
if there is no upstream server
or it is not known whether the communication
is secure.serverName
- An identifier string that summarizes the
server application that created this
intermediate client response. It may be
null
if that information is not
available.serverSessionID
- A string that may be used to identify the
session in the server application. It may
be null
if there is no available
session identifier.serverResponseID
- A string that may be used to identify the
response in the server application. It may
be null
if there is no available
response identifier.Method Detail |
---|
public IntermediateClientResponseValue getUpstreamResponse()
null
if
there is none.public java.lang.String getUpstreamServerAddress()
null
if there is no upstream server or its address is not
available.public java.lang.Boolean upstreamServerSecure()
Boolean.TRUE
if communication with the upstream server is
secure, Boolean.FALSE
if it is not secure, or
null
if there is no upstream server or it is not known
whether the communication is secure.public java.lang.String getServerName()
public java.lang.String getServerSessionID()
null
if there is none.public java.lang.String getServerResponseID()
null
if there is none.public ASN1Sequence encode()
public static IntermediateClientResponseValue decode(ASN1Sequence sequence) throws LDAPException
sequence
- The sequence to be decoded as an intermediate client
response value.
LDAPException
- If the provided sequence cannot be decoded as an
intermediate client response value.public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
o
- The object for which to make the determination.
true
if the provided object is considered equal to this
intermediate client response value, or false
if not.public java.lang.String toString()
toString
in class java.lang.Object
public void toString(java.lang.StringBuilder buffer)
buffer
- The buffer to which the information is to be appended.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |