View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *     http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.shiro.authc;
20  
21  /**
22   * A special kind of <tt>DisabledAccountException</tt>, this exception is thrown when attempting
23   * to authenticate and the corresponding account has been disabled explicitly due to being locked.
24   *
25   * <p>For example, an account can be locked if an administrator explicitly locks an account or
26   * perhaps an account can be locked automatically by the system if too many unsuccessful
27   * authentication attempts take place during a specific period of time (perhaps indicating a
28   * hacking attempt).
29   *
30   * @since 0.1
31   */
32  public class LockedAccountException extends DisabledAccountException {
33  
34      /**
35       * Creates a new LockedAccountException.
36       */
37      public LockedAccountException() {
38          super();
39      }
40  
41      /**
42       * Constructs a new LockedAccountException.
43       *
44       * @param message the reason for the exception
45       */
46      public LockedAccountException(String message) {
47          super(message);
48      }
49  
50      /**
51       * Constructs a new LockedAccountException.
52       *
53       * @param cause the underlying Throwable that caused this exception to be thrown.
54       */
55      public LockedAccountException(Throwable cause) {
56          super(cause);
57      }
58  
59      /**
60       * Constructs a new LockedAccountException.
61       *
62       * @param message the reason for the exception
63       * @param cause   the underlying Throwable that caused this exception to be thrown.
64       */
65      public LockedAccountException(String message, Throwable cause) {
66          super(message, cause);
67      }
68  
69  }