Class BearerTokenError

java.lang.Object

org.springframework.security.oauth2.core.OAuth2Error

org.springframework.security.oauth2.server.resource.BearerTokenError

All Implemented Interfaces:

Serializable

public final class BearerTokenError
extends OAuth2Error

A representation of a Bearer Token Error.

Since:

5.1

See Also:

• BearerTokenErrorCodes
• RFC 6750 Section 3: The WWW-Authenticate Response Header Field
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
BearerTokenError(String errorCode, org.springframework.http.HttpStatus httpStatus, @Nullable String description, @Nullable String errorUri)	Create a BearerTokenError using the provided parameters
BearerTokenError(String errorCode, org.springframework.http.HttpStatus httpStatus, @Nullable String description, @Nullable String errorUri, @Nullable String scope)	Create a BearerTokenError using the provided parameters

Method Summary

Modifier and Type	Method	Description
org.springframework.http.HttpStatus	getHttpStatus()	Return the HTTP status.
@Nullable String	getScope()	Return the scope.

Methods inherited from class OAuth2Error

getDescription, getErrorCode, getUri, toString

Methods inherited from class Object

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

Constructor Details

BearerTokenError

public BearerTokenError(String errorCode,
 org.springframework.http.HttpStatus httpStatus,
 @Nullable String description,
 @Nullable String errorUri)

Create a BearerTokenError using the provided parameters

Parameters:

errorCode - the error code

httpStatus - the HTTP status

BearerTokenError

public BearerTokenError(String errorCode,
 org.springframework.http.HttpStatus httpStatus,
 @Nullable String description,
 @Nullable String errorUri,
 @Nullable String scope)

Create a BearerTokenError using the provided parameters

Parameters:

errorCode - the error code

httpStatus - the HTTP status

description - the description

errorUri - the URI

scope - the scope

Method Details

getHttpStatus

public org.springframework.http.HttpStatus getHttpStatus()

Return the HTTP status.

Returns:

the HTTP status

getScope

public @Nullable String getScope()

Return the scope.

Returns:

the scope, or null if not set