Top Description Methods
org.springframework.web.context.request

public Interface WebRequestInterceptor

Known Direct Subinterfaces
org.springframework.web.context.request.AsyncWebRequestInterceptor
Imports
org.springframework.lang.Nullable, org.springframework.ui.ModelMap

Interface for general web request interception. Allows for being applied to Servlet request by building on the WebRequest abstraction.

This interface assumes MVC-style request processing: A handler gets executed, exposes a set of model objects, then a view gets rendered based on that model. Alternatively, a handler may also process the request completely, with no view to be rendered.

In an async processing scenario, the handler may be executed in a separate thread while the main thread exits without rendering or invoking the postHandle and afterCompletion callbacks. When concurrent handler execution completes, the request is dispatched back in order to proceed with rendering the model and all methods of this contract are invoked again. For further options and comments see org.springframework.web.context.request.async.AsyncWebRequestInterceptor

This interface is deliberately minimalistic to keep the dependencies of generic request interceptors as minimal as feasible.

Author
Juergen Hoeller
Since
2.0
See Also
ServletWebRequest, org.springframework.web.servlet.DispatcherServlet, org.springframework.web.servlet.handler.AbstractHandlerMapping#setInterceptors, org.springframework.web.servlet.HandlerInterceptor

Method Summary

Modifier and TypeMethod and Description
public void
afterCompletion(WebRequest
the current web request
request
,
Exception
exception thrown on handler execution, if any
ex
)

Callback after completion of request processing, that is, after rendering the view.

public void
postHandle(WebRequest
the current web request
request
,
ModelMap
the map of model objects that will be exposed to the view (may be null). Can be used to analyze the exposed model and/or to add further model attributes, if desired.
model
)

Intercept the execution of a request handler after its successful invocation, right before view rendering (if any).

public void
preHandle(WebRequest
the current web request
request
)

Intercept the execution of a request handler before its invocation.

Method Detail

afterCompletionback to summary
public void afterCompletion(WebRequest request, Exception ex) throws Exception

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!

Parameters
request:WebRequest

the current web request

ex:Exception

exception thrown on handler execution, if any

Exceptions
Exception:
in case of errors
postHandleback to summary
public void postHandle(WebRequest request, ModelMap model) throws Exception

Intercept the execution of a request handler after its successful invocation, right before view rendering (if any).

Allows for modifying context resources after successful handler execution (for example, flushing a Hibernate Session).

Parameters
request:WebRequest

the current web request

model:ModelMap

the map of model objects that will be exposed to the view (may be null). Can be used to analyze the exposed model and/or to add further model attributes, if desired.

Exceptions
Exception:
in case of errors
preHandleback to summary
public void preHandle(WebRequest request) throws Exception

Intercept the execution of a request handler before its invocation.

Allows for preparing context resources (such as a Hibernate Session) and expose them as request attributes or as thread-local objects.

Parameters
request:WebRequest

the current web request

Exceptions
Exception:
in case of errors