OAuth2TokenValidatorResult (spring-security-docs-manual 5.5.2 API)

java.lang.Object
- org.springframework.security.oauth2.core.OAuth2TokenValidatorResult

public final class OAuth2TokenValidatorResult
extends java.lang.Object

A result emitted from an OAuth2TokenValidator validation attempt

Since:: 5.1

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static OAuth2TokenValidatorResult`	`failure(java.util.Collection<OAuth2Error> errors)`	Construct a failure `OAuth2TokenValidatorResult` with the provided detail
`static OAuth2TokenValidatorResult`	`failure(OAuth2Error... errors)`	Construct a failure `OAuth2TokenValidatorResult` with the provided detail
`java.util.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 Detail
  - hasErrors
```
public boolean hasErrors()
```
    Say whether this result indicates success
    
    Returns:
    
    whether this result has errors
  - getErrors
```
public java.util.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(java.util.Collection<OAuth2Error> errors)
```
    Construct a failure OAuth2TokenValidatorResult with the provided detail
    
    Parameters:
    
    errors - the list of errors
    
    Returns:
    
    an OAuth2TokenValidatorResult with the errors specified