Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ExpiredCredentialsException |
|
| 1.0;1 |
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 | * Thrown during the authentication process when the system determines the submitted credential(s) | |
23 | * has expired and will not allow login. | |
24 | * | |
25 | * <p>This is most often used to alert a user that their credentials (e.g. password or | |
26 | * cryptography key) has expired and they should change the value. In such systems, the component | |
27 | * invoking the authentication might catch this exception and redirect the user to an appropriate | |
28 | * view to allow them to update their password or other credentials mechanism. | |
29 | * | |
30 | * @since 0.1 | |
31 | */ | |
32 | public class ExpiredCredentialsException extends CredentialsException { | |
33 | ||
34 | /** | |
35 | * Creates a new ExpiredCredentialsException. | |
36 | */ | |
37 | public ExpiredCredentialsException() { | |
38 | 1 | super(); |
39 | 1 | } |
40 | ||
41 | /** | |
42 | * Constructs a new ExpiredCredentialsException. | |
43 | * | |
44 | * @param message the reason for the exception | |
45 | */ | |
46 | public ExpiredCredentialsException(String message) { | |
47 | 1 | super(message); |
48 | 1 | } |
49 | ||
50 | /** | |
51 | * Constructs a new ExpiredCredentialsException. | |
52 | * | |
53 | * @param cause the underlying Throwable that caused this exception to be thrown. | |
54 | */ | |
55 | public ExpiredCredentialsException(Throwable cause) { | |
56 | 1 | super(cause); |
57 | 1 | } |
58 | ||
59 | /** | |
60 | * Constructs a new ExpiredCredentialsException. | |
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 ExpiredCredentialsException(String message, Throwable cause) { | |
66 | 1 | super(message, cause); |
67 | 1 | } |
68 | } |