Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| The Spring Framework
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.springframework.web.servlet.view
Class RedirectView

    java.lang.Object
      org.springframework.context.support.ApplicationObjectSupport
          org.springframework.web.context.support.WebApplicationObjectSupport
              org.springframework.web.servlet.view.AbstractView
                  org.springframework.web.servlet.view.AbstractUrlBasedView
                      org.springframework.web.servlet.view.RedirectView

All Implemented Interfaces:
  BeanNameAware, InitializingBean, ApplicationContextAware, ServletContextAware, View

    public class RedirectView

extends AbstractUrlBasedView

View that redirects to an absolute, context relative, or current request relative URL, by default 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 applications 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, Juergen Hoeller, Colin Sampaleanu, Sam Brannen
See Also:
  `setContextRelative(boolean)`, `setHttp10Compatible(boolean)`, `setExposeModelAttributes(boolean)`, `HttpServletResponse.sendRedirect(java.lang.String)`

Field Summary
`static String` | `DEFAULT_ENCODING_SCHEME` The default encoding scheme: UTF-8

Fields inherited from class org.springframework.web.servlet.view.AbstractView
`DEFAULT_CONTENT_TYPE`

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport
`logger`

Constructor Summary
`RedirectView()` Constructor for use as a bean.
`RedirectView(String url)` Create a new RedirectView with the given URL.
`RedirectView(String url, boolean contextRelative)` Create a new RedirectView with the given URL.
`RedirectView(String url, boolean contextRelative, boolean http10Compatible)` Create a new RedirectView with the given URL.
`RedirectView(String url, boolean contextRelative, boolean http10Compatible, boolean exposeModelAttributes)` 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(java.lang.StringBuffer, java.util.Map, java.lang.String)`.
`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)` Send a redirect back to the HTTP client
`void` | `setContextRelative(boolean contextRelative)` 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.
`void` | `setEncodingScheme(String encodingScheme)` Set the encoding scheme for this view.
`void` | `setExposeModelAttributes(boolean exposeModelAttributes)` Set the `exposeModelAttributes` flag which denotes whether or not model attributes should be exposed as HTTP query parameters.
`void` | `setHttp10Compatible(boolean http10Compatible)` Set whether to stay compatible with HTTP 1.0 clients.
`protected String` | `urlEncode(String input, String encodingScheme)` URL-encode the given input String with the given encoding scheme.

Methods inherited from class org.springframework.web.servlet.view.AbstractUrlBasedView
`afterPropertiesSet, getUrl, setUrl, toString`

Methods inherited from class org.springframework.web.servlet.view.AbstractView
`addStaticAttribute, createRequestContext, exposeModelAsRequestAttributes, getAttributesMap, getBeanName, getContentType, getRequestContextAttribute, getStaticAttributes, render, setAttributes, setAttributesCSV, setAttributesMap, setBeanName, setContentType, setRequestContextAttribute`

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport
`getServletContext, getTempDir, getWebApplicationContext, isContextRequired, setServletContext`

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport
`getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

### DEFAULT_ENCODING_SCHEME

    public static final String DEFAULT_ENCODING_SCHEME

  The default encoding scheme: UTF-8

  See Also:
    Constant Field Values

Constructor Detail

### RedirectView

    public RedirectView()

  Constructor for use as a bean.

### RedirectView

    public RedirectView(String url)

  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(String, boolean)`

### RedirectView

    public RedirectView(String url,
                        boolean contextRelative)

  Create a new RedirectView with the given URL.

  Parameters:
    `url` - the URL to redirect to
    `contextRelative` - whether to interpret the given URL as relative to the current ServletContext

### RedirectView

    public RedirectView(String url,
                        boolean contextRelative,
                        boolean http10Compatible)

  Create a new RedirectView with the given URL.

  Parameters:
    `url` - the URL to redirect to
    `contextRelative` - whether to interpret the given URL as relative to the current ServletContext
    `http10Compatible` - whether to stay compatible with HTTP 1.0 clients

### RedirectView

    public RedirectView(String url,
                        boolean contextRelative,
                        boolean http10Compatible,
                        boolean exposeModelAttributes)

  Create a new RedirectView with the given URL.

  Parameters:
    `url` - the URL to redirect to
    `contextRelative` - whether to interpret the given URL as relative to the current ServletContext
    `http10Compatible` - whether to stay compatible with HTTP 1.0 clients
    `exposeModelAttributes` - whether or not model attributes should be exposed as query parameters

Method Detail

### setContextRelative

    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. 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:
    `HttpServletRequest.getContextPath()`

### setHttp10Compatible

    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. 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:
    `HttpServletResponse.sendRedirect(java.lang.String)`

### setExposeModelAttributes

    public void setExposeModelAttributes(boolean exposeModelAttributes)

  Set the `exposeModelAttributes` flag which denotes whether or not model attributes should be exposed as HTTP query parameters.

  Defaults to `true`.

### setEncodingScheme

    public void setEncodingScheme(String encodingScheme)

  Set the encoding scheme for this view. Default is UTF-8.

### renderMergedOutputModel

    protected final void renderMergedOutputModel(Map model,
                                                 HttpServletRequest request,
                                                 HttpServletResponse response)
                                          throws IOException

  Convert model to request parameters and redirect to the given URL.

  Specified by:
    `renderMergedOutputModel` in class `AbstractView`
  Parameters:
    `model` - combined output Map (never `null`), with dynamic values taking precedence over static attributes
    `request` - current HTTP request
    `response` - current HTTP response
  Throws:
    `IOException`
  See Also:
    `appendQueryProperties(java.lang.StringBuffer, java.util.Map, java.lang.String)`, `sendRedirect(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String, boolean)`

### appendQueryProperties

    protected void appendQueryProperties(StringBuffer targetUrl,
                                         Map model,
                                         String encodingScheme)
                                  throws UnsupportedEncodingException

  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
    `model` - Map that contains model attributes
    `encodingScheme` - the encoding scheme to use
  Throws:
    `UnsupportedEncodingException` - if string encoding failed
  See Also:
    `queryProperties(java.util.Map)`

### queryProperties

    protected Map queryProperties(Map model)

  Determine name-value pairs for query strings, which will be stringified, URL-encoded and formatted by `appendQueryProperties(java.lang.StringBuffer, java.util.Map, java.lang.String)`.

  This implementation returns all model elements as-is.

  Parameters:
    `model` - the original model Map
  Returns:
    the filtered Map of eligible query properties

### urlEncode

    protected String urlEncode(String input,
                               String encodingScheme)
                        throws UnsupportedEncodingException

  URL-encode the given input String with the given encoding scheme.

  Default implementation uses `URLEncoder.encode(input, enc)` on JDK 1.4+, falling back to `URLEncoder.encode(input)` (which uses the platform default encoding) on JDK 1.3.

  Parameters:
    `input` - the unencoded input String
    `encodingScheme` - the encoding scheme
  Returns:
    the encoded output String
  Throws:
    `UnsupportedEncodingException` - if thrown by the JDK URLEncoder
  See Also:
    `URLEncoder.encode(String, String)`, `URLEncoder.encode(String)`

### sendRedirect

    protected void sendRedirect(HttpServletRequest request,
                                HttpServletResponse response,
                                String targetUrl,
                                boolean http10Compatible)
                         throws IOException

  Send a redirect back to the HTTP client

  Parameters:
    `request` - current HTTP request (allows for reacting to request method)
    `response` - current HTTP response (for sending response headers)
    `targetUrl` - the target URL to redirect to
    `http10Compatible` - whether to stay compatible with HTTP 1.0 clients
  Throws:
    `IOException` - if thrown by response methods

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| The Spring Framework
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2002-2007 The Spring Framework.