/*
 * $Header: /cvsroot/mvnforum/mvnforum/src/com/mvnforum/auth/Authenticator.java,v 1.3 2005/01/18 11:52:15 minhnn Exp $
 * $Author: minhnn $
 * $Revision: 1.3 $
 * $Date: 2005/01/18 11:52:15 $
 *
 * ====================================================================
 *
 * Copyright (C) 2002-2005 by MyVietnam.net
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or any later version.
 *
 * All copyright notices regarding mvnForum MUST remain intact
 * in the scripts and in the outputted HTML.
 * The "powered by" text/logo with a link back to
 * http://www.mvnForum.com and http://www.MyVietnam.net in the
 * footer of the pages MUST remain visible when the pages
 * are viewed on the internet or intranet.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 * Support can be obtained from support forums at:
 * http://www.mvnForum.com/mvnforum/index
 *
 * Correspondence and Marketing Questions can be sent to:
 * info@MyVietnam.net
 *
 * @author: Minh Nguyen  minhnn@MyVietnam.net
 * @author: Mai  Nguyen  mai.nh@MyVietnam.net
 */
package com.mvnforum.auth;

import javax.servlet.http.HttpServletRequest;

/**
 * #@todo Expand guide about the overall authentication process
 * If the user is authenticated, then the memberID equals 0
 * See ForumUserServlet#process : uncomment the comment code for the hint
 */
public interface Authenticator {

    /**
     * This method will be called by mvnForum's authentication system
     *   to authenticate the customized user
     * With this generic interface, developer could integrate their own
     *   authentication to the mvnForum system
     * NOTE: The user should already be in the Member table of mvnForum database
     *       Developer could use this implementation strategy if the user's
     *       information is in other place (such as LDAP):
     *       - Check if user is login
     *       - If no, then return null
     *       - If yes, check if user is in the mvnForum's mvnforumMember
     *          - If yes, return the username
     *          - If no, create the user
     * If you are successful, shareing your knowledge and experience to other
     * members of mvnForum community is highly appreciated
     *
     * @see OnlineUserManager#setAuthenticator(Authenticator)
     * @param request the servlet request
     * @return the username of the current user associated with this request
     *         If no user has been authenticated in this request, then null should be return
     */
    public String getRemoteUser(HttpServletRequest request);
}