Package org.springframework.security.saml2.provider.service.authentication.logout

Class Saml2LogoutValidatorResult

java.lang.Object

org.springframework.security.saml2.provider.service.authentication.logout.Saml2LogoutValidatorResult

public final class Saml2LogoutValidatorResult
extends 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 final class	Saml2LogoutValidatorResult.Builder

Method Summary

Modifier and Type	Method	Description
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 Details

hasErrors

public boolean hasErrors()

Say whether this result indicates success

Returns:

whether this result has errors

getErrors

public 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: