Class ScramServerErrorException

All Implemented Interfaces:
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:
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:
    • serverError

      private final String serverError
      server-error-value.
  • Constructor Details

    • ScramServerErrorException

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

      public ScramServerErrorException(String serverError, 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 Details

    • getServerError

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