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

Class GenerateAccessTokenResponseControl

java.lang.Object
com.unboundid.ldap.sdk.Control
com.unboundid.ldap.sdk.unboundidds.controls.GenerateAccessTokenResponseControl
All Implemented Interfaces:
DecodeableControl, Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GenerateAccessTokenResponseControl extends Control implements DecodeableControl
This class provides a response control that may be used to convey the access token (and other associated information) generated in response to a GenerateAccessTokenRequestControl for a successful bind operation.
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 has an OID of "1.3.6.1.4.1.30221.2.5.68", a criticality of false, and a value that is the string representation of a JSON object with the following fields:
  • token -- The access token that was generated by the server. This field may be absent if an error occurred while attempting to generate the access token.
  • expiration-time -- The time that the access token is expected to expire. If present, it will be formatted in the ISO 8601 format described in RFC 3339 (which may be decoded using the StaticUtils.decodeRFC3339Time(java.lang.String) method). If absent, then the access token may not expire.
  • error-message -- An optional message that may explain the reason that an access token could not be generated for the request.
See Also:

  • Field Details

  • Constructor Details

    • GenerateAccessTokenResponseControl

      public GenerateAccessTokenResponseControl(@Nullable String accessToken, @Nullable Date expirationTime, @Nullable String errorMessage)
      Creates a new generate access token response control with the provided information.
      Parameters:
      accessToken - The access token that was generated. It may be null if no access token was generated.
      expirationTime - The time that the access token is expected to expire. It may be null if no access token was generated, or if the token does not have an expiration time.
      errorMessage - An error message with the reason the access token was not generated. It may be null if the access token was generated successfully or if no error message is available.

    • GenerateAccessTokenResponseControl

      public GenerateAccessTokenResponseControl(@NotNull String oid, boolean isCritical, @Nullable ASN1OctetString value) throws LDAPException
      Creates a new generate access token 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 a generate access token response control.

  • Method Details

    • decodeControl

      @NotNull public GenerateAccessTokenResponseControl decodeControl(@NotNull String oid, boolean isCritical, @Nullable ASN1OctetString value) throws LDAPException
      Creates a new instance of this decodeable control from the provided information.
      Specified by:
      decodeControl in interface DecodeableControl
      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.
      Returns:
      The decoded representation of this control.
      Throws:
      LDAPException - If the provided information cannot be decoded as a valid instance of this decodeable control.

    • get

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

    • getAccessToken

      @Nullable public String getAccessToken()
      Retrieves the access token that was generated by the server.
      Returns:
      The access token that was generated by the server, or null if no access token was generated..

    • getExpirationTime

      @Nullable public Date getExpirationTime()
      Retrieves the time that the generated access token is expected to expire.
      Returns:
      The time that the generated access token is expected to expire, or null if no access token was generated or if it does not have an expiration time.

    • getErrorMessage

      @Nullable public String getErrorMessage()
      Retrieves an error message with the reason the access token was not generated.
      Returns:
      An error message with the reason the access token was not generated, or null if the access token was generated successfully or if no error message is available.

    • getControlName

      @NotNull public 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 generate access token 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 generate access token response control, the OID is "1.3.6.1.4.1.30221.2.5.68".
      • 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 generate access token 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 generate access token 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:
        • token -- An optional string field whose value is the access token that was generated.
        • expiration-time -- An optional string field whose value is a timestamp indicating the time that the access token will expire, using the ISO 8601 format described in RFC 3339.
        • error-message -- An optional string field whose value is an error message with the reason the access token was not generated.
      Overrides:
      toJSONControl in class Control
      Returns:
      A JSON object that contains a representation of this control.

    • decodeJSONControl

      @NotNull public static GenerateAccessTokenResponseControl decodeJSONControl(@NotNull JSONObject controlObject, boolean strict) throws LDAPException
      Attempts to decode the provided object as a JSON representation of a generate access token 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 generate access token response control that was decoded from the provided JSON object.
      Throws:
      LDAPException - If the provided JSON object cannot be parsed as a valid generate access token response control.

    • toString

      public void toString(@NotNull 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.