jakarta.security.auth.message.AuthException Maven / Gradle / Ivy
/*
* Copyright (c) 2021, 2021 Contributors to Eclipse Foundation. All rights reserved.
* Copyright (c) 1997, 2020 Oracle and/or its affiliates and others.
* All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.security.auth.message;
import javax.security.auth.login.LoginException;
/**
* A generic authentication exception.
*
*/
public class AuthException extends LoginException {
private static final long serialVersionUID = -1156951780670243758L;
/**
* Constructs an AuthException with no detail message. A detail message is a String that describes this particular
* exception.
*/
public AuthException() {
}
/**
* Constructs an AuthException with the specified detail message. A detail message is a String that describes this
* particular exception.
*
* @param msg The detail message.
*/
public AuthException(String msg) {
super(msg);
}
/**
* 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.
*
* @param msg The detail message.
* @param cause the cause (which is saved for later retrieval by the {@link #getCause()} method). (A {@code null} value
* is permitted, and indicates that the cause is nonexistent or unknown.)
* @since 3.0
*/
public AuthException(String msg, Throwable cause) {
super(msg);
initCause(cause);
}
/**
* Constructs an AuthException with the specified cause and a detail message of
* {@code (cause==null ? null : cause.toString())} (which typically contains the class and detail message of
* {@code 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.
*
* @param cause the cause (which is saved for later retrieval by the {@link #getCause()} method). (A {@code null} value
* is permitted, and indicates that the cause is nonexistent or unknown.)
* @since 3.0
*/
public AuthException(Throwable cause) {
initCause(cause);
}
}