KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > columba > ristretto > auth > AuthenticationMechanism


1 /* ***** BEGIN LICENSE BLOCK *****
2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
3  *
4  * The contents of this file are subject to the Mozilla Public License Version
5  * 1.1 (the "License"); you may not use this file except in compliance with
6  * the License. You may obtain a copy of the License at
7  * http://www.mozilla.org/MPL/
8  *
9  * Software distributed under the License is distributed on an "AS IS" basis,
10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11  * for the specific language governing rights and limitations under the
12  * License.
13  *
14  * The Original Code is Ristretto Mail API.
15  *
16  * The Initial Developers of the Original Code are
17  * Timo Stich and Frederik Dietz.
18  * Portions created by the Initial Developers are Copyright (C) 2004
19  * All Rights Reserved.
20  *
21  * Contributor(s):
22  *
23  * Alternatively, the contents of this file may be used under the terms of
24  * either the GNU General Public License Version 2 or later (the "GPL"), or
25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
26  * in which case the provisions of the GPL or the LGPL are applicable instead
27  * of those above. If you wish to allow use of your version of this file only
28  * under the terms of either the GPL or the LGPL, and not to allow others to
29  * use your version of this file under the terms of the MPL, indicate your
30  * decision by deleting the provisions above and replace them with the notice
31  * and other provisions required by the GPL or the LGPL. If you do not delete
32  * the provisions above, a recipient may use your version of this file under
33  * the terms of any one of the MPL, the GPL or the LGPL.
34  *
35  * ***** END LICENSE BLOCK ***** */
36 package org.columba.ristretto.auth;
37
38 import java.io.IOException JavaDoc;
39
40 /**
41  * Interface for the implementation of
42  * a SASL mechanism.
43  * <br>
44  * <b>RFC(s)</b> 2222
45 *
46  * @author Timo Stich <tstich@users.sourceforge.net>
47  */
48 public interface AuthenticationMechanism {
49     
50     /**
51      * Authenticates the client at the AuthenticationServer.
52      * If the authentication fails a AuthenticationException
53      * is thrown.
54      *
55      * @param server the AuthenticationServer to connect with
56      * @param user the username
57      * @param password the password
58      * @throws IOException
59      * @throws AuthenticationException
60      */
61     public void authenticate(AuthenticationServer server, String JavaDoc user, char[] password)
62                 throws IOException JavaDoc, AuthenticationException;
63 }
64
Popular Tags