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/**
025 * Exception thrown during the authentication process using
026 * {@link org.apache.shiro.authc.pam.FirstSuccessfulStrategy}, with 
027 * <code>stopAfterFirstSuccess</code> set.  
028 * This is a signal to short circuit the authentication from proceeding 
029 * with subsequent {@link org.apache.shiro.realm.Realm Realm}s 
030 * after a first successful authentication.
031 *
032 * @see org.apache.shiro.authc.pam.AuthenticationStrategy
033 * @see org.apache.shiro.authc.pam.FirstSuccessfulStrategy
034 * @since 1.4.1
035 */
036public class ShortCircuitIterationException extends AuthenticationException {
037
038    /**
039     * Creates a new ShortCircuitIterationException.
040     */
041    public ShortCircuitIterationException() {
042        super();
043    }
044
045    /**
046     * Constructs a new ShortCircuitIterationException.
047     *
048     * @param message the reason for the exception
049     */
050    public ShortCircuitIterationException(String message) {
051        super(message);
052    }
053
054    /**
055     * Constructs a new ShortCircuitIterationException.
056     *
057     * @param cause the underlying Throwable that caused this exception to be thrown.
058     */
059    public ShortCircuitIterationException(Throwable cause) {
060        super(cause);
061    }
062
063    /**
064     * Constructs a new ShortCircuitIterationException.
065     *
066     * @param message the reason for the exception
067     * @param cause   the underlying Throwable that caused this exception to be thrown.
068     */
069    public ShortCircuitIterationException(String message, Throwable cause) {
070        super(message, cause);
071    }
072}