Package org.springframework.security.oauth2.server.authorization.authentication

Class OAuth2AuthorizationCodeRequestAuthenticationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.springframework.security.core.AuthenticationException

org.springframework.security.oauth2.core.OAuth2AuthenticationException

org.springframework.security.oauth2.server.authorization.authentication.OAuth2AuthorizationCodeRequestAuthenticationException

All Implemented Interfaces:

Serializable

public class OAuth2AuthorizationCodeRequestAuthenticationException
extends OAuth2AuthenticationException

This exception is thrown by OAuth2AuthorizationCodeRequestAuthenticationProvider when an attempt to authenticate the OAuth 2.0 Authorization Request (or Consent) fails.

Since:

7.0

See Also:

• OAuth2AuthorizationCodeRequestAuthenticationToken
• OAuth2AuthorizationCodeRequestAuthenticationProvider
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
OAuth2AuthorizationCodeRequestAuthenticationException(OAuth2Error error, Throwable cause, OAuth2AuthorizationCodeRequestAuthenticationToken authorizationCodeRequestAuthentication)	Constructs an OAuth2AuthorizationCodeRequestAuthenticationException using the provided parameters.
OAuth2AuthorizationCodeRequestAuthenticationException(OAuth2Error error, OAuth2AuthorizationCodeRequestAuthenticationToken authorizationCodeRequestAuthentication)	Constructs an OAuth2AuthorizationCodeRequestAuthenticationException using the provided parameters.

Method Summary

Modifier and Type	Method	Description
OAuth2AuthorizationCodeRequestAuthenticationToken	getAuthorizationCodeRequestAuthentication()	Returns the Authentication instance of the OAuth 2.0 Authorization Request (or Consent), or null if not available.

Methods inherited from class org.springframework.security.oauth2.core.OAuth2AuthenticationException

getError

Methods inherited from class org.springframework.security.core.AuthenticationException

getAuthenticationRequest, setAuthenticationRequest

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Details

OAuth2AuthorizationCodeRequestAuthenticationException

public OAuth2AuthorizationCodeRequestAuthenticationException(OAuth2Error error,
 @Nullable
 OAuth2AuthorizationCodeRequestAuthenticationToken authorizationCodeRequestAuthentication)

Constructs an OAuth2AuthorizationCodeRequestAuthenticationException using the provided parameters.

Parameters:

error - the OAuth 2.0 Error

authorizationCodeRequestAuthentication - the Authentication instance of the OAuth 2.0 Authorization Request (or Consent)

OAuth2AuthorizationCodeRequestAuthenticationException

public OAuth2AuthorizationCodeRequestAuthenticationException(OAuth2Error error,
 Throwable cause,
 @Nullable
 OAuth2AuthorizationCodeRequestAuthenticationToken authorizationCodeRequestAuthentication)

Constructs an OAuth2AuthorizationCodeRequestAuthenticationException using the provided parameters.

Parameters:

error - the OAuth 2.0 Error

cause - the root cause

authorizationCodeRequestAuthentication - the Authentication instance of the OAuth 2.0 Authorization Request (or Consent)

Method Details

getAuthorizationCodeRequestAuthentication

@Nullable
public OAuth2AuthorizationCodeRequestAuthenticationToken getAuthorizationCodeRequestAuthentication()

Returns the Authentication instance of the OAuth 2.0 Authorization Request (or Consent), or null if not available.

Returns:

the OAuth2AuthorizationCodeRequestAuthenticationToken