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

Class Saml2AuthenticationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.springframework.security.core.AuthenticationException

org.springframework.security.saml2.provider.service.authentication.Saml2AuthenticationException

All Implemented Interfaces:

Serializable

public class Saml2AuthenticationException
extends AuthenticationException

This exception is thrown for all SAML 2.0 related Authentication errors.

There are a number of scenarios where an error may occur, for example:

• The response or assertion request is missing or malformed
• Missing or invalid subject
• Missing or invalid signatures
• The time period validation for the assertion fails
• One of the assertion conditions was not met
• Decryption failed
• Unable to locate a subject identifier, commonly known as username

Since:

5.2

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Saml2AuthenticationException(Saml2Error error)	Constructs a Saml2AuthenticationException using the provided parameters.
Saml2AuthenticationException(Saml2Error error, String message)	Constructs a Saml2AuthenticationException using the provided parameters.
Saml2AuthenticationException(Saml2Error error, String message, Throwable cause)	Constructs a Saml2AuthenticationException using the provided parameters.
Saml2AuthenticationException(Saml2Error error, Throwable cause)	Constructs a Saml2AuthenticationException using the provided parameters.
Saml2AuthenticationException(Saml2Error error)	Deprecated. Use Saml2Error constructor instead
Saml2AuthenticationException(Saml2Error error, String message)	Deprecated. Use Saml2Error constructor instead
Saml2AuthenticationException(Saml2Error error, String message, Throwable cause)	Deprecated. Use Saml2Error constructor instead
Saml2AuthenticationException(Saml2Error error, Throwable cause)	Deprecated. Use Saml2Error constructor instead

Method Summary

Modifier and Type	Method	Description
Saml2Error	getError()	Deprecated. Use getSaml2Error() instead
Saml2Error	getSaml2Error()	Get the associated Saml2Error
String	toString()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Details

Saml2AuthenticationException

public Saml2AuthenticationException(Saml2Error error)

Constructs a Saml2AuthenticationException using the provided parameters.

Parameters:

error - the SAML 2.0 Error

Saml2AuthenticationException

public Saml2AuthenticationException(Saml2Error error,
 Throwable cause)

Constructs a Saml2AuthenticationException using the provided parameters.

Parameters:

error - the SAML 2.0 Error

cause - the root cause

Saml2AuthenticationException

public Saml2AuthenticationException(Saml2Error error,
 String message)

Constructs a Saml2AuthenticationException using the provided parameters.

Parameters:

error - the SAML 2.0 Error

message - the detail message

Saml2AuthenticationException

public Saml2AuthenticationException(Saml2Error error,
 String message,
 Throwable cause)

Constructs a Saml2AuthenticationException using the provided parameters.

Parameters:

error - the SAML 2.0 Error

message - the detail message

cause - the root cause

Saml2AuthenticationException

@Deprecated
public Saml2AuthenticationException(Saml2Error error)

Deprecated.

Use Saml2Error constructor instead

Constructs a Saml2AuthenticationException using the provided parameters.

Parameters:

error - the SAML 2.0 Error

Saml2AuthenticationException

@Deprecated
public Saml2AuthenticationException(Saml2Error error,
 Throwable cause)

Deprecated.

Use Saml2Error constructor instead

Constructs a Saml2AuthenticationException using the provided parameters.

Parameters:

error - the SAML 2.0 Error

cause - the root cause

Saml2AuthenticationException

@Deprecated
public Saml2AuthenticationException(Saml2Error error,
 String message)

Deprecated.

Use Saml2Error constructor instead

Constructs a Saml2AuthenticationException using the provided parameters.

Parameters:

error - the SAML 2.0 Error

message - the detail message

Saml2AuthenticationException

@Deprecated
public Saml2AuthenticationException(Saml2Error error,
 String message,
 Throwable cause)

Deprecated.

Use Saml2Error constructor instead

Constructs a Saml2AuthenticationException using the provided parameters.

Parameters:

error - the SAML 2.0 Error

message - the detail message

cause - the root cause

Method Details

getSaml2Error

public Saml2Error getSaml2Error()

Get the associated Saml2Error

Returns:

the associated Saml2Error

getError

@Deprecated
public Saml2Error getError()

Deprecated.

Use getSaml2Error() instead

Returns the SAML 2.0 Error.

Returns:

the Saml2Error

toString

public String toString()

Overrides:

toString in class Throwable