com.jivesoftware.base.action
Class LogoutAction

java.lang.Object
  com.opensymphony.xwork.ActionSupport
      com.jivesoftware.base.action.JiveActionSupport
          com.jivesoftware.base.action.LogoutAction

All Implemented Interfaces:

AuthTokenAware, UserAware, com.opensymphony.webwork.interceptor.ServletRequestAware, com.opensymphony.webwork.interceptor.ServletResponseAware, com.opensymphony.webwork.interceptor.SessionAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, com.uwyn.rife.continuations.ContinuableObject, java.io.Serializable, java.lang.Cloneable

public class LogoutAction
extends JiveActionSupport
implements com.opensymphony.webwork.interceptor.SessionAware

This class is an Action which encapsulates all the logic of a user logout.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.jivesoftware.base.action.JiveActionSupport

CANCEL, DISABLED, FATAL, NOTFOUND, pageUser, request, response, UNAUTHORIZED

Fields inherited from class com.opensymphony.xwork.ActionSupport

LOG

Fields inherited from interface com.opensymphony.xwork.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

LogoutAction()

Method Summary

java.lang.String	doInput() Used as a redirect after execute is called.
java.lang.String	execute() Logs out the user and returns the Action.SUCCESS view, or the Action.ERROR view if the page user wasn't logged in (double logout perhaps?)
AuthToken	getAuthToken()
User	getPageUser() Returns the current page user's User object, or null if the user is a guest.
void	setSession(java.util.Map session)

Methods inherited from class com.jivesoftware.base.action.JiveActionSupport

getGuestProperty, getJiveProperty, getLocales, getPageURL, getSession, getText, getText, getTimeZone, getTimeZones, isFailedLookup, isGuest, setAuthToken, setGuestProperty, setLoginAttributes, setPageUser, setServletRequest, setServletResponse, setUser

Methods inherited from class com.opensymphony.xwork.ActionSupport

addActionError, addActionMessage, addFieldError, clearErrorsAndMessages, clone, doDefault, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getLocale, getText, getText, getText, getText, getText, getText, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, pause, setActionErrors, setActionMessages, setFieldErrors, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

LogoutAction

public LogoutAction()

Method Detail

setSession

public void setSession(java.util.Map session)

Specified by:

setSession in interface com.opensymphony.webwork.interceptor.SessionAware

getPageUser

public User getPageUser()

Description copied from class: JiveActionSupport

Returns the current page user's User object, or null if the user is a guest.

This method has been declared abstract because subclasses will need to load the page user from a product-specific factory (ie, ForumFactory or KbFactory) in order to get the correct permissions set on it.

Specified by:

getPageUser in class JiveActionSupport

Returns:

the current page user's User object.

See Also:

User

getAuthToken

public AuthToken getAuthToken()

Overrides:

getAuthToken in class JiveActionSupport

execute

public java.lang.String execute()
                         throws java.lang.Exception

Logs out the user and returns the Action.SUCCESS view, or the Action.ERROR view if the page user wasn't logged in (double logout perhaps?)

Specified by:

execute in interface com.opensymphony.xwork.Action

Overrides:

execute in class JiveActionSupport

Throws:

java.lang.Exception

doInput

public java.lang.String doInput()
                         throws java.lang.Exception

Used as a redirect after execute is called. This provides a way for themes to work since the session and webwork context is reinitialized. Returns Action.SUCCESS view always.

Overrides:

doInput in class com.opensymphony.xwork.ActionSupport

Returns:

SUCCESS always.

Throws:

java.lang.Exception