Save This Page
Home » spring-framework-2.5.5-with-dependencies » org.springframework » web » servlet » view » [javadoc | source]
org.springframework.web.servlet.view
public class: UrlBasedViewResolver [javadoc | source]
java.lang.Object
   org.springframework.context.support.ApplicationObjectSupport
      org.springframework.web.context.support.WebApplicationObjectSupport
         org.springframework.web.servlet.view.AbstractCachingViewResolver
            org.springframework.web.servlet.view.UrlBasedViewResolver

All Implemented Interfaces:
    Ordered, ViewResolver, ServletContextAware, ApplicationContextAware

Direct Known Subclasses:
    AbstractTemplateViewResolver, VelocityViewResolver, FreeMarkerViewResolver, InternalResourceViewResolver, VelocityLayoutViewResolver, XsltViewResolver, JasperReportsViewResolver

Simple implementation of the org.springframework.web.servlet.ViewResolver interface, allowing for direct resolution of symbolic view names to URLs, without explicit mapping definition. This is useful if your symbolic names match the names of your view resources in a straightforward manner (i.e. the symbolic name is the unique part of the resource's filename), without the need for a dedicated mapping to be defined for each view.

Supports AbstractUrlBasedView subclasses like InternalResourceView , org.springframework.web.servlet.view.velocity.VelocityView and org.springframework.web.servlet.view.freemarker.FreeMarkerView . The view class for all views generated by this resolver can be specified via the "viewClass" property.

View names can either be resource URLs themselves, or get augmented by a specified prefix and/or suffix. Exporting an attribute that holds the RequestContext to all views is explicitly supported.

Example: prefix="/WEB-INF/jsp/", suffix=".jsp", viewname="test" -> "/WEB-INF/jsp/test.jsp"

As a special feature, redirect URLs can be specified via the "redirect:" prefix. E.g.: "redirect:myAction.do" will trigger a redirect to the given URL, rather than resolution as standard view name. This is typically used for redirecting to a controller URL after finishing a form workflow.

Furthermore, forward URLs can be specified via the "forward:" prefix. E.g.: "forward:myAction.do" will trigger a forward to the given URL, rather than resolution as standard view name. This is typically used for controller URLs; it is not supposed to be used for JSP URLs - use logical view names there.

Note: This class does not support localized resolution, i.e. resolving a symbolic view name to different resources depending on the current locale.

Note: When chaining ViewResolvers, a UrlBasedViewResolver always needs to be last, as it will attempt to resolve any view name, no matter whether the underlying resource actually exists.

Field Summary
public static final  String REDIRECT_URL_PREFIX    Prefix for special view names that specify a redirect URL (usually to a controller after a form has been submitted and processed). Such view names will not be resolved in the configured default way but rather be treated as special shortcut. 
public static final  String FORWARD_URL_PREFIX    Prefix for special view names that specify a forward URL (usually to a controller after a form has been submitted and processed). Such view names will not be resolved in the configured default way but rather be treated as special shortcut. 
Fields inherited from org.springframework.context.support.ApplicationObjectSupport:
logger
Method from org.springframework.web.servlet.view.UrlBasedViewResolver Summary:
buildView,   canHandle,   createView,   getAttributesMap,   getCacheKey,   getContentType,   getOrder,   getPrefix,   getRequestContextAttribute,   getSuffix,   getViewClass,   getViewNames,   initApplicationContext,   isRedirectContextRelative,   isRedirectHttp10Compatible,   loadView,   requiredViewClass,   setAttributes,   setAttributesMap,   setContentType,   setOrder,   setPrefix,   setRedirectContextRelative,   setRedirectHttp10Compatible,   setRequestContextAttribute,   setSuffix,   setViewClass,   setViewNames
Methods from org.springframework.web.servlet.view.AbstractCachingViewResolver:
clearCache,   createView,   getCacheKey,   isCache,   loadView,   removeFromCache,   resolveViewName,   setCache
Methods from org.springframework.web.context.support.WebApplicationObjectSupport:
getServletContext,   getTempDir,   getWebApplicationContext,   initApplicationContext,   initServletContext,   isContextRequired,   setServletContext
Methods from org.springframework.context.support.ApplicationObjectSupport:
getApplicationContext,   getMessageSourceAccessor,   initApplicationContext,   initApplicationContext,   isContextRequired,   requiredContextClass,   setApplicationContext
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.springframework.web.servlet.view.UrlBasedViewResolver Detail:
 protected AbstractUrlBasedView buildView(String viewName) throws Exception 
    Creates a new View instance of the specified view class and configures it. Does not perform any lookup for pre-defined View instances.

    Spring lifecycle methods as defined by the bean container do not have to be called here; those will be applied by the loadView method after this method returns.

    Subclasses will typically call super.buildView(viewName) first, before setting further properties themselves. loadView will then apply Spring lifecycle methods at the end of this process.

 protected boolean canHandle(String viewName,
    Locale locale) 
 protected View createView(String viewName,
    Locale locale) throws Exception 
    Overridden to implement check for "redirect:" prefix.

    Not possible in loadView, since overridden loadView versions in subclasses might rely on the superclass always creating instances of the required view class.

 public Map getAttributesMap() 
    Allow Map access to the static attributes for views returned by this resolver, with the option to add or override specific entries.

    Useful for specifying entries directly, for example via "attributesMap[myKey]". This is particularly useful for adding or overriding entries in child view definitions.

 protected Object getCacheKey(String viewName,
    Locale locale) 
    This implementation returns just the view name, as this ViewResolver doesn't support localized resolution.
 protected String getContentType() 
    Return the content type for all views, if any.
 public int getOrder() 
 protected String getPrefix() 
    Return the prefix that gets prepended to view names when building a URL.
 protected String getRequestContextAttribute() 
    Return the name of the RequestContext attribute for all views, if any.
 protected String getSuffix() 
    Return the suffix that gets appended to view names when building a URL.
 protected Class getViewClass() 
    Return the view class to be used to create views.
 protected String[] getViewNames() 
 protected  void initApplicationContext() 
 protected boolean isRedirectContextRelative() 
    Return whether to interpret a given redirect URL that starts with a slash ("/") as relative to the current ServletContext, i.e. as relative to the web application root.
 protected boolean isRedirectHttp10Compatible() 
    Return whether redirects should stay compatible with HTTP 1.0 clients.
 protected View loadView(String viewName,
    Locale locale) throws Exception 
    Delegates to buildView for creating a new instance of the specified view class, and applies the following Spring lifecycle methods (as supported by the generic Spring bean factory):
    • ApplicationContextAware's setApplicationContext
    • InitializingBean's afterPropertiesSet
 protected Class requiredViewClass() 
    Return the required type of view for this resolver. This implementation returns AbstractUrlBasedView.
 public  void setAttributes(Properties props) 
    Set static attributes from a java.util.Properties object, for all views returned by this resolver.

    This is the most convenient way to set static attributes. Note that static attributes can be overridden by dynamic attributes, if a value with the same name is included in the model.

    Can be populated with a String "value" (parsed via PropertiesEditor) or a "props" element in XML bean definitions.

 public  void setAttributesMap(Map attributes) 
    Set static attributes from a Map, for all views returned by this resolver. This allows to set any kind of attribute values, for example bean references.

    Can be populated with a "map" or "props" element in XML bean definitions.

 public  void setContentType(String contentType) 
    Set the content type for all views.

    May be ignored by view classes if the view itself is assumed to set the content type, e.g. in case of JSPs.

 public  void setOrder(int order) 
 public  void setPrefix(String prefix) 
    Set the prefix that gets prepended to view names when building a URL.
 public  void setRedirectContextRelative(boolean redirectContextRelative) 
    Set whether to interpret a given redirect URL that starts with a slash ("/") as relative to the current ServletContext, i.e. as relative to the web application root.

    Default is "true": A redirect URL that starts with a slash will be interpreted as relative to the web application root, i.e. the context path will be prepended to the URL.

    Redirect URLs can be specified via the "redirect:" prefix. E.g.: "redirect:myAction.do"

 public  void setRedirectHttp10Compatible(boolean redirectHttp10Compatible) 
    Set whether redirects should 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.

    Redirect URLs can be specified via the "redirect:" prefix. E.g.: "redirect:myAction.do"

 public  void setRequestContextAttribute(String requestContextAttribute) 
    Set the name of the RequestContext attribute for all views.
 public  void setSuffix(String suffix) 
    Set the suffix that gets appended to view names when building a URL.
 public  void setViewClass(Class viewClass) 
    Set the view class that should be used to create views.
 public  void setViewNames(String[] viewNames) 
    Set the view names (or name patterns) that can be handled by this org.springframework.web.servlet.ViewResolver . View names can contain simple wildcards such that 'my*', '*Report' and '*Repo*' will all match the view name 'myReport'.