Saml2LogoutValidatorResult (spring-security-docs 5.7.0-M2 API)

java.lang.Object
- org.springframework.security.saml2.provider.service.authentication.logout.Saml2LogoutValidatorResult

public final class Saml2LogoutValidatorResult
extends java.lang.Object

A result emitted from a SAML 2.0 Logout validation attempt

Since:: 5.6

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Saml2LogoutValidatorResult.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.Collection<Saml2Error>`	`getErrors()`	Return error details regarding the validation attempt
`boolean`	`hasErrors()`	Say whether this result indicates success
`static Saml2LogoutValidatorResult`	`success()`	Construct a successful `Saml2LogoutValidatorResult`
`static Saml2LogoutValidatorResult.Builder`	`withErrors(Saml2Error... errors)`	Construct a `Saml2LogoutValidatorResult.Builder`, starting with the given `errors`.

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<Saml2Error> 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 Saml2LogoutValidatorResult success()
```
    Construct a successful Saml2LogoutValidatorResult
    
    Returns:
    
    an Saml2LogoutValidatorResult with no errors
  - withErrors
```
public static Saml2LogoutValidatorResult.Builder withErrors(Saml2Error... errors)
```
    Construct a Saml2LogoutValidatorResult.Builder, starting with the given errors. Note that a result with no errors is considered a success.
    
    Parameters:
    
    errors -
    
    Returns: