KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > james > imapserver > AuthenticationException


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

17
18 package org.apache.james.imapserver;
19
20 /**
21  * Thrown when a user fails to authenticate either because their identity is
22  * not recognised or because their credentials are wrong.
23  *
24  * @version 0.1 on 14 Dec 2000
25  */

26 public class AuthenticationException
27     extends Exception JavaDoc {
28
29     private boolean userNotKnown;
30     private boolean badCredentials;
31
32     /**
33      * Construct a new <code>AuthenticationException</code> instance.
34      *
35      * @param message The detail message for this exception (mandatory).
36      */

37     public AuthenticationException( final String JavaDoc message,
38                                     final boolean unknownUser,
39                                     final boolean credentialsFailed ) {
40         super(message);
41         this.userNotKnown = unknownUser;
42         this.badCredentials = credentialsFailed;
43     }
44
45     public boolean isUserNotKnown() {
46         return userNotKnown;
47     }
48
49     public boolean isBadCredentials() {
50         return badCredentials;
51     }
52 }
53
Popular Tags