Package com.nimbusds.oauth2.sdk

Class TokenErrorResponse

java.lang.Object
com.nimbusds.oauth2.sdk.TokenResponse
com.nimbusds.oauth2.sdk.TokenErrorResponse
All Implemented Interfaces:
ErrorResponse, Message, Response
@Immutable public class TokenErrorResponse extends TokenResponse implements ErrorResponse
OAuth 2.0 Token error response.

Standard token errors:

Example HTTP response: 

 HTTP/1.1 400 Bad Request
 Content-Type: application/json
 Cache-Control: no-store
 Pragma: no-cache
 
 {
  "error": "invalid_request"
 }

Related specifications:

  • OAuth 2.0 (RFC 6749), section 5.2.

  • Constructor Details

    • TokenErrorResponse

      protected TokenErrorResponse()
      Creates a new OAuth 2.0 Access Token error response. No OAuth 2.0 error is specified.

    • TokenErrorResponse

      public TokenErrorResponse(ErrorObject error)
      Creates a new OAuth 2.0 Access Token error response.
      Parameters:
      error - The error. Should match one of the standard errors for a token error response. Must not be null.

  • Method Details

    • getStandardErrors

      public static Set<ErrorObject> getStandardErrors()
      Gets the standard OAuth 2.0 errors for an Access Token error response.
      Returns:
      The standard errors, as a read-only set.

    • 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.

    • getErrorObject

      public ErrorObject getErrorObject()
      Description copied from interface: ErrorResponse
      Gets the error associated with the error response.
      Specified by:
      getErrorObject in interface ErrorResponse
      Returns:
      The error, null if none.

    • toJSONObject

      public net.minidev.json.JSONObject toJSONObject()
      Returns the JSON object for this token error response.
      Returns:
      The JSON object for this token error response.

    • 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 TokenErrorResponse parse(net.minidev.json.JSONObject jsonObject) throws ParseException
      Parses an OAuth 2.0 Token Error response from the specified JSON object.
      Parameters:
      jsonObject - The JSON object to parse. Its status code must not be 200 (OK). Must not be null.
      Returns:
      The token error response.
      Throws:
      ParseException - If the JSON object couldn't be parsed to an OAuth 2.0 Token Error response.

    • parse

      public static TokenErrorResponse parse(HTTPResponse httpResponse) throws ParseException
      Parses an OAuth 2.0 Token Error response from the specified HTTP response.
      Parameters:
      httpResponse - The HTTP response to parse. Its status code must not be 200 (OK). Must not be null.
      Returns:
      The token error response.
      Throws:
      ParseException - If the HTTP response couldn't be parsed to an OAuth 2.0 Token Error response.