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: * 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;
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 getAuthType();
44:
45: /**
46: * This method return the information required to perform the login.
47: *
48: * @return The map containing the authentication information.
49: * @exception LoginException
50: */
51: public Map getInfo() throws LoginException;
52:
53: }
|