Class Saml2ResponseValidatorResult
- java.lang.Object
-
- org.springframework.security.saml2.core.Saml2ResponseValidatorResult
-
public final class Saml2ResponseValidatorResult extends java.lang.Object
A result emitted from a SAML 2.0 Response validation attempt- Since:
- 5.4
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Saml2ResponseValidatorResult
concat(Saml2Error error)
Return a newSaml2ResponseValidatorResult
that contains both the givenSaml2Error
and the errors from the resultSaml2ResponseValidatorResult
concat(Saml2ResponseValidatorResult result)
Return a newSaml2ResponseValidatorResult
that contains the errors from the givenSaml2ResponseValidatorResult
as well as this result.static Saml2ResponseValidatorResult
failure(java.util.Collection<Saml2Error> errors)
Construct a failureSaml2ResponseValidatorResult
with the provided detailstatic Saml2ResponseValidatorResult
failure(Saml2Error... errors)
Construct a failureSaml2ResponseValidatorResult
with the provided detailjava.util.Collection<Saml2Error>
getErrors()
Return error details regarding the validation attemptboolean
hasErrors()
Say whether this result indicates successstatic Saml2ResponseValidatorResult
success()
Construct a successfulSaml2ResponseValidatorResult
-
-
-
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
-
concat
public Saml2ResponseValidatorResult concat(Saml2Error error)
Return a newSaml2ResponseValidatorResult
that contains both the givenSaml2Error
and the errors from the result- Parameters:
error
- theSaml2Error
to append- Returns:
- a new
Saml2ResponseValidatorResult
for further reporting
-
concat
public Saml2ResponseValidatorResult concat(Saml2ResponseValidatorResult result)
Return a newSaml2ResponseValidatorResult
that contains the errors from the givenSaml2ResponseValidatorResult
as well as this result.- Parameters:
result
- theSaml2ResponseValidatorResult
to merge with this one- Returns:
- a new
Saml2ResponseValidatorResult
for further reporting
-
success
public static Saml2ResponseValidatorResult success()
Construct a successfulSaml2ResponseValidatorResult
- Returns:
- an
Saml2ResponseValidatorResult
with no errors
-
failure
public static Saml2ResponseValidatorResult failure(Saml2Error... errors)
Construct a failureSaml2ResponseValidatorResult
with the provided detail- Parameters:
errors
- the list of errors- Returns:
- an
Saml2ResponseValidatorResult
with the errors specified
-
failure
public static Saml2ResponseValidatorResult failure(java.util.Collection<Saml2Error> errors)
Construct a failureSaml2ResponseValidatorResult
with the provided detail- Parameters:
errors
- the list of errors- Returns:
- an
Saml2ResponseValidatorResult
with the errors specified
-
-