|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.struts2.dispatcher.StrutsResultSupport
org.apache.struts2.dispatcher.ServletRedirectResult
public class ServletRedirectResult
Calls the sendRedirect
method to the location specified. The response is told to redirect the
browser to the specified location (a new request from the client). The
consequence of doing this means that the action (action instance, action
errors, field errors, etc) that was just executed is lost and no longer
available. This is because actions are built on a single-thread model. The
only way to pass data is through the session or with web parameters
(url?name=value) which can be OGNL expressions.
This result follows the same rules from StrutsResultSupport
.
<result name="success" type="redirect"> <param name="location">foo.jsp</param> <param name="parse">false</param> <param name="anchor">FRAGMENT</param> </result>
Field Summary | |
---|---|
protected ActionMapper |
actionMapper
|
protected java.lang.String |
anchor
|
protected boolean |
prependServletContext
|
protected java.util.Map<java.lang.String,java.lang.String> |
requestParameters
|
protected int |
statusCode
|
protected boolean |
supressEmptyParameters
|
Fields inherited from class org.apache.struts2.dispatcher.StrutsResultSupport |
---|
DEFAULT_PARAM |
Fields inherited from interface org.apache.struts2.StrutsStatics |
---|
HTTP_REQUEST, HTTP_RESPONSE, PAGE_CONTEXT, SERVLET_CONTEXT, SERVLET_DISPATCHER, STRUTS_ACTION_TAG_INVOCATION, STRUTS_PORTLET_CONTEXT |
Constructor Summary | |
---|---|
ServletRedirectResult()
|
|
ServletRedirectResult(java.lang.String location)
|
|
ServletRedirectResult(java.lang.String location,
java.lang.String anchor)
|
Method Summary | |
---|---|
ServletRedirectResult |
addParameter(java.lang.String key,
java.lang.Object value)
Adds a request parameter to be added to the redirect url |
protected void |
doExecute(java.lang.String finalLocation,
ActionInvocation invocation)
Redirects to the location specified by calling HttpServletResponse.sendRedirect(String) . |
void |
execute(ActionInvocation invocation)
Implementation of the execute method from the Result interface. |
protected java.util.List<java.lang.String> |
getProhibitedResultParams()
|
void |
handle(ReflectionException ex)
|
protected void |
sendRedirect(javax.servlet.http.HttpServletResponse response,
java.lang.String finalLocation)
Sends the redirection. |
void |
setActionMapper(ActionMapper mapper)
|
void |
setAnchor(java.lang.String anchor)
Set the optional anchor value. |
void |
setPrependServletContext(boolean prependServletContext)
Sets whether or not to prepend the servlet context path to the redirected URL. |
void |
setStatusCode(int code)
|
void |
setSupressEmptyParameters(boolean supressEmptyParameters)
Sets the supressEmptyParameters option |
Methods inherited from class org.apache.struts2.dispatcher.StrutsResultSupport |
---|
conditionalParse, getLastFinalLocation, getLocation, setEncode, setLocation, setParse |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected boolean prependServletContext
protected ActionMapper actionMapper
protected int statusCode
protected boolean supressEmptyParameters
protected java.util.Map<java.lang.String,java.lang.String> requestParameters
protected java.lang.String anchor
Constructor Detail |
---|
public ServletRedirectResult()
public ServletRedirectResult(java.lang.String location)
public ServletRedirectResult(java.lang.String location, java.lang.String anchor)
Method Detail |
---|
public void setActionMapper(ActionMapper mapper)
public void setStatusCode(int code)
public void setAnchor(java.lang.String anchor)
anchor
- public void setPrependServletContext(boolean prependServletContext)
prependServletContext
- true to prepend the location with the servlet context path,
false otherwise.public void execute(ActionInvocation invocation) throws java.lang.Exception
StrutsResultSupport
StrutsResultSupport.doExecute(String, ActionInvocation)
after optionally evaluating the
location as an OGNL evaluation.
execute
in interface Result
execute
in class StrutsResultSupport
invocation
- the execution state of the action.
java.lang.Exception
- if an error occurs while executing the result.protected void doExecute(java.lang.String finalLocation, ActionInvocation invocation) throws java.lang.Exception
HttpServletResponse.sendRedirect(String)
.
doExecute
in class StrutsResultSupport
finalLocation
- the location to redirect to.invocation
- an encapsulation of the action execution state.
java.lang.Exception
- if an error occurs when redirecting.protected java.util.List<java.lang.String> getProhibitedResultParams()
protected void sendRedirect(javax.servlet.http.HttpServletResponse response, java.lang.String finalLocation) throws java.io.IOException
response
- The responsefinalLocation
- The location URI
java.io.IOException
public void setSupressEmptyParameters(boolean supressEmptyParameters)
supressEmptyParameters
- The new value for this optionpublic ServletRedirectResult addParameter(java.lang.String key, java.lang.Object value)
key
- The parameter namevalue
- The parameter valuepublic void handle(ReflectionException ex)
handle
in interface ReflectionExceptionHandler
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |