Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base.action.util
Class RedirectAction

java.lang.Object
  extended by com.opensymphony.xwork.ActionSupport
      extended by com.jivesoftware.base.action.util.RedirectAction
All Implemented Interfaces:
UserAware, 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 RedirectAction
extends com.opensymphony.xwork.ActionSupport
implements UserAware

An action that handles redirects.

See Also:
Serialized Form

Field Summary
static java.lang.String REDIRECT_URL
           
 
Fields inherited from class com.opensymphony.xwork.ActionSupport
LOG
 
Fields inherited from interface com.opensymphony.xwork.Action
ERROR, INPUT, LOGIN, NONE, SUCCESS
 
Constructor Summary
RedirectAction()
           
 
Method Summary
 java.lang.String execute()
           
static int getNumPreviousURLs(javax.servlet.http.HttpServletRequest request)
           
static java.lang.String getPreviousURL(javax.servlet.http.HttpServletRequest request)
          Returns the URL of the last content page the user was on.
 java.lang.String getUrl()
           
 User getUser()
           
static void pushPreviousURL(javax.servlet.http.HttpServletRequest request)
          Updates the page the user is currently on - the value is stored in the session.
 void setUrl(java.lang.String url)
           
 void setUser(User user)
           
 
Methods inherited from class com.opensymphony.xwork.ActionSupport
addActionError, addActionMessage, addFieldError, clearErrorsAndMessages, clone, doDefault, doInput, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getLocale, getText, getText, 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
 

Field Detail

REDIRECT_URL

public static final java.lang.String REDIRECT_URL
See Also:
Constant Field Values
Constructor Detail

RedirectAction

public RedirectAction()
Method Detail

setUrl

public void setUrl(java.lang.String url)

getUrl

public java.lang.String getUrl()

getUser

public User getUser()

setUser

public void setUser(User user)
Specified by:
setUser in interface UserAware

execute

public java.lang.String execute()
                         throws java.lang.Exception
Specified by:
execute in interface com.opensymphony.xwork.Action
Overrides:
execute in class com.opensymphony.xwork.ActionSupport
Throws:
java.lang.Exception

getPreviousURL

public static java.lang.String getPreviousURL(javax.servlet.http.HttpServletRequest request)
Returns the URL of the last content page the user was on. A major page is one of the content pages like the forum or thread page. The URL that is returned will just be the name of the action, it's extension (.jspa usually) and the query string (if any). Example: Note, the application's context is not part of the URL (ie, "/jive3/").

Returns:
the URL of the last content page the user was on.

pushPreviousURL

public static void pushPreviousURL(javax.servlet.http.HttpServletRequest request)
Updates the page the user is currently on - the value is stored in the session.


getNumPreviousURLs

public static int getNumPreviousURLs(javax.servlet.http.HttpServletRequest request)

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.