com.nimbusds.openid.connect.sdk

Class AuthenticationErrorResponse

java.lang.Object

com.nimbusds.oauth2.sdk.AuthorizationResponse

com.nimbusds.oauth2.sdk.AuthorizationErrorResponse

com.nimbusds.openid.connect.sdk.AuthenticationErrorResponse

All Implemented Interfaces:

ErrorResponse, Message, Response, AuthenticationResponse

@Immutable
public class AuthenticationErrorResponse
extends AuthorizationErrorResponse
implements AuthenticationResponse

OpenID Connect authentication error response.

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.ACCOUNT_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 Core 1.0, section 3.1.2.6.

Constructor Summary

Constructors

Constructor and Description
AuthenticationErrorResponse(java.net.URI redirectURI, ErrorObject error, ResponseType rt, State state) Creates a new OpenID Connect authentication error response.

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.Set<ErrorObject>	getStandardErrors() Gets the standard errors for an OpenID Connect authentication error response.
static AuthenticationErrorResponse	parse(HTTPResponse httpResponse) Parses an OpenID Connect authentication error response from the specified HTTP response.
static AuthenticationErrorResponse	parse(java.net.URI uri) Parses an OpenID Connect authentication error response from the specified URI.
static AuthenticationErrorResponse	parse(java.net.URI redirectURI, java.util.Map<java.lang.String,java.lang.String> params) Parses an OpenID Connect authentication error response from the specified redirection URI and parameters.
java.net.URI	toURI() Returns the URI representation (redirection URI + fragment / query string) of this authorisation response.

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

getErrorObject, getResponseType, toParameters

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.openid.connect.sdk.AuthenticationResponse

getRedirectionURI, getState

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

toHTTPResponse

Constructor Detail

AuthenticationErrorResponse

public AuthenticationErrorResponse(java.net.URI redirectURI,
                           ErrorObject error,
                           ResponseType rt,
                           State state)

Creates a new OpenID Connect authentication error response.

Parameters:

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

error - The error. Should match one of the standard errors for an OpenID Connect authentication 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 java.util.Set<ErrorObject> getStandardErrors()

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

Returns:

The standard errors, as a read-only set.

toURI

public java.net.URI toURI()
                   throws SerializeException

Description copied from class: AuthorizationResponse

Returns the URI representation (redirection URI + fragment / query string) of this authorisation response.

Example URI:

 http://example.com/cb#access_token=2YotnFZFEjr1zCsicMWpAA
 &state=xyz
 &token_type=example
 &expires_in=3600
 

Overrides:

toURI in class AuthorizationErrorResponse

Returns:

The URI representation of this authorisation response.

Throws:

SerializeException - If this response couldn't be serialised to a URI.

parse

public static AuthenticationErrorResponse parse(java.net.URI redirectURI,
                                java.util.Map<java.lang.String,java.lang.String> params)
                                         throws ParseException

Parses an OpenID Connect authentication error response from the specified redirection URI and parameters.

Parameters:

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

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

Returns:

The OpenID Connect authentication error response.

Throws:

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

parse

public static AuthenticationErrorResponse parse(java.net.URI uri)
                                         throws ParseException

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

Throws:

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

parse

public static AuthenticationErrorResponse parse(HTTPResponse httpResponse)
                                         throws ParseException

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

Throws:

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