public class WebContentInterceptor extends WebContentGenerator implements 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 ServletRequestPathUtils.parseAndCache(javax.servlet.http.HttpServletRequest)
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.
PathMatcher
,
AntPathMatcher
HEADER_CACHE_CONTROL, METHOD_GET, METHOD_HEAD, METHOD_POST
logger
Constructor and Description |
---|
WebContentInterceptor()
Default constructor with
PathPatternParser.defaultInstance . |
WebContentInterceptor(PathPatternParser parser)
Constructor with a
PathPatternParser to parse patterns with. |
Modifier and Type | Method and Description |
---|---|
void |
addCacheMapping(CacheControl cacheControl,
String... paths)
Map specific URL paths to a specific
CacheControl . |
void |
afterCompletion(HttpServletRequest request,
HttpServletResponse response,
Object handler,
Exception ex)
This implementation is empty.
|
protected CacheControl |
lookupCacheControl(PathContainer path)
Find a
CacheControl instance for the
given parsed path . |
protected CacheControl |
lookupCacheControl(String lookupPath)
Find a
CacheControl instance for the
given String lookupPath. |
protected Integer |
lookupCacheSeconds(PathContainer path)
Find a cacheSeconds value for the given parsed
path . |
protected Integer |
lookupCacheSeconds(String lookupPath)
Find a cacheSeconds instance for the given String lookupPath.
|
void |
postHandle(HttpServletRequest request,
HttpServletResponse response,
Object handler,
ModelAndView modelAndView)
This implementation is empty.
|
boolean |
preHandle(HttpServletRequest request,
HttpServletResponse response,
Object handler)
Intercept the execution of a handler.
|
void |
setAlwaysUseFullPath(boolean alwaysUseFullPath)
Deprecated.
as of 5.3, the path is resolved externally and obtained with
ServletRequestPathUtils.getCachedPathValue(ServletRequest) |
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 with
ServletRequestPathUtils.getCachedPathValue(ServletRequest) |
void |
setUrlPathHelper(UrlPathHelper urlPathHelper)
Deprecated.
as of 5.3, the path is resolved externally and obtained with
ServletRequestPathUtils.getCachedPathValue(ServletRequest) |
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
getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext
getApplicationContext, getMessageSourceAccessor, initApplicationContext, obtainApplicationContext, requiredContextClass, setApplicationContext
public WebContentInterceptor()
PathPatternParser.defaultInstance
.public WebContentInterceptor(PathPatternParser parser)
PathPatternParser
to parse patterns with.@Deprecated public void setAlwaysUseFullPath(boolean alwaysUseFullPath)
ServletRequestPathUtils.getCachedPathValue(ServletRequest)
same property
on the configured UrlPathHelper
.@Deprecated public void setUrlDecode(boolean urlDecode)
ServletRequestPathUtils.getCachedPathValue(ServletRequest)
same property
on the configured UrlPathHelper
.@Deprecated public void setUrlPathHelper(UrlPathHelper urlPathHelper)
ServletRequestPathUtils.getCachedPathValue(ServletRequest)
public void setPathMatcher(PathMatcher pathMatcher)
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 a
parsed
RequestPath
is available.
public void setCacheMappings(Properties cacheMappings)
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
and PathPattern
as well as the class-level Javadoc for details for when each is used.
The syntax is largely the same with PathPattern
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
).
cacheMappings
- a mapping between URL paths (as keys) and
cache seconds (as values, need to be integer-parsable)WebContentGenerator.setCacheSeconds(int)
public void addCacheMapping(CacheControl cacheControl, String... paths)
CacheControl
.
Overrides the default cache seconds setting of this interceptor.
Can specify a empty CacheControl
instance
to exclude a URL path from default caching.
For pattern syntax see AntPathMatcher
and PathPattern
as well as the class-level Javadoc for details for when each is used.
The syntax is largely the same with PathPattern
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
).
cacheControl
- the CacheControl
to usepaths
- the URL paths that will map to the given CacheControl
WebContentGenerator.setCacheSeconds(int)
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws ServletException
HandlerInterceptor
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
.
preHandle
in interface HandlerInterceptor
request
- current HTTP requestresponse
- current HTTP responsehandler
- chosen handler to execute, for type and/or instance evaluationtrue
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.ServletException
@Nullable protected CacheControl lookupCacheControl(PathContainer path)
CacheControl
instance for the
given parsed path
. This is used when the
HandlerMapping
uses parsed PathPatterns
.path
- the path to match toCacheControl
, or null
if no match@Nullable protected CacheControl lookupCacheControl(String lookupPath)
CacheControl
instance for the
given String lookupPath. This is used when the HandlerMapping
relies on String pattern matching with PathMatcher
.lookupPath
- the path to match toCacheControl
, or null
if no match@Nullable protected Integer lookupCacheSeconds(PathContainer path)
path
.
This is used when the HandlerMapping
uses parsed PathPatterns
.path
- the path to match tonull
if there is no match@Nullable protected Integer lookupCacheSeconds(String lookupPath)
HandlerMapping
relies on String pattern
matching with PathMatcher
.lookupPath
- the path to match tonull
if there is no matchpublic void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception
postHandle
in interface HandlerInterceptor
request
- current HTTP requestresponse
- current HTTP responsehandler
- the handler (or HandlerMethod
) that started asynchronous
execution, for type and/or instance examinationmodelAndView
- the ModelAndView
that the handler returned
(can also be null
)Exception
- in case of errorspublic void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception
afterCompletion
in interface HandlerInterceptor
request
- current HTTP requestresponse
- current HTTP responsehandler
- the handler (or HandlerMethod
) 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 resolverException
- in case of errors