Package org.springframework.security.saml2.core

Class Saml2Error

  • All Implemented Interfaces:
    java.io.Serializable
    public class Saml2Error
extends java.lang.Object
implements java.io.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​(java.lang.String errorCode, java.lang.String description)
      Constructs a Saml2Error using the provided parameters.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      Returns the error description.
      java.lang.String getErrorCode()
      Returns the error code.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • Saml2Error

        public Saml2Error​(java.lang.String errorCode,
                  java.lang.String description)
        Constructs a Saml2Error using the provided parameters.
        Parameters:
        errorCode - the error code
        description - the error description

    • Method Detail

      • getErrorCode

        public final java.lang.String getErrorCode()
        Returns the error code.
        Returns:
        the error code

      • getDescription

        public final java.lang.String getDescription()
        Returns the error description.
        Returns:
        the error description

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object