KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > rift > coad > lib > security > login > LoginInfoHandler


1 /*
2  * CoadunationLib: The coaduntion implementation library.
3  * Copyright (C) 2006 Rift IT Contracting
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18  *
19  * LoginInfoHandler.java
20  *
21  * This interface will be responsible for suppling the login handler with the
22  * information required to perform the login.
23  */
24
25 package com.rift.coad.lib.security.login;
26
27 // the java imports
28 import java.util.Map JavaDoc;
29
30 /**
31  * This interface will be responsible for suppling the login handler with the
32  * information required to perform the login.
33  *
34  * @author Brett Chaldecott
35  */
36 public interface LoginInfoHandler {
37     
38     /**
39      * This method returns the authentication type required.
40      *
41      * @return The string containing the authentication type.
42      */
43     public String JavaDoc getAuthType();
44     
45     
46     /**
47      * This method return the information required to perform the login.
48      *
49      * @return The map containing the authentication information.
50      * @exception LoginException
51      */
52     public Map JavaDoc getInfo() throws LoginException;
53     
54 }
55
Popular Tags