KickJava   Java API By Example, From Geeks To Geeks.

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


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  * LoginHandler.java
20  *
21  * This is the interface that processes the login request for a given user
22  * store.
23  */
24
25 // the package
26 package com.rift.coad.lib.security.login;
27
28 // coadunation imports
29 import com.rift.coad.lib.security.UserSession;
30
31
32 /**
33  * This is the interface that processes the login request for a given user
34  * store.
35  *
36  * @author Brett Chaldecott
37  */
38 public interface LoginHandler {
39     
40     /**
41      * This method returns a reference to the login manager the interface that
42      * this object was retrieved from.
43      *
44      * @return A reference to the login manager.
45      * @exception LoginException
46      */
47     public UserSession getUserInfo() throws LoginException;
48     
49     
50     /**
51      * This method preforms the login for a given user using the login
52      * information supplied to that user.
53      *
54      * @return TRUE if the login succeeded, FALSE if not.
55      * @param loginInfoHandler The handler containing the login information.
56      * @exception LoginException
57      */
58     public boolean login(LoginInfoHandler loginInfoHandler) throws LoginException;
59     
60     
61 }
62
Popular Tags