| org.springframework.web.servlet.view.AbstractView org.springframework.web.servlet.view.AbstractUrlBasedView org.springframework.web.servlet.view.RedirectView
RedirectView | public class RedirectView extends AbstractUrlBasedView (Code) | | View that redirects to an absolute, context relative, or current request
relative URL, exposing all model attributes as HTTP query parameters.
A URL for this view is supposed to be a HTTP redirect URL, i.e.
suitable for HttpServletResponse's sendRedirect method, which
is what actually does the redirect if the HTTP 1.0 flag is on, or via sending
back an HTTP 303 code - if the HTTP 1.0 compatibility flag is off.
Note that while the default value for the "contextRelative" flag is off,
you will probably want to almost always set it to true. With the flag off,
URLs starting with "/" are considered relative to the web server root, while
with the flag on, they are considered relative to the web application root.
Since most web apps will never know or care what their context path actually
is, they are much better off setting this flag to true, and submitting paths
which are to be considered relative to the web application root.
Note that in a Servlet 2.2 environment, i.e. a servlet container which
is only compliant to the limits of this spec, this class will probably fail
when feeding in URLs which are not fully absolute, or relative to the current
request (no leading "/"), as these are the only two types of URL that
sendRedirect supports in a Servlet 2.2 environment.
author: Rod Johnson author: Juergen Hoeller author: Colin Sampaleanu See Also: RedirectView.setContextRelative See Also: RedirectView.setHttp10Compatible See Also: javax.servlet.http.HttpServletResponse.sendRedirect |
Constructor Summary | |
public | RedirectView() Constructor for use as a bean. | public | RedirectView(String url) Create a new RedirectView with the given URL. | public | RedirectView(String url, boolean contextRelative) Create a new RedirectView with the given URL. | public | RedirectView(String url, boolean contextRelative, boolean http10Compatible) Create a new RedirectView with the given URL. |
Method Summary | |
protected void | appendQueryProperties(StringBuffer targetUrl, Map model, String encodingScheme) Append query properties to the redirect URL. | protected Map | queryProperties(Map model) Determine name-value pairs for query strings, which will be stringified,
URL-encoded and formatted by appendQueryProperties. | final protected void | renderMergedOutputModel(Map model, HttpServletRequest request, HttpServletResponse response) Convert model to request parameters and redirect to the given URL. | protected void | sendRedirect(HttpServletRequest request, HttpServletResponse response, String targetUrl, boolean http10Compatible) | public void | setContextRelative(boolean contextRelative) Set whether to interpret a given URL that starts with a slash ("/")
as relative to the current ServletContext, i.e. | public void | setEncodingScheme(String encodingScheme) Set the encoding scheme for this view. | public void | setHttp10Compatible(boolean http10Compatible) Set whether to stay compatible with HTTP 1.0 clients.
In the default implementation, this will enforce HTTP status code 302
in any case, i.e. | protected String | urlEncode(String input, String encodingScheme) URL-encode the given input String with the given encoding scheme. |
DEFAULT_ENCODING_SCHEME | final public static String DEFAULT_ENCODING_SCHEME(Code) | | The default encoding scheme: UTF-8
|
RedirectView | public RedirectView()(Code) | | Constructor for use as a bean.
|
RedirectView | public RedirectView(String url)(Code) | | Create a new RedirectView with the given URL.
The given URL will be considered as relative to the web server,
not as relative to the current ServletContext.
Parameters: url - the URL to redirect to See Also: RedirectView.RedirectView(String,boolean) |
RedirectView | public RedirectView(String url, boolean contextRelative)(Code) | | Create a new RedirectView with the given URL.
Parameters: url - the URL to redirect to Parameters: contextRelative - whether to interpret the given URL asrelative to the current ServletContext |
RedirectView | public RedirectView(String url, boolean contextRelative, boolean http10Compatible)(Code) | | Create a new RedirectView with the given URL.
Parameters: url - the URL to redirect to Parameters: contextRelative - whether to interpret the given URL asrelative to the current ServletContext Parameters: http10Compatible - whether to stay compatible with HTTP 1.0 clients |
appendQueryProperties | protected void appendQueryProperties(StringBuffer targetUrl, Map model, String encodingScheme) throws UnsupportedEncodingException(Code) | | Append query properties to the redirect URL.
Stringifies, URL-encodes and formats model attributes as query properties.
Parameters: targetUrl - the StringBuffer to append the properties to Parameters: model - Map that contains model attributes Parameters: encodingScheme - the encoding scheme to use throws: UnsupportedEncodingException - if string encoding failed See Also: RedirectView.queryProperties |
queryProperties | protected Map queryProperties(Map model)(Code) | | Determine name-value pairs for query strings, which will be stringified,
URL-encoded and formatted by appendQueryProperties.
This implementation returns all model elements as-is.
See Also: RedirectView.appendQueryProperties |
sendRedirect | protected void sendRedirect(HttpServletRequest request, HttpServletResponse response, String targetUrl, boolean http10Compatible) throws IOException(Code) | | Send a redirect back to the HTTP client
Parameters: request - current HTTP request (allows for reacting to request method) Parameters: response - current HTTP response (for sending response headers) Parameters: targetUrl - the target URL to redirect to Parameters: http10Compatible - whether to stay compatible with HTTP 1.0 clients throws: IOException - if thrown by response methods |
setContextRelative | public void setContextRelative(boolean contextRelative)(Code) | | Set whether to interpret a given URL that starts with a slash ("/")
as relative to the current ServletContext, i.e. as relative to the
web application root.
Default is "false": A URL that starts with a slash will be interpreted
as absolute, i.e. taken as-is. If true, the context path will be
prepended to the URL in such a case.
See Also: javax.servlet.http.HttpServletRequest.getContextPath |
setEncodingScheme | public void setEncodingScheme(String encodingScheme)(Code) | | Set the encoding scheme for this view. Default is UTF-8.
|
setHttp10Compatible | public void setHttp10Compatible(boolean http10Compatible)(Code) | | Set whether to stay compatible with HTTP 1.0 clients.
In the default implementation, this will enforce HTTP status code 302
in any case, i.e. delegate to HttpServletResponse.sendRedirect .
Turning this off will send HTTP status code 303, which is the correct
code for HTTP 1.1 clients, but not understood by HTTP 1.0 clients.
Many HTTP 1.1 clients treat 302 just like 303, not making any
difference. However, some clients depend on 303 when redirecting
after a POST request; turn this flag off in such a scenario.
See Also: javax.servlet.http.HttpServletResponse.sendRedirect |
Fields inherited from org.springframework.web.servlet.view.AbstractView | final public static String DEFAULT_CONTENT_TYPE(Code)(Java Doc)
|
|
|