Module jakarta.security.auth.message
Package jakarta.security.auth.message

Class AuthException

java.lang.Object
java.lang.Throwable
java.lang.Exception
java.security.GeneralSecurityException
javax.security.auth.login.LoginException
jakarta.security.auth.message.AuthException
All Implemented Interfaces:
Serializable
public class AuthException extends LoginException
A generic authentication exception.
See Also:

  • Constructor Details

    • AuthException

      public AuthException()
      Constructs an AuthException with no detail message. A detail message is a String that describes this particular exception.

    • AuthException

      public AuthException(String msg)
      Constructs an AuthException with the specified detail message. A detail message is a String that describes this particular exception.
      Parameters:
      msg - The detail message.

    • AuthException

      public AuthException(String msg, Throwable cause)
      Constructs an AuthException with the specified detail message and cause.

      NOTE: Providing a cause could potentially disclose information about the security system to an outside party. Utter care should be taken that this is either not the case, or the exception is correctly handled to prevent this.

      Parameters:
      msg - The detail message.
      cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
      Since:
      3.0

    • AuthException

      public AuthException(Throwable cause)
      Constructs an AuthException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause). *

      NOTE: Providing a cause could potentially disclose information about the security system to an outside party. Utter care should be taken that this is either not the case, or the exception is correctly handled to prevent this.

      Parameters:
      cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
      Since:
      3.0