Package org.conical.common.bbl.web.struts.actions

Class LogoutAction

java.lang.Object
com.opensymphony.xwork2.ActionSupport
org.conical.common.bbl.web.struts.actions.LogoutAction
All Implemented Interfaces:
com.opensymphony.xwork2.Action, com.opensymphony.xwork2.interceptor.ValidationAware, com.opensymphony.xwork2.LocaleProvider, com.opensymphony.xwork2.TextProvider, com.opensymphony.xwork2.Validateable, Serializable, org.apache.struts2.interceptor.ServletResponseAware
public class LogoutAction extends com.opensymphony.xwork2.ActionSupport implements org.apache.struts2.interceptor.ServletResponseAware
Logs user out of the application by invalidating the entire session
Author:
rdoherty
See Also:

  • Field Summary

    Fields inherited from class com.opensymphony.xwork2.ActionSupport

    container

    Fields inherited from interface com.opensymphony.xwork2.Action

    ERROR, INPUT, LOGIN, NONE, SUCCESS

  • Constructor Summary

    Constructors
    Constructor
    Description
    LogoutAction()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    execute()
    Logs user out of the application by invalidating the entire session
    protected List<javax.servlet.http.Cookie>
    getAdditionalCookies()
    Returns additional cookies to send to user agent upon logout.
    void
    setServletResponse(javax.servlet.http.HttpServletResponse response)
     

    Methods inherited from class com.opensymphony.xwork2.ActionSupport

    addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, getActionErrors, getActionMessages, getContainer, getFieldErrors, getFormatted, getLocale, getLocaleProvider, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTextProvider, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, validate

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • LogoutAction

      public LogoutAction()

  • Method Details

    • execute

      public String execute() throws Exception
      Logs user out of the application by invalidating the entire session
      Specified by:
      execute in interface com.opensymphony.xwork2.Action
      Overrides:
      execute in class com.opensymphony.xwork2.ActionSupport
      Returns:
      success
      Throws:
      Exception

    • getAdditionalCookies

      protected List<javax.servlet.http.Cookie> getAdditionalCookies()
      Returns additional cookies to send to user agent upon logout. Default is to return an empty list; can be overridden to return a custom cookie list.
      Returns:
      list of custom cookies to return upon logout

    • setServletResponse

      public void setServletResponse(javax.servlet.http.HttpServletResponse response)
      Specified by:
      setServletResponse in interface org.apache.struts2.interceptor.ServletResponseAware