Package org.springframework.security.saml2.core

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, String description)	Constructs a Saml2Error using the provided parameters.

Method Summary

Modifier and Type	Method	Description
final String	getDescription()	Returns the error description.
final String	getErrorCode()	Returns the error code.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Saml2Error

public Saml2Error(String errorCode,
 String description)

Constructs a Saml2Error using the provided parameters.

Parameters:

errorCode - the error code

description - the error description

Method Details

getErrorCode

public final String getErrorCode()

Returns the error code.

Returns:

the error code

getDescription

public final String getDescription()

Returns the error description.

Returns:

the error description

toString

public String toString()

Overrides:

toString in class Object