org.springframework.web.servlet.mvc

Class WebContentInterceptor

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.WebContentInterceptor

All Implemented Interfaces:

Aware, ApplicationContextAware, ServletContextAware, HandlerInterceptor

public class WebContentInterceptor
extends WebContentGenerator
implements HandlerInterceptor

Handler interceptor that checks the request and prepares the response. Checks for supported methods and a required session, and applies the specified CacheControl builder. See superclass bean properties for configuration options.

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

See Also:

AbstractController

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 and Description
WebContentInterceptor()

Method Summary

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(String urlPath) Look up a CacheControl instance for the given URL path.
protected Integer	lookupCacheSeconds(String urlPath) Look up a cacheSeconds integer value for the given URL path.
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) Shortcut to same property on underlying UrlPathHelper.
void	setCacheMappings(Properties cacheMappings) Map specific URL paths to specific cache seconds.
void	setPathMatcher(PathMatcher pathMatcher) Set the PathMatcher implementation to use for matching URL paths against registered URL patterns, for determining cache mappings.
void	setUrlDecode(boolean urlDecode) Shortcut to same property on underlying UrlPathHelper.
void	setUrlPathHelper(UrlPathHelper urlPathHelper) Set the UrlPathHelper to use for resolution of lookup paths.

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebContentInterceptor

public WebContentInterceptor()

Method Detail

setAlwaysUseFullPath

public void setAlwaysUseFullPath(boolean alwaysUseFullPath)

Shortcut to same property on underlying UrlPathHelper.

Only relevant for the "cacheMappings" setting.

See Also:

setCacheMappings(java.util.Properties), UrlPathHelper.setAlwaysUseFullPath(boolean)

setUrlDecode

public void setUrlDecode(boolean urlDecode)

Shortcut to same property on underlying UrlPathHelper.

Only relevant for the "cacheMappings" setting.

See Also:

setCacheMappings(java.util.Properties), UrlPathHelper.setUrlDecode(boolean)

setUrlPathHelper

public void setUrlPathHelper(UrlPathHelper urlPathHelper)

Set the UrlPathHelper to use for resolution of lookup paths.

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

Only relevant for the "cacheMappings" setting.

See Also:

setCacheMappings(java.util.Properties), AbstractHandlerMapping.setUrlPathHelper(org.springframework.web.util.UrlPathHelper)

setCacheMappings

public void setCacheMappings(Properties cacheMappings)

Map specific URL paths to specific cache seconds.

Overrides the default cache seconds setting of this interceptor. Can specify "-1" to exclude a URL path from default caching.

Supports direct matches, e.g. a registered "/test" matches "/test", and a various Ant-style pattern matches, e.g. a registered "/t*" matches both "/test" and "/team". For details, see the AntPathMatcher javadoc.

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:

WebContentGenerator.setCacheSeconds(int), AntPathMatcher

addCacheMapping

public void addCacheMapping(CacheControl cacheControl,
                            String... paths)

Map specific URL paths to a specific CacheControl.

Overrides the default cache seconds setting of this interceptor. Can specify a empty CacheControl instance to exclude a URL path from default caching.

Supports direct matches, e.g. a registered "/test" matches "/test", and a various Ant-style pattern matches, e.g. a registered "/t*" matches both "/test" and "/team". For details, see the AntPathMatcher javadoc.

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 - the CacheControl to use

paths - URL paths that will map to the given CacheControl

Since:

4.2

See Also:

WebContentGenerator.setCacheSeconds(int), AntPathMatcher

setPathMatcher

public void setPathMatcher(PathMatcher pathMatcher)

Set the PathMatcher implementation to use for matching URL paths against registered URL patterns, for determining cache mappings. Default is AntPathMatcher.

See Also:

addCacheMapping(org.springframework.http.CacheControl, java.lang.String...), setCacheMappings(java.util.Properties), AntPathMatcher

preHandle

public boolean preHandle(HttpServletRequest request,
                         HttpServletResponse response,
                         Object handler)
                  throws ServletException

Description copied from interface: HandlerInterceptor

Intercept 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 a 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 interface HandlerInterceptor

Parameters:

request - current HTTP request

response - current HTTP response

handler - 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

@Nullable
protected CacheControl lookupCacheControl(String urlPath)

Look up a CacheControl instance for the given URL path.

Supports direct matches, e.g. a registered "/test" matches "/test", and various Ant-style pattern matches, e.g. a registered "/t*" matches both "/test" and "/team". For details, see the AntPathMatcher class.

Parameters:

urlPath - URL the bean is mapped to

Returns:

the associated CacheControl, or null if not found

See Also:

AntPathMatcher

lookupCacheSeconds

@Nullable
protected Integer lookupCacheSeconds(String urlPath)

Look up a cacheSeconds integer value for the given URL path.

Supports direct matches, e.g. a registered "/test" matches "/test", and various Ant-style pattern matches, e.g. a registered "/t*" matches both "/test" and "/team". For details, see the AntPathMatcher class.

Parameters:

urlPath - URL the bean is mapped to

Returns:

the cacheSeconds integer value, or null if not found

See Also:

AntPathMatcher

postHandle

public void postHandle(HttpServletRequest request,
                       HttpServletResponse response,
                       Object handler,
                       @Nullable
                       ModelAndView modelAndView)
                throws Exception

This implementation is empty.

Specified by:

postHandle in interface HandlerInterceptor

Parameters:

request - current HTTP request

response - current HTTP response

handler - handler (or HandlerMethod) that started asynchronous execution, for type and/or instance examination

modelAndView - the ModelAndView that the handler returned (can also be null)

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 interface HandlerInterceptor

Parameters:

request - current HTTP request

response - current HTTP response

handler - handler (or HandlerMethod) that started asynchronous execution, for type and/or instance examination

ex - exception thrown on handler execution, if any

Throws:

Exception - in case of errors