/*
 * $Header: /cvsroot/mvnforum/mvnforum/src/com/mvnforum/actions/LogoutAction.java,v 1.3 2004/06/03 04:49:29 drjavanomous Exp $
 * $Author: drjavanomous $
 * $Revision: 1.3 $
 * $Date: 2004/06/03 04:49:29 $
 *
 * ====================================================================
 *
 * Copyright (C) 2002-2004 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: Aaron Roberts
 */
package com.mvnforum.actions;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.struts.action.*;
import org.apache.struts.action.Action;
import com.mvnforum.auth.OnlineUserManager;

/**
 * Implementation of <strong>Action</strong> that displays the index page
 *
 * @author Aaron Roberts
 * @version $Revision: 1.3 $ $Date: 2004/06/03 04:49:29 $
 */

public final class LogoutAction extends Action
{

    private static final String ORIGINAL_REQUEST = "mvnforum.user.OriginalRequest";

    /**
     * Process the specified HTTP request, and create the corresponding HTTP
     * response (or forward to another web component that will create it).
     * Return an <code>ActionForward</code> instance describing where and how
     * control should be forwarded, or <code>null</code> if the response has
     * already been completed.
     *
     * @param mapping The ActionMapping used to select this instance
     * @param form The optional ActionForm bean for this request (if any)
     * @param request The HTTP request we are processing
     * @param response The HTTP response we are creating
     *
     * @exception Exception if business logic throws an exception
     */
    public ActionForward execute(ActionMapping mapping,
                                 ActionForm form,
                                 HttpServletRequest request,
                                 HttpServletResponse response) throws Exception {

        OnlineUserManager onlineUserManager = OnlineUserManager.getInstance();
        onlineUserManager.logout(request, response);
        request.setAttribute("Reason", "Logout successfully.");

        // Send us to the main index page
        return (mapping.findForward("loggedout"));

    }

}