Class UrlFilenameViewController
- 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
- org.springframework.web.servlet.mvc.UrlFilenameViewController
- All Implemented Interfaces:
Aware,ApplicationContextAware,ServletContextAware,Controller
public class UrlFilenameViewController extends AbstractUrlViewController
SimpleControllerimplementation that transforms the virtual path of a URL into a view name and returns that view.Can optionally prepend a
prefixand/or append asuffixto build the viewname from the URL filename.Find some examples below:
"/index" -> "index""/index.html" -> "index""/index.html"+ prefix"pre_"and suffix"_suf" -> "pre_index_suf""/products/view.html" -> "products/view"
Thanks to David Barri for suggesting prefix/suffix support!
- Author:
- Alef Arendsen, Juergen Hoeller, Rob Harrop
- See Also:
setPrefix(java.lang.String),setSuffix(java.lang.String)
Field Summary
Fields inherited from class org.springframework.web.servlet.support.WebContentGenerator
HEADER_CACHE_CONTROL, METHOD_GET, METHOD_HEAD, METHOD_POST
Fields inherited from class org.springframework.context.support.ApplicationObjectSupport
logger
Constructor Summary
Constructors Constructor Description UrlFilenameViewController()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected StringextractOperableUrl(HttpServletRequest request)Extract a URL path from the given request, suitable for view name extraction.protected StringextractViewNameFromUrlPath(String uri)Extract the URL filename from the given request URI.protected StringgetPrefix()Return the prefix to prepend to the request URL filename.protected StringgetSuffix()Return the suffix to append to the request URL filename.protected StringgetViewNameForRequest(HttpServletRequest request)Returns view name based on the URL filename, with prefix/suffix applied when appropriate.protected StringgetViewNameForUrlPath(String uri)Returns view name based on the URL filename, with prefix/suffix applied when appropriate.protected StringpostProcessViewName(String viewName)Build the full view name based on the given view name as indicated by the URL path.voidsetPrefix(String prefix)Set the prefix to prepend to the request URL filename to build a view name.voidsetSuffix(String suffix)Set the suffix to append to the request URL filename to build a view name.Methods inherited from class org.springframework.web.servlet.mvc.AbstractUrlViewController
getUrlPathHelper, handleRequestInternal, setAlwaysUseFullPath, setRemoveSemicolonContent, setUrlDecode, setUrlPathHelper
Methods inherited from class org.springframework.web.servlet.mvc.AbstractController
handleRequest, isSynchronizeOnSession, setSynchronizeOnSession
Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator
applyCacheControl, applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, checkRequest, getAllowHeader, getCacheControl, getCacheSeconds, getSupportedMethods, getVaryByRequestHeaders, isAlwaysMustRevalidate, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, prepareResponse, preventCaching, setAlwaysMustRevalidate, setCacheControl, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseCacheControlNoStore, setUseExpiresHeader, setVaryByRequestHeaders
Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport
getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext
Methods inherited from class org.springframework.context.support.ApplicationObjectSupport
getApplicationContext, getMessageSourceAccessor, initApplicationContext, obtainApplicationContext, requiredContextClass, setApplicationContext
Constructor Detail
UrlFilenameViewController
public UrlFilenameViewController()
Method Detail
setPrefix
public void setPrefix(@Nullable String prefix)
Set the prefix to prepend to the request URL filename to build a view name.
setSuffix
public void setSuffix(@Nullable String suffix)
Set the suffix to append to the request URL filename to build a view name.
getViewNameForRequest
protected String getViewNameForRequest(HttpServletRequest request)
Returns view name based on the URL filename, with prefix/suffix applied when appropriate.- Specified by:
getViewNameForRequestin classAbstractUrlViewController- Parameters:
request- current HTTP request- Returns:
- a view name for this request (never
null) - See Also:
extractViewNameFromUrlPath(java.lang.String),setPrefix(java.lang.String),setSuffix(java.lang.String)
extractOperableUrl
protected String extractOperableUrl(HttpServletRequest request)
Extract a URL path from the given request, suitable for view name extraction.- Parameters:
request- current HTTP request- Returns:
- the URL to use for view name extraction
getViewNameForUrlPath
protected String getViewNameForUrlPath(String uri)
Returns view name based on the URL filename, with prefix/suffix applied when appropriate.- Parameters:
uri- the request URI; for example"/index.html"- Returns:
- the extracted URI filename; for example
"index" - See Also:
extractViewNameFromUrlPath(java.lang.String),postProcessViewName(java.lang.String)
extractViewNameFromUrlPath
protected String extractViewNameFromUrlPath(String uri)
Extract the URL filename from the given request URI.- Parameters:
uri- the request URI; for example"/index.html"- Returns:
- the extracted URI filename; for example
"index"
postProcessViewName
protected String postProcessViewName(String viewName)
Build the full view name based on the given view name as indicated by the URL path.The default implementation simply applies prefix and suffix. This can be overridden, for example, to manipulate upper case / lower case, etc.
- Parameters:
viewName- the original view name, as indicated by the URL path- Returns:
- the full view name to use
- See Also:
getPrefix(),getSuffix()