org.springframework.security.oauth2.client

Class ClientAuthorizationRequiredException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.springframework.security.oauth2.client.OAuth2ClientException

org.springframework.security.oauth2.client.ClientAuthorizationRequiredException

All Implemented Interfaces:

java.io.Serializable

public class ClientAuthorizationRequiredException
extends OAuth2ClientException

This exception is thrown when an OAuth 2.0 Client is required to obtain authorization from the Resource Owner.

Since:

5.1

See Also:

OAuth2AuthorizedClient, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClientAuthorizationRequiredException(java.lang.String clientRegistrationId) Constructs a ClientAuthorizationRequiredException using the provided parameters.
ClientAuthorizationRequiredException(java.lang.String clientRegistrationId, java.lang.String message) Constructs a ClientAuthorizationRequiredException using the provided parameters.

Method Summary

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

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 Detail

ClientAuthorizationRequiredException

public ClientAuthorizationRequiredException(java.lang.String clientRegistrationId)

Constructs a ClientAuthorizationRequiredException using the provided parameters.

Parameters:

clientRegistrationId - the identifier for the client's registration

ClientAuthorizationRequiredException

public ClientAuthorizationRequiredException(java.lang.String clientRegistrationId,
                                            java.lang.String message)

Constructs a ClientAuthorizationRequiredException using the provided parameters.

Parameters:

clientRegistrationId - the identifier for the client's registration

message - the detail message

Method Detail

getClientRegistrationId

public java.lang.String getClientRegistrationId()

Returns the identifier for the client's registration.

Returns:

the identifier for the client's registration