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;
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 * @since 0.1
033 */
034public class IncorrectCredentialsException extends CredentialsException {
035
036    /**
037     * Creates a new IncorrectCredentialsException.
038     */
039    public IncorrectCredentialsException() {
040        super();
041    }
042
043    /**
044     * Constructs a new IncorrectCredentialsException.
045     *
046     * @param message the reason for the exception
047     */
048    public IncorrectCredentialsException(String message) {
049        super(message);
050    }
051
052    /**
053     * Constructs a new IncorrectCredentialsException.
054     *
055     * @param cause the underlying Throwable that caused this exception to be thrown.
056     */
057    public IncorrectCredentialsException(Throwable cause) {
058        super(cause);
059    }
060
061    /**
062     * Constructs a new IncorrectCredentialsException.
063     *
064     * @param message the reason for the exception
065     * @param cause   the underlying Throwable that caused this exception to be thrown.
066     */
067    public IncorrectCredentialsException(String message, Throwable cause) {
068        super(message, cause);
069    }
070
071}