com.unboundid.ldap.sdk.unboundidds.logs.v2.json

Class JSONIntermediateClientRequestControl

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONIntermediateClientRequestControl

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class JSONIntermediateClientRequestControl
extends java.lang.Object
implements java.io.Serializable

This class provides a data structure that contains information about an JSON-formatted intermediate client request control.

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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JSONIntermediateClientRequestControl(JSONObject controlObject) Creates a new JSON intermediate client request control that is decoded from the provided JSON object.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClientIdentity() Retrieves the requested client authorization identity.
java.lang.String	getClientName() Retrieves the name of the client application.
JSONObject	getControlObject() Retrieves a JSON object containing an encoded representation of this intermediate client request control.
java.lang.String	getDownstreamClientAddress() Retrieves the address of a downstream client.
java.lang.Boolean	getDownstreamClientSecure() Indicates whether communication with the downstream client is secure.
JSONIntermediateClientRequestControl	getDownstreamRequest() Retrieves a downstream request embedded in the control.
java.lang.String	getRequestID() Retrieves the request ID assigned by the downstream client.
java.lang.String	getSessionID() Retrieves the session ID assigned by the downstream client.
java.lang.String	toString() Retrieves a string representation of this intermediate client request control.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JSONIntermediateClientRequestControl

public JSONIntermediateClientRequestControl(@NotNull
                                            JSONObject controlObject)

Creates a new JSON intermediate client request control that is decoded from the provided JSON object.

Parameters:

controlObject - The JSON object containing an encoded representation of this intermediate client request control.

Method Detail

getControlObject

@NotNull
public JSONObject getControlObject()

Retrieves a JSON object containing an encoded representation of this intermediate client request control.

Returns:

A JSON object containing an encoded representation of this intermediate client request control.

getDownstreamClientAddress

@Nullable
public java.lang.String getDownstreamClientAddress()

Retrieves the address of a downstream client.

Returns:

The address of a downstream client, or null if no downstream client address is available.

getDownstreamClientSecure

@Nullable
public java.lang.Boolean getDownstreamClientSecure()

Indicates whether communication with the downstream client is secure.

Returns:

Boolean.TRUE if communication with the downstream client is secure, Boolean.FALSE if communication with the downstream client is not secure, or null if this information is not available.

getClientIdentity

@Nullable
public java.lang.String getClientIdentity()

Retrieves the requested client authorization identity.

Returns:

The requested client authorization identity, or null if no client identity is available.

getClientName

@Nullable
public java.lang.String getClientName()

Retrieves the name of the client application.

Returns:

The name of the client application, or null if no client name is available.

getSessionID

@Nullable
public java.lang.String getSessionID()

Retrieves the session ID assigned by the downstream client.

Returns:

The session ID assigned by the downstream client, or null if no session ID is available.

getRequestID

@Nullable
public java.lang.String getRequestID()

Retrieves the request ID assigned by the downstream client.

Returns:

The request ID assigned by the downstream client, or null if no request ID is available.

getDownstreamRequest

@Nullable
public JSONIntermediateClientRequestControl getDownstreamRequest()

Retrieves a downstream request embedded in the control.

Returns:

A downstream request embedded in the control, or null if no downstream request is available.

toString

@NotNull
public java.lang.String toString()

Retrieves a string representation of this intermediate client request control.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this intermediate client request control.