Class WebContentInterceptor
- All Implemented Interfaces:
Aware
,ApplicationContextAware
,ServletContextAware
,HandlerInterceptor
Cache settings may be configured for specific URLs via path pattern with
addCacheMapping(CacheControl, String...)
and
setCacheMappings(Properties)
, along with a fallback on default
settings for all URLs via WebContentGenerator.setCacheControl(CacheControl)
.
Pattern matching can be done with PathMatcher
or with parsed
PathPattern
s. The syntax is largely the same with the latter being
more tailored for web usage and more efficient. The choice depends on the
presence of a resolved
String
lookupPath or a parsed
RequestPath
which in turn depends on the
HandlerMapping
that matched the current request.
All the settings supported by this interceptor can also be set on
AbstractController
. This interceptor is mainly intended for applying
checks and preparations to a set of controllers mapped by a HandlerMapping.
- Since:
- 27.11.2003
- Author:
- Juergen Hoeller, Brian Clozel, Rossen Stoyanchev
- See Also:
-
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
ConstructorDescriptionDefault constructor withPathPatternParser.defaultInstance
.Constructor with aPathPatternParser
to parse patterns with. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addCacheMapping
(CacheControl cacheControl, String... paths) Map specific URL paths to a specificCacheControl
.void
afterCompletion
(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) This implementation is empty.protected CacheControl
lookupCacheControl
(String lookupPath) Find aCacheControl
instance for the given String lookupPath.protected CacheControl
Find aCacheControl
instance for the given parsedpath
.protected Integer
lookupCacheSeconds
(String lookupPath) Find a cacheSeconds instance for the given String lookupPath.protected Integer
Find a cacheSeconds value for the given parsedpath
.void
postHandle
(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) This implementation is empty.boolean
preHandle
(HttpServletRequest request, HttpServletResponse response, Object handler) Interception point before the execution of a handler.void
setAlwaysUseFullPath
(boolean alwaysUseFullPath) Deprecated.void
setCacheMappings
(Properties cacheMappings) Map settings for cache seconds to specific URL paths via patterns.void
setPathMatcher
(PathMatcher pathMatcher) Configure the PathMatcher to use to match URL paths against registered URL patterns to select the cache settings for a request.void
setUrlDecode
(boolean urlDecode) Deprecated.as of 5.3, the path is resolved externally and obtained withServletRequestPathUtils.getCachedPathValue(ServletRequest)
void
setUrlPathHelper
(UrlPathHelper urlPathHelper) Deprecated.as of 5.3, the path is resolved externally and obtained withServletRequestPathUtils.getCachedPathValue(ServletRequest)
Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator
applyCacheControl, applyCacheSeconds, checkAndPrepare, checkRequest, getAllowHeader, getCacheControl, getCacheSeconds, getSupportedMethods, getVaryByRequestHeaders, isRequireSession, prepareResponse, setCacheControl, setCacheSeconds, setRequireSession, setSupportedMethods, 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 Details
-
WebContentInterceptor
public WebContentInterceptor()Default constructor withPathPatternParser.defaultInstance
. -
WebContentInterceptor
Constructor with aPathPatternParser
to parse patterns with.- Since:
- 5.3
-
-
Method Details
-
setAlwaysUseFullPath
Deprecated.as of 5.3, the path is resolved externally and obtained withServletRequestPathUtils.getCachedPathValue(ServletRequest)
Shortcut to thesame property
on the configuredUrlPathHelper
. -
setUrlDecode
Deprecated.as of 5.3, the path is resolved externally and obtained withServletRequestPathUtils.getCachedPathValue(ServletRequest)
Shortcut to thesame property
on the configuredUrlPathHelper
. -
setUrlPathHelper
Deprecated.as of 5.3, the path is resolved externally and obtained withServletRequestPathUtils.getCachedPathValue(ServletRequest)
Set the UrlPathHelper to use for resolution of lookup paths. -
setPathMatcher
Configure the PathMatcher to use to match URL paths against registered URL patterns to select the cache settings for a request.This is an advanced property that should be used only when a customized
AntPathMatcher
or a custom PathMatcher is required.By default this is
AntPathMatcher
.Note: Setting
PathMatcher
enforces use of String pattern matching even when aparsed
RequestPath
is available. -
setCacheMappings
Map settings for cache seconds to specific URL paths via patterns.Overrides the default cache seconds setting of this interceptor. Can specify "-1" to exclude a URL path from default caching.
For pattern syntax see
AntPathMatcher
andPathPattern
as well as the class-level Javadoc for details for when each is used. The syntax is largely the same withPathPattern
more tailored for web usage.NOTE: Path patterns are not supposed to overlap. If a request matches several mappings, it is effectively undefined which one will apply (due to the lack of key ordering in
java.util.Properties
).- Parameters:
cacheMappings
- a mapping between URL paths (as keys) and cache seconds (as values, need to be integer-parsable)- See Also:
-
addCacheMapping
Map specific URL paths to a specificCacheControl
.Overrides the default cache seconds setting of this interceptor. Can specify an empty
CacheControl
instance to exclude a URL path from default caching.For pattern syntax see
AntPathMatcher
andPathPattern
as well as the class-level Javadoc for details for when each is used. The syntax is largely the same withPathPattern
more tailored for web usage.NOTE: Path patterns are not supposed to overlap. If a request matches several mappings, it is effectively undefined which one will apply (due to the lack of key ordering in the underlying
java.util.HashMap
).- Parameters:
cacheControl
- theCacheControl
to usepaths
- the URL paths that will map to the givenCacheControl
- Since:
- 4.2
- See Also:
-
preHandle
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws ServletException Description copied from interface:HandlerInterceptor
Interception point before the execution of a handler. Called after HandlerMapping determined an appropriate handler object, but before HandlerAdapter invokes the handler.DispatcherServlet processes a handler in an execution chain, consisting of any number of interceptors, with the handler itself at the end. With this method, each interceptor can decide to abort the execution chain, typically sending an HTTP error or writing a custom response.
Note: special considerations apply for asynchronous request processing. For more details see
AsyncHandlerInterceptor
.The default implementation returns
true
.- Specified by:
preHandle
in interfaceHandlerInterceptor
- Parameters:
request
- current HTTP requestresponse
- current HTTP responsehandler
- chosen handler to execute, for type and/or instance evaluation- Returns:
true
if the execution chain should proceed with the next interceptor or the handler itself. Else, DispatcherServlet assumes that this interceptor has already dealt with the response itself.- Throws:
ServletException
-
lookupCacheControl
Find aCacheControl
instance for the given parsedpath
. This is used when theHandlerMapping
uses parsedPathPatterns
.- Parameters:
path
- the path to match to- Returns:
- the matched
CacheControl
, ornull
if no match - Since:
- 5.3
-
lookupCacheControl
Find aCacheControl
instance for the given String lookupPath. This is used when theHandlerMapping
relies on String pattern matching withPathMatcher
.- Parameters:
lookupPath
- the path to match to- Returns:
- the matched
CacheControl
, ornull
if no match
-
lookupCacheSeconds
Find a cacheSeconds value for the given parsedpath
. This is used when theHandlerMapping
uses parsedPathPatterns
.- Parameters:
path
- the path to match to- Returns:
- the matched cacheSeconds, or
null
if there is no match - Since:
- 5.3
-
lookupCacheSeconds
Find a cacheSeconds instance for the given String lookupPath. This is used when theHandlerMapping
relies on String pattern matching withPathMatcher
.- Parameters:
lookupPath
- the path to match to- Returns:
- the matched cacheSeconds, or
null
if there is no match
-
postHandle
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception This implementation is empty.- Specified by:
postHandle
in interfaceHandlerInterceptor
- Parameters:
request
- current HTTP requestresponse
- current HTTP responsehandler
- the handler (orHandlerMethod
) that started asynchronous execution, for type and/or instance examinationmodelAndView
- theModelAndView
that the handler returned (can also benull
)- Throws:
Exception
- in case of errors
-
afterCompletion
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception This implementation is empty.- Specified by:
afterCompletion
in interfaceHandlerInterceptor
- Parameters:
request
- current HTTP requestresponse
- current HTTP responsehandler
- the handler (orHandlerMethod
) that started asynchronous execution, for type and/or instance examinationex
- any exception thrown on handler execution, if any; this does not include exceptions that have been handled through an exception resolver- Throws:
Exception
- in case of errors
-
ServletRequestPathUtils.getCachedPathValue(ServletRequest)