Package com.unboundid.ldap.sdk.unboundidds.controls

Class IntermediateClientResponseControl

  • All Implemented Interfaces:
    DecodeableControl, java.io.Serializable
    @NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class IntermediateClientResponseControl
extends Control
implements DecodeableControl
    This class defines an intermediate client response control, which can be used to provide a server with information about the client and any downstream clients that it may have.
    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.

    This control is not based on any public standard. It was originally developed for use with the Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 Directory Server. The value of this control uses the following encoding: 

     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.
    See Also:
    Serialized Form

    • Constructor Detail

      • IntermediateClientResponseControl

        public IntermediateClientResponseControl​(@Nullable
                                         IntermediateClientResponseValue upstreamResponse,
                                         @Nullable
                                         java.lang.String upstreamServerAddress,
                                         @Nullable
                                         java.lang.Boolean upstreamServerSecure,
                                         @Nullable
                                         java.lang.String serverName,
                                         @Nullable
                                         java.lang.String serverSessionID,
                                         @Nullable
                                         java.lang.String serverResponseID)
        Creates a new intermediate client response control with the provided information. It will not be marked critical.
        Parameters:
        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.

      • IntermediateClientResponseControl

        public IntermediateClientResponseControl​(@NotNull
                                         java.lang.String oid,
                                         boolean isCritical,
                                         @Nullable
                                         ASN1OctetString value)
                                  throws LDAPException
        Creates a new intermediate client response control with the provided information.
        Parameters:
        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.
        Throws:
        LDAPException - If the provided control cannot be decoded as an intermediate client response control.

      • IntermediateClientResponseControl

        public IntermediateClientResponseControl​(boolean isCritical,
                                         @NotNull
                                         IntermediateClientResponseValue value)
        Creates a new intermediate client response control with the provided value.
        Parameters:
        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.

    • Method Detail

      • get

        @Nullable
public static IntermediateClientResponseControl get​(@NotNull
                                                    LDAPResult result)
                                             throws LDAPException
        Extracts an intermediate client response control from the provided result.
        Parameters:
        result - The result from which to retrieve the intermediate client response control.
        Returns:
        The intermediate client response control contained in the provided result, or null if the result did not contain an intermediate client response control.
        Throws:
        LDAPException - If a problem is encountered while attempting to decode the intermediate client response control contained in the provided result.

      • getUpstreamServerAddress

        @Nullable
public java.lang.String getUpstreamServerAddress()
        Retrieves the IP address or resolvable name of the upstream server system, if available.
        Returns:
        The IP address or resolvable name of the upstream server system, null if there is no upstream server or its address is not available.

      • upstreamServerSecure

        @Nullable
public 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).
        Returns:
        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.

      • getServerName

        @Nullable
public java.lang.String getServerName()
        Retrieves a string that identifies the server application that created this intermediate client response value.
        Returns:
        A string that may be used to identify the server application that created this intermediate client response value.

      • getServerSessionID

        @Nullable
public java.lang.String getServerSessionID()
        Retrieves a string that may be used to identify the session in the server application.
        Returns:
        A string that may be used to identify the session in the server application, or null if there is none.

      • getServerResponseID

        @Nullable
public java.lang.String getServerResponseID()
        Retrieves a string that may be used to identify the response in the server application.
        Returns:
        A string that may be used to identify the response in the server application, or null if there is none.

      • getControlName

        @NotNull
public java.lang.String getControlName()
        Retrieves the user-friendly name for this control, if available. If no user-friendly name has been defined, then the OID will be returned.
        Overrides:
        getControlName in class Control
        Returns:
        The user-friendly name for this control, or the OID if no user-friendly name is available.

      • toJSONControl

        @NotNull
public JSONObject toJSONControl()
        Retrieves a representation of this intermediate client response control as a JSON object. The JSON object uses the following fields:
        • oid -- A mandatory string field whose value is the object identifier for this control. For the intermediate client response control, the OID is "1.3.6.1.4.1.30221.2.5.2".
        • control-name -- An optional string field whose value is a human-readable name for this control. This field is only intended for descriptive purposes, and when decoding a control, the oid field should be used to identify the type of control.
        • criticality -- A mandatory Boolean field used to indicate whether this control is considered critical.
        • value-base64 -- An optional string field whose value is a base64-encoded representation of the raw value for this intermediate client response control. Exactly one of the value-base64 and value-json fields must be present.
        • value-json -- An optional JSON object field whose value is a user-friendly representation of the value for this intermediate client response control. Exactly one of the value-base64 and value-json fields must be present, and if the value-json field is used, then it will use the following fields:
          • upstream-response -- An optional JSON object field whose content represents an upstream response value. If present, the fields of this object are the same as the fields that may be included in the top-level value-json object (optionally including a nested upstream-response field, if appropriate).
          • upstream-server-address -- An optional string field whose value is the address of an upstream server to which the requested operation was forwarded.
          • upstream-server-secure -- An optional Boolean field that indicates whether communication with an upstream server occurred over a secure channel.
          • server-name -- An optional string field whose value is the name of the application used to process the request.
          • server-session-id -- An optional string field whose value is an identifier that the server is using to reference the current communication session with the client.
          • server-response-id -- An optional string field whose value is an identifier that the server is using to reference the current operation being processed.
        Overrides:
        toJSONControl in class Control
        Returns:
        A JSON object that contains a representation of this control.

      • decodeJSONControl

        @NotNull
public static IntermediateClientResponseControl decodeJSONControl​(@NotNull
                                                                  JSONObject controlObject,
                                                                  boolean strict)
                                                           throws LDAPException
        Attempts to decode the provided object as a JSON representation of an intermediate client response control.
        Parameters:
        controlObject - The JSON object to be decoded. It must not be null.
        strict - Indicates whether to use strict mode when decoding the provided JSON object. If this is true, then this method will throw an exception if the provided JSON object contains any unrecognized fields. If this is false, then unrecognized fields will be ignored.
        Returns:
        The intermediate client response control that was decoded from the provided JSON object.
        Throws:
        LDAPException - If the provided JSON object cannot be parsed as a valid intermediate client response control.

      • toString

        public void toString​(@NotNull
                     java.lang.StringBuilder buffer)
        Appends a string representation of this LDAP control to the provided buffer.
        Overrides:
        toString in class Control
        Parameters:
        buffer - The buffer to which to append the string representation of this buffer.