< prev index next >

src/java.base/share/classes/javax/security/auth/login/CredentialExpiredException.java

Print this page




  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.security.auth.login;
  27 
  28 /**
  29  * Signals that a {@code Credential} has expired.
  30  *
  31  * <p> This exception is thrown by LoginModules when they determine
  32  * that a {@code Credential} has expired.
  33  * For example, a {@code LoginModule} authenticating a user
  34  * in its {@code login} method may determine that the user's
  35  * password, although entered correctly, has expired.  In this case
  36  * the {@code LoginModule} 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      * @param msg the detail message.
  59      */


  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.security.auth.login;
  27 
  28 /**
  29  * Signals that a {@code Credential} has expired.
  30  *
  31  * <p> This exception is thrown by LoginModules when they determine
  32  * that a {@code Credential} has expired.
  33  * For example, a {@code LoginModule} authenticating a user
  34  * in its {@code login} method may determine that the user's
  35  * password, although entered correctly, has expired.  In this case
  36  * the {@code LoginModule} 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  * @since 1.4
  41  */
  42 public class CredentialExpiredException extends CredentialException {
  43 
  44     private static final long serialVersionUID = -5344739593859737937L;
  45 
  46     /**
  47      * Constructs a CredentialExpiredException with no detail message. A detail
  48      * message is a String that describes this particular exception.
  49      */
  50     public CredentialExpiredException() {
  51         super();
  52     }
  53 
  54     /**
  55      * Constructs a CredentialExpiredException with the specified detail
  56      * message.  A detail message is a String that describes this particular
  57      * exception.
  58      *
  59      * @param msg the detail message.
  60      */
< prev index next >