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     */
019    package org.apache.shiro.authc;
020    
021    /**
022     * Thrown when attempting to authenticate with credential(s) that do not match the actual
023     * credentials associated with the account principal.
024     *
025     * <p>For example, this exception might be thrown if a user's password is &quot;secret&quot; and
026     * &quot;secrets&quot; was entered by mistake.
027     *
028     * <p>Whether or not an application wishes to let
029     * the user know if they entered incorrect credentials is at the discretion of those
030     * responsible for defining the view and what happens when this exception occurs.
031     *
032     * @author Les Hazlewood
033     * @since 0.1
034     */
035    public class IncorrectCredentialsException extends CredentialsException {
036    
037        /**
038         * Creates a new IncorrectCredentialsException.
039         */
040        public IncorrectCredentialsException() {
041            super();
042        }
043    
044        /**
045         * Constructs a new IncorrectCredentialsException.
046         *
047         * @param message the reason for the exception
048         */
049        public IncorrectCredentialsException(String message) {
050            super(message);
051        }
052    
053        /**
054         * Constructs a new IncorrectCredentialsException.
055         *
056         * @param cause the underlying Throwable that caused this exception to be thrown.
057         */
058        public IncorrectCredentialsException(Throwable cause) {
059            super(cause);
060        }
061    
062        /**
063         * Constructs a new IncorrectCredentialsException.
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 IncorrectCredentialsException(String message, Throwable cause) {
069            super(message, cause);
070        }
071    
072    }