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.pam;
20
21 import org.apache.shiro.authc.AuthenticationException;
22
23
24 /**
25 * Exception thrown during the authentication process using
26 * {@link org.apache.shiro.authc.pam.FirstSuccessfulStrategy}, with
27 * <code>stopAfterFirstSuccess</code> set.
28 * This is a signal to short circuit the authentication from proceeding
29 * with subsequent {@link org.apache.shiro.realm.Realm Realm}s
30 * after a first successful authentication.
31 *
32 * @see org.apache.shiro.authc.pam.AuthenticationStrategy
33 * @see org.apache.shiro.authc.pam.FirstSuccessfulStrategy
34 * @since 1.4.1
35 */
36 public class ShortCircuitIterationException extends AuthenticationException {
37
38 /**
39 * Creates a new ShortCircuitIterationException.
40 */
41 public ShortCircuitIterationException() {
42 super();
43 }
44
45 /**
46 * Constructs a new ShortCircuitIterationException.
47 *
48 * @param message the reason for the exception
49 */
50 public ShortCircuitIterationException(String message) {
51 super(message);
52 }
53
54 /**
55 * Constructs a new ShortCircuitIterationException.
56 *
57 * @param cause the underlying Throwable that caused this exception to be thrown.
58 */
59 public ShortCircuitIterationException(Throwable cause) {
60 super(cause);
61 }
62
63 /**
64 * Constructs a new ShortCircuitIterationException.
65 *
66 * @param message the reason for the exception
67 * @param cause the underlying Throwable that caused this exception to be thrown.
68 */
69 public ShortCircuitIterationException(String message, Throwable cause) {
70 super(message, cause);
71 }
72 }