Spring Framework

org.springframework.web.servlet.handler
Class WebRequestHandlerInterceptorAdapter

java.lang.Object
  extended by org.springframework.web.servlet.handler.WebRequestHandlerInterceptorAdapter
All Implemented Interfaces:
AsyncHandlerInterceptor, HandlerInterceptor

public class WebRequestHandlerInterceptorAdapter
extends java.lang.Object
implements AsyncHandlerInterceptor

Adapter that implements the Servlet HandlerInterceptor interface and wraps an underlying WebRequestInterceptor.

Since:
2.0
Author:
Juergen Hoeller
See Also:
WebRequestInterceptor, HandlerInterceptor

Constructor Summary
WebRequestHandlerInterceptorAdapter(WebRequestInterceptor requestInterceptor)
          Create a new WebRequestHandlerInterceptorAdapter for the given WebRequestInterceptor.
 
Method Summary
 void afterCompletion(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.Object handler, java.lang.Exception ex)
          Callback after completion of request processing, that is, after rendering the view.
 AbstractDelegatingCallable getAsyncCallable(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.Object handler)
          Invoked after #preHandle(WebRequest) and before the handler is executed.
 void postHandle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.Object handler, ModelAndView modelAndView)
          Intercept the execution of a handler.
 void postHandleAsyncStarted(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.Object handler)
          Invoked after the execution of a handler if the handler started async processing instead of handling the request.
 boolean preHandle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.Object handler)
          Intercept the execution of a handler.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WebRequestHandlerInterceptorAdapter

public WebRequestHandlerInterceptorAdapter(WebRequestInterceptor requestInterceptor)
Create a new WebRequestHandlerInterceptorAdapter for the given WebRequestInterceptor.

Parameters:
requestInterceptor - the WebRequestInterceptor to wrap
Method Detail

preHandle

public boolean preHandle(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response,
                         java.lang.Object handler)
                  throws java.lang.Exception
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.

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:
java.lang.Exception - in case of errors

getAsyncCallable

public AbstractDelegatingCallable getAsyncCallable(javax.servlet.http.HttpServletRequest request,
                                                   javax.servlet.http.HttpServletResponse response,
                                                   java.lang.Object handler)
Description copied from interface: AsyncHandlerInterceptor
Invoked after #preHandle(WebRequest) and before the handler is executed. The returned Callable is used only if handler execution leads to teh start of async processing. It is invoked the async thread before the request is handled fro.

Implementations can use this Callable to initialize ThreadLocal attributes on the async thread.

Specified by:
getAsyncCallable in interface AsyncHandlerInterceptor
Parameters:
request - current HTTP request
response - current HTTP response
handler - chosen handler to execute, for type and/or instance examination
Returns:
a Callable instance or null

postHandleAsyncStarted

public void postHandleAsyncStarted(javax.servlet.http.HttpServletRequest request,
                                   javax.servlet.http.HttpServletResponse response,
                                   java.lang.Object handler)
Description copied from interface: AsyncHandlerInterceptor
Invoked after the execution of a handler if the handler started async processing instead of handling the request. Effectively this method is invoked on the way out of the main processing thread instead of #postHandle(WebRequest, org.springframework.ui.ModelMap). The postHandle method is invoked after the request is handled in the async thread.

Implementations of this method can ensure ThreadLocal attributes bound to the main thread are cleared and also prepare for binding them to the async thread.

Specified by:
postHandleAsyncStarted in interface AsyncHandlerInterceptor
Parameters:
request - current HTTP request
response - current HTTP response
handler - chosen handler to execute, for type and/or instance examination

postHandle

public void postHandle(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response,
                       java.lang.Object handler,
                       ModelAndView modelAndView)
                throws java.lang.Exception
Description copied from interface: HandlerInterceptor
Intercept the execution of a handler. Called after HandlerAdapter actually invoked the handler, but before the DispatcherServlet renders the view. Can expose additional model objects to the view via the given ModelAndView.

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 post-process an execution, getting applied in inverse order of the execution chain.

Specified by:
postHandle in interface HandlerInterceptor
Parameters:
request - current HTTP request
response - current HTTP response
handler - chosen handler to execute, for type and/or instance examination
modelAndView - the ModelAndView that the handler returned (can also be null)
Throws:
java.lang.Exception - in case of errors

afterCompletion

public void afterCompletion(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response,
                            java.lang.Object handler,
                            java.lang.Exception ex)
                     throws java.lang.Exception
Description copied from interface: HandlerInterceptor
Callback after completion of request processing, that is, after rendering the view. Will be called on any outcome of handler execution, thus allows for proper resource cleanup.

Note: Will only be called if this interceptor's preHandle method has successfully completed and returned true!

As with the postHandle method, the method will be invoked on each interceptor in the chain in reverse order, so the first interceptor will be the last to be invoked.

Specified by:
afterCompletion in interface HandlerInterceptor
Parameters:
request - current HTTP request
response - current HTTP response
handler - chosen handler to execute, for type and/or instance examination
ex - exception thrown on handler execution, if any
Throws:
java.lang.Exception - in case of errors

Spring Framework