org.springframework.web.servlet.mvc: abstract public class: AbstractUrlViewController

org.springframework.web.servlet.mvc
abstract public class: AbstractUrlViewController [javadoc | source]

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

All Implemented Interfaces:
Controller, ServletContextAware, ApplicationContextAware

Direct Known Subclasses:
UrlFilenameViewController

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.

Also see:

setAlwaysUseFullPath

setUrlDecode

author: Juergen - Hoeller

since: 1.2.6 -

Fields inherited from org.springframework.web.servlet.support.WebContentGenerator:
METHOD_GET, METHOD_HEAD, METHOD_POST

Fields inherited from org.springframework.context.support.ApplicationObjectSupport:
logger

Method from org.springframework.web.servlet.mvc.AbstractUrlViewController Summary:
getUrlPathHelper, getViewNameForRequest, handleRequestInternal, setAlwaysUseFullPath, setUrlDecode, setUrlPathHelper

Methods from org.springframework.web.servlet.mvc.AbstractController:
handleRequest, handleRequestInternal, isSynchronizeOnSession, setSynchronizeOnSession

Methods from org.springframework.web.servlet.support.WebContentGenerator:
applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, getCacheSeconds, getSupportedMethods, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, preventCaching, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseCacheControlNoStore, setUseExpiresHeader

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.mvc.AbstractUrlViewController Detail:
protected UrlPathHelper getUrlPathHelper() { return this.urlPathHelper; } Return the UrlPathHelper to use for the resolution of lookup paths.
abstract protected String getViewNameForRequest(HttpServletRequest request) Return the name of the view to render for this request, based on the given lookup path. Called by #handleRequestInternal .
protected ModelAndView handleRequestInternal(HttpServletRequest request, HttpServletResponse response) { String lookupPath = getUrlPathHelper().getLookupPathForRequest(request); String viewName = getViewNameForRequest(request); if (logger.isDebugEnabled()) { logger.debug("Returning view name '" + viewName + "' for lookup path [" + lookupPath + "]"); } return new ModelAndView(viewName); } Retrieves the URL path to use for lookup and delegates to #getViewNameForRequest .
public void setAlwaysUseFullPath(boolean alwaysUseFullPath) { this.urlPathHelper.setAlwaysUseFullPath(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".
public void setUrlDecode(boolean urlDecode) { this.urlPathHelper.setUrlDecode(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).
public void setUrlPathHelper(UrlPathHelper urlPathHelper) { Assert.notNull(urlPathHelper, "UrlPathHelper must not be null"); this.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.

Method from org.springframework.web.servlet.mvc.AbstractUrlViewController Detail:

 protected UrlPathHelper getUrlPathHelper() {
		return this.urlPathHelper;
}

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

 abstract protected String getViewNameForRequest(HttpServletRequest request)Return the name of the view to render for this request, based on the
given lookup path. Called by #handleRequestInternal .

 protected ModelAndView handleRequestInternal(HttpServletRequest request,
    HttpServletResponse response) {
		String lookupPath = getUrlPathHelper().getLookupPathForRequest(request);
		String viewName = getViewNameForRequest(request);
		if (logger.isDebugEnabled()) {
			logger.debug("Returning view name '" + viewName + "' for lookup path [" + lookupPath + "]");
		}
		return new ModelAndView(viewName);
}

#getViewNameForRequest

 public  void setAlwaysUseFullPath(boolean alwaysUseFullPath) {
	                                         	 
		this.urlPathHelper.setAlwaysUseFullPath(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".

 public  void setUrlDecode(boolean urlDecode) {
		this.urlPathHelper.setUrlDecode(urlDecode);
}

undecoded

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

 public  void setUrlPathHelper(UrlPathHelper urlPathHelper) {
		Assert.notNull(urlPathHelper, "UrlPathHelper must not be null");
		this.urlPathHelper = urlPathHelper;
}

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