J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 1998-2003 Sun Microsystems, Inc. All Rights Reserved. |
| 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | * |
| 5 | * This code is free software; you can redistribute it and/or modify it |
| 6 | * under the terms of the GNU General Public License version 2 only, as |
| 7 | * published by the Free Software Foundation. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * by Sun in the LICENSE file that accompanied this code. |
| 10 | * |
| 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| 15 | * accompanied this code). |
| 16 | * |
| 17 | * You should have received a copy of the GNU General Public License version |
| 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 20 | * |
| 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| 23 | * have any questions. |
| 24 | */ |
| 25 | |
| 26 | package javax.security.auth.login; |
| 27 | |
| 28 | /** |
| 29 | * Signals that a <code>Credential</code> has expired. |
| 30 | * |
| 31 | * <p> This exception is thrown by LoginModules when they determine |
| 32 | * that a <code>Credential</code> has expired. |
| 33 | * For example, a <code>LoginModule</code> authenticating a user |
| 34 | * in its <code>login</code> method may determine that the user's |
| 35 | * password, although entered correctly, has expired. In this case |
| 36 | * the <code>LoginModule</code> throws this exception to notify |
| 37 | * the application. The application can then take the appropriate |
| 38 | * steps to assist the user in updating the password. |
| 39 | * |
| 40 | */ |
| 41 | public class CredentialExpiredException extends CredentialException { |
| 42 | |
| 43 | private static final long serialVersionUID = -5344739593859737937L; |
| 44 | |
| 45 | /** |
| 46 | * Constructs a CredentialExpiredException with no detail message. A detail |
| 47 | * message is a String that describes this particular exception. |
| 48 | */ |
| 49 | public CredentialExpiredException() { |
| 50 | super(); |
| 51 | } |
| 52 | |
| 53 | /** |
| 54 | * Constructs a CredentialExpiredException with the specified detail |
| 55 | * message. A detail message is a String that describes this particular |
| 56 | * exception. |
| 57 | * |
| 58 | * <p> |
| 59 | * |
| 60 | * @param msg the detail message. |
| 61 | */ |
| 62 | public CredentialExpiredException(String msg) { |
| 63 | super(msg); |
| 64 | } |
| 65 | } |