001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.shiro.authc.pam;
020
021import org.apache.shiro.authc.AuthenticationException;
022
023/**
024 * Exception thrown during the authentication process using
025 * {@link org.apache.shiro.authc.pam.FirstSuccessfulStrategy}, with
026 * <code>stopAfterFirstSuccess</code> set.
027 * This is a signal to short circuit the authentication from proceeding
028 * with subsequent {@link org.apache.shiro.realm.Realm Realm}s
029 * after a first successful authentication.
030 *
031 * @see org.apache.shiro.authc.pam.AuthenticationStrategy
032 * @see org.apache.shiro.authc.pam.FirstSuccessfulStrategy
033 * @since 1.4.1
034 */
035public class ShortCircuitIterationException extends AuthenticationException {
036
037    /**
038     * Creates a new ShortCircuitIterationException.
039     */
040    public ShortCircuitIterationException() {
041        super();
042    }
043
044    /**
045     * Constructs a new ShortCircuitIterationException.
046     *
047     * @param message the reason for the exception
048     */
049    public ShortCircuitIterationException(String message) {
050        super(message);
051    }
052
053    /**
054     * Constructs a new ShortCircuitIterationException.
055     *
056     * @param cause the underlying Throwable that caused this exception to be thrown.
057     */
058    public ShortCircuitIterationException(Throwable cause) {
059        super(cause);
060    }
061
062    /**
063     * Constructs a new ShortCircuitIterationException.
064     *
065     * @param message the reason for the exception
066     * @param cause   the underlying Throwable that caused this exception to be thrown.
067     */
068    public ShortCircuitIterationException(String message, Throwable cause) {
069        super(message, cause);
070    }
071}