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: * LoginModule.java
20: *
21: * The login manager is responsible for suppling the login methods for the user
22: * store object. This is the object that will be responsible for retrieving user
23: * information, and validating user logons against the store.
24: */
25:
26: package com.rift.coad.lib.security.login;
27:
28: /**
29: * The login manager is responsible for suppling the login methods for the user
30: * store object. This is the object that will be responsible for retrieving user
31: * information, and validating user logons against the store.
32: *
33: * @author Brett Chaldecott
34: */
35: public interface LoginModule {
36: /**
37: * This method returns true if the login manager can handle the requested
38: * authentication type.
39: *
40: * @return TRUE if it can FALSE if not.
41: * @param type The type of auth to check.
42: */
43: public boolean handleAuthType(String type);
44:
45: /**
46: * This method returns the login handler for the given auth type.
47: *
48: * @return The login handler that can handle the given auth type.
49: * @param type The type of login.
50: * @exception LoginException
51: */
52: public LoginHandler getLoginHandler(String type)
53: throws LoginException;
54: }
|