01: /*
02: * CoadunationLib: The coaduntion implementation library.
03: * Copyright (C) 2006 Rift IT Contracting
04: *
05: * This library is free software; you can redistribute it and/or
06: * modify it under the terms of the GNU Lesser General Public
07: * License as published by the Free Software Foundation; either
08: * version 2.1 of the License, or (at your option) any later version.
09: *
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: * This is the interface that processes the login request for a given user
33: * store.
34: *
35: * @author Brett Chaldecott
36: */
37: public interface LoginHandler {
38:
39: /**
40: * This method returns a reference to the login manager the interface that
41: * this object was retrieved from.
42: *
43: * @return A reference to the login manager.
44: * @exception LoginException
45: */
46: public UserSession getUserInfo() throws LoginException;
47:
48: /**
49: * This method preforms the login for a given user using the login
50: * information supplied to that user.
51: *
52: * @return TRUE if the login succeeded, FALSE if not.
53: * @param loginInfoHandler The handler containing the login information.
54: * @exception LoginException
55: */
56: public boolean login(LoginInfoHandler loginInfoHandler)
57: throws LoginException;
58:
59: }
|