com.nimbusds.openid.connect.sdk

Class OIDCTokenErrorResponse

java.lang.Object

com.nimbusds.oauth2.sdk.TokenResponse

com.nimbusds.oauth2.sdk.TokenErrorResponse

com.nimbusds.openid.connect.sdk.OIDCTokenErrorResponse

All Implemented Interfaces:

ErrorResponse, Message, Response, OIDCTokenResponse

@Immutable
public class OIDCTokenErrorResponse
extends TokenErrorResponse
implements OIDCTokenResponse

OpenID Connect token error response. This class is immutable.

Standard token errors:

• OAuth2Error.INVALID_REQUEST
• OAuth2Error.INVALID_CLIENT
• OAuth2Error.INVALID_GRANT
• OAuth2Error.UNAUTHORIZED_CLIENT
• OAuth2Error.UNSUPPORTED_GRANT_TYPE
• OAuth2Error.INVALID_SCOPE

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:

• OpenID Connect Messages 1.0, section 2.1.3.
• OpenID Connect Standard 1.0, section 2.3.5.2.

Author:

Vladimir Dzhuvinov

Constructor Summary

Constructors

Constructor and Description
OIDCTokenErrorResponse(ErrorObject error) Creates a new OpenID Connect token error response.

Method Summary

Methods

Modifier and Type	Method and Description
static OIDCTokenErrorResponse	parse(HTTPResponse httpResponse) Parses an OpenID Connect token error response from the specified HTTP response.
static OIDCTokenErrorResponse	parse(net.minidev.json.JSONObject jsonObject) Parses an OpenID Connect token error response from the specified JSON object.

Methods inherited from class com.nimbusds.oauth2.sdk.TokenErrorResponse

getErrorObject, getStandardErrors, toHTTPResponse, toJSONObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.nimbusds.oauth2.sdk.Response

toHTTPResponse

Constructor Detail

OIDCTokenErrorResponse

public OIDCTokenErrorResponse(ErrorObject error)

Creates a new OpenID Connect token error response.

Parameters:

error - The error. Should match one of the standard errors for a token error response. Must not be null.

Method Detail

parse

public static OIDCTokenErrorResponse parse(net.minidev.json.JSONObject jsonObject)
                                    throws ParseException

Parses an OpenID Connect 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.

Throws:

ParseException - If the JSON object couldn't be parsed to an OpenID Connect token error response.

parse

public static OIDCTokenErrorResponse parse(HTTPResponse httpResponse)
                                    throws ParseException

Parses an OpenID Connect 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.

Throws:

ParseException - If the JSON object couldn't be parsed to an OpenID Connect token error response.