Class OAuth2Error

java.lang.Object

org.springframework.security.oauth2.core.OAuth2Error

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BearerTokenError

public class OAuth2Error
extends Object
implements Serializable

A representation of an OAuth 2.0 Error.

At a minimum, an error response will contain an error code. The error code may be one of the standard codes defined by the specification, or a new code defined in the OAuth Extensions Error Registry, for cases where protocol extensions require additional error code(s) above the standard codes.

Since:

5.0

See Also:

• OAuth2ErrorCodes
• Section 11.4 OAuth Extensions Error Registry
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
OAuth2Error(String errorCode)	Constructs an OAuth2Error using the provided parameters.
OAuth2Error(String errorCode, @Nullable String description, @Nullable String uri)	Constructs an OAuth2Error using the provided parameters.

Method Summary

Modifier and Type	Method	Description
final @Nullable String	getDescription()	Returns the error description.
final String	getErrorCode()	Returns the error code.
final @Nullable String	getUri()	Returns the error uri.
String	toString()

Methods inherited from class Object

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

Constructor Details

OAuth2Error

public OAuth2Error(String errorCode)

Constructs an OAuth2Error using the provided parameters.

Parameters:

errorCode - the error code

OAuth2Error

public OAuth2Error(String errorCode,
 @Nullable String description,
 @Nullable String uri)

Constructs an OAuth2Error using the provided parameters.

Parameters:

errorCode - the error code

description - the error description, may be null

uri - the error uri, may be null

Method Details

getErrorCode

public final String getErrorCode()

Returns the error code.

Returns:

the error code

getDescription

public final @Nullable String getDescription()

Returns the error description.

Returns:

the error description, or null if not available

getUri

public final @Nullable String getUri()

Returns the error uri.

Returns:

the error uri, or null if not available

toString

public String toString()

Overrides:

toString in class Object