com.nimbusds.openid.connect.sdk

Class OIDCAuthorizationErrorResponse

java.lang.Object

com.nimbusds.oauth2.sdk.AuthorizationResponse

com.nimbusds.oauth2.sdk.AuthorizationErrorResponse

com.nimbusds.openid.connect.sdk.OIDCAuthorizationErrorResponse

All Implemented Interfaces:

ErrorResponse, Message, Response, OIDCAuthorizationResponse

@Immutable
public class OIDCAuthorizationErrorResponse
extends AuthorizationErrorResponse
implements OIDCAuthorizationResponse

OpenID Connect authorisation error response. This class is immutable.

Standard errors:

• OAuth 2.0 authorisation errors:
  • OAuth2Error.INVALID_REQUEST
  • OAuth2Error.UNAUTHORIZED_CLIENT
  • OAuth2Error.ACCESS_DENIED
  • OAuth2Error.UNSUPPORTED_RESPONSE_TYPE
  • OAuth2Error.INVALID_SCOPE
  • OAuth2Error.SERVER_ERROR
  • OAuth2Error.TEMPORARILY_UNAVAILABLE
• OpenID Connect specific errors:
  • OIDCError.INTERACTION_REQUIRED
  • OIDCError.LOGIN_REQUIRED
  • OIDCError.SESSION_SELECTION_REQUIRED
  • OIDCError.CONSENT_REQUIRED
  • OIDCError.INVALID_REQUEST_URI
  • OIDCError.INVALID_REQUEST_OBJECT
  • OIDCError.REGISTRATION_NOT_SUPPORTED
  • OIDCError.REQUEST_NOT_SUPPORTED
  • OIDCError.REQUEST_URI_NOT_SUPPORTED

Example HTTP response:

 HTTP/1.1 302 Found
 Location: https://client.example.org/cb?
           error=invalid_request
           &error_description=the%20request%20is%20not%20valid%20or%20malformed
           &state=af0ifjsldkj
 

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
OIDCAuthorizationErrorResponse(URL redirectURI, ErrorObject error, ResponseType rt, State state) Creates a new OpenID Connect authorisation error response.

Method Summary

Methods

Modifier and Type	Method and Description
static Set<ErrorObject>	getStandardErrors() Gets the standard errors for an OpenID Connect Authorisation error response.
static OIDCAuthorizationErrorResponse	parse(HTTPResponse httpResponse) Parses an OpenID Connect authorisation error response from the specified HTTP response.
static OIDCAuthorizationErrorResponse	parse(URL uri) Parses an OpenID Connect authorisation error response from the specified URI.
static OIDCAuthorizationErrorResponse	parse(URL redirectURI, Map<String,String> params) Parses an OpenID Connect authorisation error response from the specified redirect URI and parameters.

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

getErrorObject, getResponseType, toParameters, toURI

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

getRedirectionURI, getState, toHTTPResponse

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

OIDCAuthorizationErrorResponse

public OIDCAuthorizationErrorResponse(URL redirectURI,
                              ErrorObject error,
                              ResponseType rt,
                              State state)

Creates a new OpenID Connect authorisation error response.

Parameters:

redirectURI - The base redirect URI. Must not be null.

error - The error. Should match one of the standard errors for an OpenID Connect authorisation error response. Must not be null.

rt - The response type, used to determine the redirect URI composition. If unknown null.

state - The state, null if not requested.

Method Detail

getStandardErrors

public static Set<ErrorObject> getStandardErrors()

Gets the standard errors for an OpenID Connect Authorisation error response.

Returns:

The standard errors, as a read-only set.

parse

public static OIDCAuthorizationErrorResponse parse(URL redirectURI,
                                   Map<String,String> params)
                                            throws ParseException

Parses an OpenID Connect authorisation error response from the specified redirect URI and parameters.

Parameters:

redirectURI - The base redirect URI. Must not be null.

params - The response parameters to parse. Must not be null.

Returns:

The OpenID Connect authorisation error response.

Throws:

ParseException - If the parameters couldn't be parsed to an OpenID Connect authorisation error response.

parse

public static OIDCAuthorizationErrorResponse parse(URL uri)
                                            throws ParseException

Parses an OpenID Connect authorisation error response from the specified URI.

Example URI:

 https://client.example.com/cb?
 error=invalid_request
 &error_description=the%20request%20is%20not%20valid%20or%20malformed
 &state=af0ifjsldkj
 

Parameters:

uri - The URI to parse. Can be absolute or relative. Must not be null.

Returns:

The OpenID Connect authorisation error response.

Throws:

ParseException - If the URI couldn't be parsed to an OpenID Connect authorisation error response.

parse

public static OIDCAuthorizationErrorResponse parse(HTTPResponse httpResponse)
                                            throws ParseException

Parses an OpenID Connect authorisation error response from the specified HTTP response.

Example HTTP response:

 HTTP/1.1 302 Found
 Location: https://client.example.com/cb?
 error=invalid_request
 &error_description=the%20request%20is%20not%20valid%20or%20malformed
 &state=af0ifjsldkj
 

Parameters:

httpResponse - The HTTP response to parse. Must not be null.

Returns:

The OpenID Connect authorisation error response.

Throws:

ParseException - If the HTTP response couldn't be parsed to an OpenID Connect authorisation error response.