Class Saml2Error

java.lang.Object

org.springframework.security.saml2.core.Saml2Error

All Implemented Interfaces:

Serializable

public class Saml2Error
extends Object
implements Serializable

A representation of an SAML 2.0 Error.

At a minimum, an error response will contain an error code. The commonly used error code are defined in this class or a new codes can be defined in the future as arbitrary strings.

Since:

5.2

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Saml2Error(String errorCode, @Nullable String description)	Constructs a Saml2Error using the provided parameters.

Method Summary

Modifier and Type	Method	Description
static Saml2Error	decryptionError(@Nullable String description)	Construct an Saml2ErrorCodes.DECRYPTION_ERROR error
final @Nullable String	getDescription()	Returns the error description.
final String	getErrorCode()	Returns the error code.
static Saml2Error	internalValidationError(@Nullable String description)	Construct an Saml2ErrorCodes.INTERNAL_VALIDATION_ERROR error
static Saml2Error	invalidResponse(@Nullable String description)	Construct an Saml2ErrorCodes.INVALID_RESPONSE error
static Saml2Error	malformedResponseData(@Nullable String description)	Construct an Saml2ErrorCodes.MALFORMED_RESPONSE_DATA error
static Saml2Error	relyingPartyRegistrationNotFound(@Nullable String description)	Construct an Saml2ErrorCodes.RELYING_PARTY_REGISTRATION_NOT_FOUND error
static Saml2Error	subjectNotFound(@Nullable String description)	Construct an Saml2ErrorCodes.SUBJECT_NOT_FOUND error
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Saml2Error

public Saml2Error(String errorCode,
 @Nullable String description)

Constructs a Saml2Error using the provided parameters.

Parameters:

errorCode - the error code

description - the error description

Method Details

invalidResponse

public static Saml2Error invalidResponse(@Nullable String description)

Construct an Saml2ErrorCodes.INVALID_RESPONSE error

Parameters:

description - the error description

Returns:

the resulting Saml2Error

Since:

7.0

internalValidationError

public static Saml2Error internalValidationError(@Nullable String description)

Construct an Saml2ErrorCodes.INTERNAL_VALIDATION_ERROR error

Parameters:

description - the error description

Returns:

the resulting Saml2Error

Since:

7.0

malformedResponseData

public static Saml2Error malformedResponseData(@Nullable String description)

Construct an Saml2ErrorCodes.MALFORMED_RESPONSE_DATA error

Parameters:

description - the error description

Returns:

the resulting Saml2Error

Since:

7.0

decryptionError

public static Saml2Error decryptionError(@Nullable String description)

Construct an Saml2ErrorCodes.DECRYPTION_ERROR error

Parameters:

description - the error description

Returns:

the resulting Saml2Error

Since:

7.0

relyingPartyRegistrationNotFound

public static Saml2Error relyingPartyRegistrationNotFound(@Nullable String description)

Construct an Saml2ErrorCodes.RELYING_PARTY_REGISTRATION_NOT_FOUND error

Parameters:

description - the error description

Returns:

the resulting Saml2Error

Since:

7.0

subjectNotFound

public static Saml2Error subjectNotFound(@Nullable String description)

Construct an Saml2ErrorCodes.SUBJECT_NOT_FOUND error

Parameters:

description - the error description

Returns:

the resulting Saml2Error

Since:

7.0

getErrorCode

public final String getErrorCode()

Returns the error code.

Returns:

the error code

getDescription

public final @Nullable String getDescription()

Returns the error description.

Returns:

the error description

toString

public String toString()

Overrides:

toString in class Object