/*
 * Copyright (c) 1998, 2015, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package javax.security.auth.login;

Signals that a Credential has expired.

This exception is thrown by LoginModules when they determine that a Credential has expired. For example, a LoginModule authenticating a user in its login method may determine that the user's password, although entered correctly, has expired. In this case the LoginModule throws this exception to notify the application. The application can then take the appropriate steps to assist the user in updating the password.

Since:1.4
/** * Signals that a {@code Credential} has expired. * * <p> This exception is thrown by LoginModules when they determine * that a {@code Credential} has expired. * For example, a {@code LoginModule} authenticating a user * in its {@code login} method may determine that the user's * password, although entered correctly, has expired. In this case * the {@code LoginModule} throws this exception to notify * the application. The application can then take the appropriate * steps to assist the user in updating the password. * * @since 1.4 */
public class CredentialExpiredException extends CredentialException { private static final long serialVersionUID = -5344739593859737937L;
Constructs a CredentialExpiredException with no detail message. A detail message is a String that describes this particular exception.
/** * Constructs a CredentialExpiredException with no detail message. A detail * message is a String that describes this particular exception. */
public CredentialExpiredException() { super(); }
Constructs a CredentialExpiredException with the specified detail message. A detail message is a String that describes this particular exception.
Params:
  • msg – the detail message.
/** * Constructs a CredentialExpiredException with the specified detail * message. A detail message is a String that describes this particular * exception. * * @param msg the detail message. */
public CredentialExpiredException(String msg) { super(msg); } }