|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.opensymphony.xwork.ActionSupport
com.jivesoftware.base.action.JiveActionSupport
com.jivesoftware.base.action.LogoutAction
public class LogoutAction
This class is an Action which encapsulates all the logic of a user logout.
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 |
---|
public LogoutAction()
Method Detail |
---|
public void setSession(java.util.Map session)
setSession
in interface com.opensymphony.webwork.interceptor.SessionAware
public User getPageUser()
JiveActionSupport
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.
getPageUser
in class JiveActionSupport
User
public AuthToken getAuthToken()
getAuthToken
in class JiveActionSupport
public java.lang.String execute() throws java.lang.Exception
Action.SUCCESS
view, or
the Action.ERROR
view if the page user wasn't logged in
(double logout perhaps?)
execute
in interface com.opensymphony.xwork.Action
execute
in class JiveActionSupport
java.lang.Exception
public java.lang.String doInput() throws java.lang.Exception
Action.SUCCESS
view always.
doInput
in class com.opensymphony.xwork.ActionSupport
java.lang.Exception
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |