@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class IntermediateClientResponseControl extends Control implements DecodeableControl
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 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.
IntermediateClientResponse ::= SEQUENCE { upstreamResponse [0] IntermediateClientResponse OPTIONAL, upstreamServerAddress [1] OCTET STRING OPTIONAL, upstreamServerSecure [2] BOOLEAN DEFAULT FALSE, serverName [3] OCTET STRING OPTIONAL, serverSessionID [4] OCTET STRING OPTIONAL, serverResponseID [5] OCTET STRING OPTIONAL, ... }See the documentation in the
IntermediateClientRequestControl
class
for an example of using the intermediate client request and response
controls.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
INTERMEDIATE_CLIENT_RESPONSE_OID
The OID (1.3.6.1.4.1.30221.2.5.2) for the intermediate client response
control.
|
Constructor and Description |
---|
IntermediateClientResponseControl(boolean isCritical,
IntermediateClientResponseValue value)
Creates a new intermediate client response control with the provided value.
|
IntermediateClientResponseControl(IntermediateClientResponseValue value)
Creates a new intermediate client response control with the provided value.
|
IntermediateClientResponseControl(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 control with the provided
information.
|
IntermediateClientResponseControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new intermediate client response control with the provided
information.
|
Modifier and Type | Method and Description |
---|---|
IntermediateClientResponseControl |
decodeControl(java.lang.String oid,
boolean isCritical,
ASN1OctetString value)
Creates a new instance of this decodeable control from the provided
information.
|
static IntermediateClientResponseControl |
get(LDAPResult result)
Extracts an intermediate client response control from the provided result.
|
java.lang.String |
getControlName()
Retrieves the user-friendly name for this control, if available.
|
IntermediateClientResponseValue |
getResponseValue()
Retrieves the value for this intermediate client response.
|
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.
|
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP control 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).
|
decode, decode, decodeControls, deregisterDecodeableControl, encode, encodeControls, equals, getOID, getValue, hashCode, hasValue, isCritical, readFrom, registerDecodeableControl, toString, writeTo
public static final java.lang.String INTERMEDIATE_CLIENT_RESPONSE_OID
public IntermediateClientResponseControl(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.public IntermediateClientResponseControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
oid
- The OID for the control.isCritical
- Indicates whether the control should be marked
critical.value
- The encoded value for the control. This may be
null
if no value was provided.LDAPException
- If the provided control cannot be decoded as an
intermediate client response control.public IntermediateClientResponseControl(IntermediateClientResponseValue value)
value
- The value to use for this intermediate client response
control. It must not be null
.public IntermediateClientResponseControl(boolean isCritical, IntermediateClientResponseValue value)
isCritical
- Indicates whether the control should be marked
critical. Response controls should generally not be
critical.value
- The value to use for this intermediate client response
control. It must not be null
.public IntermediateClientResponseControl decodeControl(java.lang.String oid, boolean isCritical, ASN1OctetString value) throws LDAPException
decodeControl
in interface DecodeableControl
oid
- The OID for the control.isCritical
- Indicates whether the control should be marked
critical.value
- The encoded value for the control. This may be
null
if no value was provided.LDAPException
- If the provided information cannot be decoded as a
valid instance of this decodeable control.public static IntermediateClientResponseControl get(LDAPResult result) throws LDAPException
result
- The result from which to retrieve the intermediate client
response control.null
if the result did not contain an
intermediate client response control.LDAPException
- If a problem is encountered while attempting to
decode the intermediate client response control
contained in the provided result.public IntermediateClientResponseValue getResponseValue()
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 java.lang.String getControlName()
getControlName
in class Control