Class ScramServerErrorException

  • All Implemented Interfaces:
    java.io.Serializable

    public class ScramServerErrorException
    extends ScramException
    This class specifies an error that occurred during authentication exchange in a server-final-message.

    It is sent by the server in its server-final-message and can help diagnose the reason for the authentication exchange failure.

    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private static long serialVersionUID  
      private java.lang.String serverError
      server-error-value.
    • Constructor Summary

      Constructors 
      Constructor Description
      ScramServerErrorException​(java.lang.String serverError)
      Constructs a new instance of ScramServerErrorException with a detailed message.
      ScramServerErrorException​(java.lang.String serverError, java.lang.Throwable ex)
      Constructs a new instance of ScramServerErrorException with a detailed message and a root cause.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getServerError()
      Return the "e=" server-error-value from the server-final-message.
      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • serverError

        private final java.lang.String serverError
        server-error-value.
    • Constructor Detail

      • ScramServerErrorException

        public ScramServerErrorException​(java.lang.String serverError)
        Constructs a new instance of ScramServerErrorException with a detailed message.
        Parameters:
        serverError - The SCRAM error in the message
      • ScramServerErrorException

        public ScramServerErrorException​(java.lang.String serverError,
                                         java.lang.Throwable ex)
        Constructs a new instance of ScramServerErrorException with a detailed message and a root cause.
        Parameters:
        serverError - The SCRAM error in the message
        ex - The root exception
    • Method Detail

      • getServerError

        public java.lang.String getServerError()
        Return the "e=" server-error-value from the server-final-message.
        Returns:
        the error type returned in the server-final-message