01: /*
02: * Copyright (c) JForum Team
03: * All rights reserved.
04: *
05: * Redistribution and use in source and binary forms,
06: * with or without modification, are permitted provided
07: * that the following conditions are met:
08: *
09: * 1) Redistributions of source code must retain the above
10: * copyright notice, this list of conditions and the
11: * following disclaimer.
12: * 2) Redistributions in binary form must reproduce the
13: * above copyright notice, this list of conditions and
14: * the following disclaimer in the documentation and/or
15: * other materials provided with the distribution.
16: * 3) Neither the name of "Rafael Steil" nor
17: * the names of its contributors may be used to endorse
18: * or promote products derived from this software without
19: * specific prior written permission.
20: *
21: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
22: * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
23: * EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
24: * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25: * MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26: * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
27: * THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
28: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
29: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES
30: * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
32: * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33: * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
34: * IN CONTRACT, STRICT LIABILITY, OR TORT
35: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
36: * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
37: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
38: *
39: * Created on Aug 2, 2004 by pieter
40: *
41: * The JForum Project
42: * http://www.jforum.net
43: */
44: package net.jforum.sso;
45:
46: import java.util.Map;
47:
48: import net.jforum.dao.UserDAO;
49: import net.jforum.entities.User;
50:
51: /**
52: * Validates user's credentials.
53: * Implementations of this interface are supposed
54: * to check for access rights in some "shared" environment,
55: * like calling some external procedure, consulting a different
56: * users table, reading from a XML file etc.. It is <b>not</b> SSO,
57: * since it still will be JForum that will call the validate login
58: * methods.
59: * <br>
60: * If you want SSO, please check {@link net.jforum.sso.SSO}
61: * @author Rafael Steil
62: * @version $Id: LoginAuthenticator.java,v 1.7 2006/08/20 22:47:43 rafaelsteil Exp $
63: */
64: public interface LoginAuthenticator {
65: /**
66: * Authenticates an user.
67: *
68: * @param username Username
69: * @param password Password
70: * @param extraParams Extra parameters, if any.
71: * @return An instance of a {@link net.jforum.entities.User} or <code>null</code>
72: */
73: public User validateLogin(String username, String password,
74: Map extraParams);
75:
76: /**
77: * Sets the user model for the instance.
78: *
79: * @param dao UserDAOThe user model to set
80: */
81: public void setUserModel(UserDAO dao);
82: }
|