Package org.springframework.security.saml2.core

Class Saml2ResponseValidatorResult

java.lang.Object

org.springframework.security.saml2.core.Saml2ResponseValidatorResult

public final class Saml2ResponseValidatorResult
extends Object

A result emitted from a SAML 2.0 Response validation attempt

Since:

5.4

Method Summary

Modifier and Type	Method	Description
Saml2ResponseValidatorResult	concat(Saml2Error error)	Return a new Saml2ResponseValidatorResult that contains both the given Saml2Error and the errors from the result.
Saml2ResponseValidatorResult	concat(Saml2ResponseValidatorResult result)	Return a new Saml2ResponseValidatorResult that contains the errors from the given Saml2ResponseValidatorResult as well as this result.
static Saml2ResponseValidatorResult	failure(Collection<Saml2Error> errors)	Construct a failure Saml2ResponseValidatorResult with the provided detail.
static Saml2ResponseValidatorResult	failure(Saml2Error... errors)	Construct a failure Saml2ResponseValidatorResult with the provided detail.
Collection<Saml2Error>	getErrors()	Return error details regarding the validation attempt.
boolean	hasErrors()	Say whether this result indicates success.
static Saml2ResponseValidatorResult	success()	Construct a successful Saml2ResponseValidatorResult.

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

concat

public Saml2ResponseValidatorResult concat(Saml2Error error)

Return a new Saml2ResponseValidatorResult that contains both the given Saml2Error and the errors from the result.

Parameters:

error - the Saml2Error to append

Returns:

a new Saml2ResponseValidatorResult for further reporting

concat

public Saml2ResponseValidatorResult concat(Saml2ResponseValidatorResult result)

Return a new Saml2ResponseValidatorResult that contains the errors from the given Saml2ResponseValidatorResult as well as this result.

Parameters:

result - the Saml2ResponseValidatorResult to merge with this one

Returns:

a new Saml2ResponseValidatorResult for further reporting

success

public static Saml2ResponseValidatorResult success()

Construct a successful Saml2ResponseValidatorResult.

Returns:

an Saml2ResponseValidatorResult with no errors

failure

public static Saml2ResponseValidatorResult failure(Saml2Error... errors)

Construct a failure Saml2ResponseValidatorResult with the provided detail.

Parameters:

errors - the list of errors

Returns:

an Saml2ResponseValidatorResult with the errors specified

failure

public static Saml2ResponseValidatorResult failure(Collection<Saml2Error> errors)

Construct a failure Saml2ResponseValidatorResult with the provided detail.

Parameters:

errors - the list of errors

Returns:

an Saml2ResponseValidatorResult with the errors specified