logouttag.java

Jive 是一个系统工程

/**
 * $Header: /home/coolserv/.cvs/coolserv/jive/source/taglib/com/coolservlets/forum/tags/LogoutTag.java,v 1.3 2000/12/17 14:15:08 gnielsen Exp $
 * $Revision: 1.3 $
 * $Date: 2000/12/17 14:15:08 $
 *
 * Copyright (C) 2000 CoolServlets.com. All rights reserved.
 *
 * ===================================================================
 * The Apache Software License, Version 1.1
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by
 *        CoolServlets.com (http://www.coolservlets.com)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Jive" and "CoolServlets.com" must not be used to
 *    endorse or promote products derived from this software without
 *    prior written permission. For written permission, please
 *    contact [e-mail].
 *
 * 5. Products derived from this software may not be called "Jive",
 *    nor may "Jive" appear in their name, without prior written
 *    permission of CoolServlets.com.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL COOLSERVLETS.COM OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of CoolServlets.com. For more information
 * on CoolServlets.com, please see <http://www.coolservlets.com>.
 */

package com.coolservlets.forum.tags;

import javax.servlet.*;
import javax.servlet.jsp.*;
import javax.servlet.jsp.tagext.*;
import javax.servlet.http.*;
import com.coolservlets.forum.*;
import com.coolservlets.forum.tags.*;

/**
 * JSP Tag <b>logout</b>, logs out a Jive user and sets their Authorization
 * to an anonymous user.
 * <p>
 * The body of the tag is ignored.
 * <p>
 * JSP Tag Lib Descriptor
 * <p><pre>
 * &lt;name&gt;logout&lt;/name&gt;
 *   &lt;tagclass&gt;com.coolservlets.forum.tags.LogoutTag&lt;/tagclass&gt;
 *   &lt;bodycontent&gt;empty&lt;/bodycontent&gt;
 *   &lt;info&gt;Logout a user from Jive and sets their Authorization to an anonymous user.&lt;/info&gt;
 * </pre>
 *
 * @see JiveState
 *
 * @author Glenn Nielsen
 */
public class LogoutTag extends TagSupport
{

  /**
   * Logout a Jive user.
   * <p>
   * Ends the users session and saves their nextVisit Date to
   * user extended property lastVisit.
   *
   * @return EVAL_PAGE
   */
  public final int doEndTag() throws JspException
  {
    // Get the users JiveState information
    JiveState js = (JiveState)pageContext.getAttribute("jiveUserState",
                PageContext.SESSION_SCOPE);
    if( js == null )
      throw new JspException("Jive logout tag, could not find JiveState");

    // For a logged in user, set the Date of the next LastVisit
    js.setNextVisit(pageContext);

    js.saveLastVisit();
    Authorization auth = AuthorizationFactory.getAnonymousAuthorization();
    js.setAuthorization(auth);
    js.setLoggedIn(false);
    return EVAL_PAGE;
  }

}