Package org.springframework.security.oauth2.core

Class OAuth2TokenValidatorResult

java.lang.Object

org.springframework.security.oauth2.core.OAuth2TokenValidatorResult

public final class OAuth2TokenValidatorResult
extends Object

A result emitted from an OAuth2TokenValidator validation attempt

Since:

5.1

Method Summary

Modifier and Type	Method	Description
static OAuth2TokenValidatorResult	failure(Collection<OAuth2Error> errors)	Construct a failure OAuth2TokenValidatorResult with the provided detail
static OAuth2TokenValidatorResult	failure(OAuth2Error... errors)	Construct a failure OAuth2TokenValidatorResult with the provided detail
Collection<OAuth2Error>	getErrors()	Return error details regarding the validation attempt
boolean	hasErrors()	Say whether this result indicates success
static OAuth2TokenValidatorResult	success()	Construct a successful OAuth2TokenValidatorResult

Methods inherited from class java.lang.Object

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

Method Details

hasErrors

public boolean hasErrors()

Say whether this result indicates success

Returns:

whether this result has errors

getErrors

public Collection<OAuth2Error> getErrors()

Return error details regarding the validation attempt

Returns:

the collection of results in this result, if any; returns an empty list otherwise

success

public static OAuth2TokenValidatorResult success()

Construct a successful OAuth2TokenValidatorResult

Returns:

an OAuth2TokenValidatorResult with no errors

failure

public static OAuth2TokenValidatorResult failure(OAuth2Error... errors)

Construct a failure OAuth2TokenValidatorResult with the provided detail

Parameters:

errors - the list of errors

Returns:

an OAuth2TokenValidatorResult with the errors specified

failure

public static OAuth2TokenValidatorResult failure(Collection<OAuth2Error> errors)

Construct a failure OAuth2TokenValidatorResult with the provided detail

Parameters:

errors - the list of errors

Returns:

an OAuth2TokenValidatorResult with the errors specified