public abstract class

AbstractUrlViewController

extends AbstractController
java.lang.Object
   ↳ org.springframework.context.support.ApplicationObjectSupport
     ↳ org.springframework.web.context.support.WebApplicationObjectSupport
       ↳ org.springframework.web.servlet.support.WebContentGenerator
         ↳ org.springframework.web.servlet.mvc.AbstractController
           ↳ org.springframework.web.servlet.mvc.AbstractUrlViewController
Known Direct Subclasses

Class Overview

Abstract base class for Controllers that return a view name based on the request URL.

Provides infrastructure for determining view names from URLs and configurable URL lookup. For information on the latter, see alwaysUseFullPath and urlDecode properties.

See Also

Summary

[Expand]
Inherited Constants
From class org.springframework.web.servlet.support.WebContentGenerator
[Expand]
Inherited Fields
From class org.springframework.context.support.ApplicationObjectSupport
Public Constructors
AbstractUrlViewController()
Public Methods
void setAlwaysUseFullPath(boolean alwaysUseFullPath)
Set if URL lookup should always use full path within current servlet context.
void setUrlDecode(boolean urlDecode)
Set if context path and request URI should be URL-decoded.
void setUrlPathHelper(UrlPathHelper urlPathHelper)
Set the UrlPathHelper to use for the resolution of lookup paths.
Protected Methods
UrlPathHelper getUrlPathHelper()
Return the UrlPathHelper to use for the resolution of lookup paths.
abstract String getViewNameForRequest(HttpServletRequest request)
Return the name of the view to render for this request, based on the given lookup path.
ModelAndView handleRequestInternal(HttpServletRequest request, HttpServletResponse response)
Retrieves the URL path to use for lookup and delegates to getViewNameForRequest(HttpServletRequest).
[Expand]
Inherited Methods
From class org.springframework.web.servlet.mvc.AbstractController
From class org.springframework.web.servlet.support.WebContentGenerator
From class org.springframework.web.context.support.WebApplicationObjectSupport
From class org.springframework.context.support.ApplicationObjectSupport
From class java.lang.Object
From interface org.springframework.context.ApplicationContextAware
From interface org.springframework.web.context.ServletContextAware
From interface org.springframework.web.servlet.mvc.Controller

Public Constructors

public AbstractUrlViewController ()

Public Methods

public void setAlwaysUseFullPath (boolean alwaysUseFullPath)

Set if URL lookup should always use full path within current servlet context. Else, the path within the current servlet mapping is used if applicable (i.e. in the case of a ".../*" servlet mapping in web.xml). Default is "false".

See Also

public void setUrlDecode (boolean urlDecode)

Set if context path and request URI should be URL-decoded. Both are returned undecoded by the Servlet API, in contrast to the servlet path.

Uses either the request encoding or the default encoding according to the Servlet spec (ISO-8859-1).

See Also

public void setUrlPathHelper (UrlPathHelper urlPathHelper)

Set the UrlPathHelper to use for the resolution of lookup paths.

Use this to override the default UrlPathHelper with a custom subclass, or to share common UrlPathHelper settings across multiple MethodNameResolvers and HandlerMappings.

See Also

Protected Methods

protected UrlPathHelper getUrlPathHelper ()

Return the UrlPathHelper to use for the resolution of lookup paths.

protected abstract String getViewNameForRequest (HttpServletRequest request)

Return the name of the view to render for this request, based on the given lookup path. Called by handleRequestInternal(HttpServletRequest, HttpServletResponse).

Parameters
request current HTTP request
Returns
  • a view name for this request (never null)
See Also

protected ModelAndView handleRequestInternal (HttpServletRequest request, HttpServletResponse response)

Retrieves the URL path to use for lookup and delegates to getViewNameForRequest(HttpServletRequest).