Package org.springframework.security.oauth2.client

Class ClientAuthorizationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.springframework.security.oauth2.core.OAuth2AuthorizationException

org.springframework.security.oauth2.client.ClientAuthorizationException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ClientAuthorizationRequiredException

public class ClientAuthorizationException
extends OAuth2AuthorizationException

This exception is thrown on the client side when an attempt to authenticate or authorize an OAuth 2.0 client fails.

Since:

5.3

See Also:

• OAuth2AuthorizedClient
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ClientAuthorizationException(OAuth2Error error, String clientRegistrationId)	Constructs a ClientAuthorizationException using the provided parameters.
ClientAuthorizationException(OAuth2Error error, String clientRegistrationId, String message)	Constructs a ClientAuthorizationException using the provided parameters.
ClientAuthorizationException(OAuth2Error error, String clientRegistrationId, String message, Throwable cause)	Constructs a ClientAuthorizationException using the provided parameters.
ClientAuthorizationException(OAuth2Error error, String clientRegistrationId, Throwable cause)	Constructs a ClientAuthorizationException using the provided parameters.

Method Summary

Modifier and Type	Method	Description
String	getClientRegistrationId()	Returns the identifier for the client's registration.

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

getError

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

ClientAuthorizationException

public ClientAuthorizationException(OAuth2Error error,
 String clientRegistrationId)

Constructs a ClientAuthorizationException using the provided parameters.

Parameters:

error - the OAuth 2.0 Error

clientRegistrationId - the identifier for the client's registration

ClientAuthorizationException

public ClientAuthorizationException(OAuth2Error error,
 String clientRegistrationId,
 String message)

Constructs a ClientAuthorizationException using the provided parameters.

Parameters:

error - the OAuth 2.0 Error

clientRegistrationId - the identifier for the client's registration

message - the exception message

ClientAuthorizationException

public ClientAuthorizationException(OAuth2Error error,
 String clientRegistrationId,
 Throwable cause)

Constructs a ClientAuthorizationException using the provided parameters.

Parameters:

error - the OAuth 2.0 Error

clientRegistrationId - the identifier for the client's registration

cause - the root cause

ClientAuthorizationException

public ClientAuthorizationException(OAuth2Error error,
 String clientRegistrationId,
 String message,
 Throwable cause)

Constructs a ClientAuthorizationException using the provided parameters.

Parameters:

error - the OAuth 2.0 Error

clientRegistrationId - the identifier for the client's registration

message - the exception message

cause - the root cause

Method Details

getClientRegistrationId

public String getClientRegistrationId()

Returns the identifier for the client's registration.

Returns:

the identifier for the client's registration