Package com.nimbusds.oauth2.sdk

Class AccessTokenResponse

java.lang.Object
com.nimbusds.oauth2.sdk.TokenResponse
com.nimbusds.oauth2.sdk.AccessTokenResponse
All Implemented Interfaces:
Message, Response, SuccessResponse
Direct Known Subclasses:
OIDCTokenResponse
@Immutable public class AccessTokenResponse extends TokenResponse implements SuccessResponse
Access token response from the Token endpoint.

Example HTTP response: 

 HTTP/1.1 200 OK
 Content-Type: application/json;charset=UTF-8
 Cache-Control: no-store
 Pragma: no-cache

 {
   "access_token"      : "2YotnFZFEjr1zCsicMWpAA",
   "token_type"        : "example",
   "expires_in"        : 3600,
   "refresh_token"     : "tGzv3JOkF0XG5Qx2TlKWIA",
   "example_parameter" : "example_value"
 }

Related specifications:

  • OAuth 2.0 (RFC 6749)

  • Constructor Details

    • AccessTokenResponse

      public AccessTokenResponse(Tokens tokens)
      Creates a new access token response.
      Parameters:
      tokens - The tokens. Must not be null.

    • AccessTokenResponse

      public AccessTokenResponse(Tokens tokens, Map<String,Object> customParams)
      Creates a new access token response.
      Parameters:
      tokens - The tokens. Must not be null.
      customParams - Optional custom parameters, null if none.

  • Method Details

    • indicatesSuccess

      public boolean indicatesSuccess()
      Description copied from interface: Response
      Checks if the response indicates success.
      Specified by:
      indicatesSuccess in interface Response
      Returns:
      true if the response indicates success, else false.

    • getTokens

      public Tokens getTokens()
      Returns the tokens.
      Returns:
      The tokens.

    • getCustomParameters

      public Map<String,Object> getCustomParameters()
      Returns the custom parameters.
      Returns:
      The custom parameters, as an unmodifiable map, empty map if none.

    • getCustomParams

      @Deprecated public Map<String,Object> getCustomParams()
      Deprecated.

    • toJSONObject

      public net.minidev.json.JSONObject toJSONObject()
      Returns a JSON object representation of this access token response.

      Example JSON object: 

       {
   "access_token"  : "SlAV32hkKG",
   "token_type"    : "Bearer",
   "refresh_token" : "8xLOxBtZp8",
   "expires_in"    : 3600
 }
      Returns:
      The JSON object.

    • toHTTPResponse

      public HTTPResponse toHTTPResponse()
      Description copied from interface: Response
      Returns the matching HTTP response.
      Specified by:
      toHTTPResponse in interface Response
      Returns:
      The HTTP response.

    • parse

      public static AccessTokenResponse parse(net.minidev.json.JSONObject jsonObject) throws ParseException
      Parses an access token response from the specified JSON object.
      Parameters:
      jsonObject - The JSON object to parse. Must not be null.
      Returns:
      The access token response.
      Throws:
      ParseException - If the JSON object couldn't be parsed to an access token response.

    • parse

      public static AccessTokenResponse parse(HTTPResponse httpResponse) throws ParseException
      Parses an access token response from the specified HTTP response.
      Parameters:
      httpResponse - The HTTP response. Must not be null.
      Returns:
      The access token response.
      Throws:
      ParseException - If the HTTP response couldn't be parsed to an access token response.