org.tigris.scarab.actions
Class Logout

java.lang.Object
  org.apache.turbine.modules.Module
      org.apache.turbine.modules.Action
          org.apache.turbine.modules.ActionEvent
              org.apache.turbine.modules.actions.TemplateAction
                  org.apache.turbine.TemplateAction
                      org.tigris.scarab.actions.base.ScarabTemplateAction
                          org.tigris.scarab.actions.Logout

public class Logout

extends ScarabTemplateAction

This class is responsible for Logging a user out of the system.

Version:

$Id: Logout.java 9472 2005-03-16 00:35:52Z dabbous $

Author:

Jon S. Stevens, Daniel Rall

Field Summary

Fields inherited from class org.tigris.scarab.actions.base.ScarabTemplateAction

DEFAULT_MSG, EMAIL_ERROR, ERROR_MESSAGE, NO_PERMISSION_MESSAGE

Fields inherited from class org.apache.turbine.modules.ActionEvent

BUTTON, BUTTON_LENGTH, LENGTH, METHOD_NAME_LENGTH, METHOD_NAME_PREFIX

Constructor Summary

Logout()

Method Summary

void	doLogout(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context) Logs out the currently logged-in user.
void	doPerform(org.apache.turbine.RunData data, org.apache.turbine.TemplateContext context)

Methods inherited from class org.tigris.scarab.actions.base.ScarabTemplateAction

doCancel, doDone, doGonext, doGotoothertemplate, doRefresh, doRefreshresultsperpage, doReset, doSave, getBackTemplate, getBackTemplate, getCancelTemplate, getCancelTemplate, getCurrentTemplate, getCurrentTemplate, getIntakeTool, getLastTemplate, getLocalizationTool, getNextTemplate, getNextTemplate, getOtherTemplate, getScarabRequestTool, log

Methods inherited from class org.apache.turbine.modules.actions.TemplateAction

doPerform, executeEvents

Methods inherited from class org.apache.turbine.modules.ActionEvent

execute, formatString, perform

Methods inherited from class org.apache.turbine.modules.Module

build, doBuild, doBuildTemplate, doBuildTemplate, evaluate, getPullService, getTemplateContext, getTemplateService, getTool, handleRequest, handleRequest, requestFinished, setTarget, setTemplate, templateExists

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Logout

public Logout()

Method Detail

doLogout

public void doLogout(org.apache.turbine.RunData data,
                     org.apache.turbine.TemplateContext context)
              throws java.lang.Exception

Logs out the currently logged-in user. Only sets the confirmation message if there was a user previously logged in.

Throws:

java.lang.Exception

doPerform

public void doPerform(org.apache.turbine.RunData data,
                      org.apache.turbine.TemplateContext context)
               throws java.lang.Exception

Throws:

java.lang.Exception

See Also:

doLogout(RunData, TemplateContext)