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

Class JSONIntermediateClientResponseControl

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.logs.v2.json.JSONIntermediateClientResponseControl
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class JSONIntermediateClientResponseControl extends Object implements Serializable
This class provides a data structure that contains information about an JSON-formatted intermediate client response 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:

  • Constructor Details

    • JSONIntermediateClientResponseControl

      public JSONIntermediateClientResponseControl(@NotNull JSONObject controlObject)
      Creates a new JSON intermediate client response control that is decoded from the provided JSON object.
      Parameters:
      controlObject - The JSON object containing an encoded representation of this intermediate client response control.

  • Method Details

    • getControlObject

      @NotNull public JSONObject getControlObject()
      Retrieves a JSON object containing an encoded representation of this intermediate client response control.
      Returns:
      A JSON object containing an encoded representation of this intermediate client response control.

    • getUpstreamServerAddress

      @Nullable public String getUpstreamServerAddress()
      Retrieves the address of an upstream server.
      Returns:
      The address of an upstream server, or null if no upstream server address is available.

    • getUpstreamServerSecure

      @Nullable public Boolean getUpstreamServerSecure()
      Indicates whether communication with the upstream server is secure.
      Returns:
      Boolean.TRUE if communication with the upstream server is secure, Boolean.FALSE if communication with the upstream server is not secure, or null if this information is not available.

    • getServerName

      @Nullable public String getServerName()
      Retrieves the name of the upstream server application.
      Returns:
      The name of the upstream server application, or null if this information is not available.

    • getSessionID

      @Nullable public String getSessionID()
      Retrieves the session ID assigned by the upstream server.
      Returns:
      The session ID assigned by the upstream server, or null if no session ID is available.

    • getResponseID

      @Nullable public String getResponseID()
      Retrieves the response ID assigned by the upstream server.
      Returns:
      The response ID assigned by the upstream server, or null if no response ID is available.

    • getUpstreamResponse

      @Nullable public JSONIntermediateClientResponseControl getUpstreamResponse()
      Retrieves an upstream response embedded in the control.
      Returns:
      An upstream response embedded in the control, or null if no upstream response is available.

    • toString

      @NotNull public String toString()
      Retrieves a string representation of this intermediate client request control.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this intermediate client request control.