public abstract class

HandlerInterceptorAdapter

extends Object
implements HandlerInterceptor
java.lang.Object
   ↳ org.springframework.web.portlet.handler.HandlerInterceptorAdapter
Known Direct Subclasses

Class Overview

Abstract adapter class for the HandlerInterceptor interface, for simplified implementation of pre-only/post-only interceptors.

Summary

Public Constructors
HandlerInterceptorAdapter()
Public Methods
void afterActionCompletion(ActionRequest request, ActionResponse response, Object handler, Exception ex)
void afterEventCompletion(EventRequest request, EventResponse response, Object handler, Exception ex)
void afterRenderCompletion(RenderRequest request, RenderResponse response, Object handler, Exception ex)
void afterResourceCompletion(ResourceRequest request, ResourceResponse response, Object handler, Exception ex)
void postHandleRender(RenderRequest request, RenderResponse response, Object handler, ModelAndView modelAndView)
This implementation is empty.
void postHandleResource(ResourceRequest request, ResourceResponse response, Object handler, ModelAndView modelAndView)
This implementation is empty.
boolean preHandleAction(ActionRequest request, ActionResponse response, Object handler)
This implementation delegates to preHandle(PortletRequest, PortletResponse, Object).
boolean preHandleEvent(EventRequest request, EventResponse response, Object handler)
This implementation delegates to preHandle(PortletRequest, PortletResponse, Object).
boolean preHandleRender(RenderRequest request, RenderResponse response, Object handler)
This implementation delegates to preHandle(PortletRequest, PortletResponse, Object).
boolean preHandleResource(ResourceRequest request, ResourceResponse response, Object handler)
This implementation delegates to preHandle(PortletRequest, PortletResponse, Object).
Protected Methods
void afterCompletion(PortletRequest request, PortletResponse response, Object handler, Exception ex)
Default callback that all "after*" methods delegate to.
boolean preHandle(PortletRequest request, PortletResponse response, Object handler)
Default callback that all "pre*" methods delegate to.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.web.portlet.HandlerInterceptor

Public Constructors

public HandlerInterceptorAdapter ()

Public Methods

public void afterActionCompletion (ActionRequest request, ActionResponse response, Object handler, Exception ex)

Parameters
request current portlet action request
response current portlet action response
handler chosen handler to execute, for type and/or instance examination
ex exception thrown on handler execution, if any (only included as additional context information for the case where a handler threw an exception; request execution may have failed even when this argument is null)
Throws
Exception

public void afterEventCompletion (EventRequest request, EventResponse response, Object handler, Exception ex)

Parameters
request current portlet action request
response current portlet action response
handler chosen handler to execute, for type and/or instance examination
ex exception thrown on handler execution, if any (only included as additional context information for the case where a handler threw an exception; request execution may have failed even when this argument is null)
Throws
Exception

public void afterRenderCompletion (RenderRequest request, RenderResponse response, Object handler, Exception ex)

Parameters
request current portlet render request
response current portlet render response
handler chosen handler to execute, for type and/or instance examination
ex exception thrown on handler execution, if any
Throws
Exception

public void afterResourceCompletion (ResourceRequest request, ResourceResponse response, Object handler, Exception ex)

Parameters
request current portlet render request
response current portlet render response
handler chosen handler to execute, for type and/or instance examination
ex exception thrown on handler execution, if any
Throws
Exception

public void postHandleRender (RenderRequest request, RenderResponse response, Object handler, ModelAndView modelAndView)

This implementation is empty.

Parameters
request current portlet render request
response current portlet render response
handler chosen handler to execute, for type and/or instance examination
modelAndView the ModelAndView that the handler returned (can also be null)
Throws
Exception

public void postHandleResource (ResourceRequest request, ResourceResponse response, Object handler, ModelAndView modelAndView)

This implementation is empty.

Parameters
request current portlet render request
response current portlet render response
handler chosen handler to execute, for type and/or instance examination
modelAndView the ModelAndView that the handler returned (can also be null)
Throws
Exception

public boolean preHandleAction (ActionRequest request, ActionResponse response, Object handler)

This implementation delegates to preHandle(PortletRequest, PortletResponse, Object).

Parameters
request current portlet action request
response current portlet action 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, DispatcherPortlet assumes that this interceptor has already dealt with the response itself
Throws
Exception

public boolean preHandleEvent (EventRequest request, EventResponse response, Object handler)

This implementation delegates to preHandle(PortletRequest, PortletResponse, Object).

Parameters
request current portlet action request
response current portlet action 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, DispatcherPortlet assumes that this interceptor has already dealt with the response itself
Throws
Exception

public boolean preHandleRender (RenderRequest request, RenderResponse response, Object handler)

This implementation delegates to preHandle(PortletRequest, PortletResponse, Object).

Parameters
request current portlet render request
response current portlet render 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, DispatcherPortlet assumes that this interceptor has already dealt with the response itself
Throws
Exception

public boolean preHandleResource (ResourceRequest request, ResourceResponse response, Object handler)

This implementation delegates to preHandle(PortletRequest, PortletResponse, Object).

Parameters
request current portlet render request
response current portlet render 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, DispatcherPortlet assumes that this interceptor has already dealt with the response itself
Throws
Exception

Protected Methods

protected void afterCompletion (PortletRequest request, PortletResponse response, Object handler, Exception ex)

Default callback that all "after*" methods delegate to.

This implementation is empty.

Throws
Exception

protected boolean preHandle (PortletRequest request, PortletResponse response, Object handler)

Default callback that all "pre*" methods delegate to.

This implementation always returns true.

Throws
Exception