authenticationexception.java

java 开发的邮件服务器平台。支持以下协议。 协议可以修改为自己的专门标识

/***********************************************************************
 * Copyright (c) 2000-2004 The Apache Software Foundation.             *
 * All rights reserved.                                                *
 * ------------------------------------------------------------------- *
 * Licensed under the Apache License, Version 2.0 (the "License"); you *
 * may not use this file except in compliance with the License. You    *
 * may obtain a copy of the License at:                                *
 *                                                                     *
 *     http://www.apache.org/licenses/LICENSE-2.0                      *
 *                                                                     *
 * Unless required by applicable law or agreed to in writing, software *
 * distributed under the License is distributed on an "AS IS" BASIS,   *
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or     *
 * implied.  See the License for the specific language governing       *
 * permissions and limitations under the License.                      *
 ***********************************************************************/

package org.apache.james.imapserver;

/**
 * Thrown when a user fails to authenticate either because their identity is
 * not recognised or because their credentials are wrong.
 *
 * @version 0.1 on 14 Dec 2000
 */
public class AuthenticationException 
    extends Exception {

    private boolean userNotKnown;
    private boolean badCredentials;

    /**
     * Construct a new <code>AuthenticationException</code> instance.
     *
     * @param message The detail message for this exception (mandatory).
     */
    public AuthenticationException( final String message, 
                                    final boolean unknownUser,
                                    final boolean credentialsFailed ) {
        super(message);
        this.userNotKnown = unknownUser;
        this.badCredentials = credentialsFailed;
    }

    public boolean isUserNotKnown() {
        return userNotKnown;
    }

    public boolean isBadCredentials() {
        return badCredentials;
    }
}