Package se.swedenconnect.spring.saml.idp.error

Enum Class UnrecoverableSaml2IdpError

java.lang.Object

java.lang.Enum<UnrecoverableSaml2IdpError>

se.swedenconnect.spring.saml.idp.error.UnrecoverableSaml2IdpError

All Implemented Interfaces:

Serializable, Comparable<UnrecoverableSaml2IdpError>, Constable

public enum UnrecoverableSaml2IdpError
extends Enum<UnrecoverableSaml2IdpError>

An enum representing unrecoverable SAML errors, i.e., such errors that can not be signalled back to the SAML SP.

Author:

Martin Lindström

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ENDPOINT_CHECK_FAILURE	Used if destination endpoint information does not match the actual endpoint on which the message was received.
FAILED_DECODE	Failure to decode AuthnRequest.
INTERNAL	Internal error.
INVALID_ASSERTION_CONSUMER_SERVICE	The AssertionConsumerService indicated in the AuthnRequest is not registered in the Service Provider metadata.
INVALID_AUTHNREQUEST_FORMAT	Bad format on AuthnRequest.
INVALID_AUTHNREQUEST_SIGNATURE	Validation of signature on authentication request failed.
INVALID_SESSION	For session related errors.
MESSAGE_TOO_OLD	If timestamp checks fails.
MISSING_AUTHNREQUEST_SIGNATURE	Error reported if signed authentication requests are required, but a signature is missing from a received authentication request.
REPLAY_DETECTED	For replay (attacks) of authentication requests.
UNKNOWN_PEER	The sender of an AuthnRequest message could not be found in SAML metadata.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets the textual representation of the error.
String	getMessageCode()	Gets the message code representing the error.
static UnrecoverableSaml2IdpError	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UnrecoverableSaml2IdpError[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INTERNAL

public static final UnrecoverableSaml2IdpError INTERNAL

Internal error.

UNKNOWN_PEER

public static final UnrecoverableSaml2IdpError UNKNOWN_PEER

The sender of an AuthnRequest message could not be found in SAML metadata.

REPLAY_DETECTED

public static final UnrecoverableSaml2IdpError REPLAY_DETECTED

For replay (attacks) of authentication requests.

MESSAGE_TOO_OLD

public static final UnrecoverableSaml2IdpError MESSAGE_TOO_OLD

If timestamp checks fails.

INVALID_ASSERTION_CONSUMER_SERVICE

public static final UnrecoverableSaml2IdpError INVALID_ASSERTION_CONSUMER_SERVICE

The AssertionConsumerService indicated in the AuthnRequest is not registered in the Service Provider metadata.

MISSING_AUTHNREQUEST_SIGNATURE

public static final UnrecoverableSaml2IdpError MISSING_AUTHNREQUEST_SIGNATURE

Error reported if signed authentication requests are required, but a signature is missing from a received authentication request.

INVALID_AUTHNREQUEST_SIGNATURE

public static final UnrecoverableSaml2IdpError INVALID_AUTHNREQUEST_SIGNATURE

Validation of signature on authentication request failed.

INVALID_AUTHNREQUEST_FORMAT

public static final UnrecoverableSaml2IdpError INVALID_AUTHNREQUEST_FORMAT

Bad format on AuthnRequest.

FAILED_DECODE

public static final UnrecoverableSaml2IdpError FAILED_DECODE

Failure to decode AuthnRequest.

ENDPOINT_CHECK_FAILURE

public static final UnrecoverableSaml2IdpError ENDPOINT_CHECK_FAILURE

Used if destination endpoint information does not match the actual endpoint on which the message was received.

INVALID_SESSION

public static final UnrecoverableSaml2IdpError INVALID_SESSION

For session related errors.

Method Details

values

public static UnrecoverableSaml2IdpError[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static UnrecoverableSaml2IdpError valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getMessageCode

public String getMessageCode()

Gets the message code representing the error. This code may be used when mapping to a MessageSource.

Returns:

the message code

getDescription

public String getDescription()

Gets the textual representation of the error. May be used in logs.

Returns:

the textual representation of the error