logoffaction.java

the musiccollection struts 1 application i netbeans implementation (strut for dummies book source)

package dummies.struts.music;

import java.io.IOException;

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

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.struts.action.Action;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;


/**
 * @author Mike Robinson
 *
 */
public final class LogoffAction extends Action
{
	
	Log log = LogFactory.getLog(LogoffAction.class);
	// --------------------------------------------------------- Public Methods

	/**
	 * handles the user request to log off
	 * @param mapping The ActionMapping used to select this instance
	 * @param actionForm 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 IOException if an input/output error occurs
	 * @exception ServletException if a servlet exception occurs
	 */
	public ActionForward execute(
		ActionMapping mapping,
		ActionForm form,
		HttpServletRequest request,
		HttpServletResponse response)
		throws IOException, ServletException
	{

		// Extract attributes we will need
		HttpSession session = request.getSession();
		UserDTO user = (UserDTO) session.getAttribute("user");

		// Process this user logoff

		if (user != null)
		{
			log.info("LogoffAction: User '" + user.getFirstName() + "' logged off in session " + session.getId());
		}
		else
		{
			log.info("LogoffActon: User logged off in session " + session.getId());
		}
		
		session.invalidate(); 
				
		// Forward control to the specified success URI
		return (mapping.findForward("success"));

	}

}