com.foreach.across.modules.webcms.domain.endpoint.web.interceptor

Class WebCmsEndpointHandlerInterceptor

java.lang.Object

org.springframework.web.servlet.handler.HandlerInterceptorAdapter

com.foreach.across.modules.webcms.domain.endpoint.web.interceptor.WebCmsEndpointHandlerInterceptor

All Implemented Interfaces:

org.springframework.web.servlet.AsyncHandlerInterceptor, org.springframework.web.servlet.HandlerInterceptor

public class WebCmsEndpointHandlerInterceptor
extends org.springframework.web.servlet.handler.HandlerInterceptorAdapter

Interceptor for basic WebCmsUrl and WebCmsEndpoint handling.

• sets the status code of the WebCmsUrl on the HttpServletResponse
• sets the X-WCM-Preview header when previewing an endpoint
• will apply the default template as view if one is set as request attribute (DEFAULT_TEMPLATE_ATTRIBUTE and the handler method has a void return type

This interceptor also listens to the BuildTemplateWebResourcesEvent and will register preview related web resources when in preview mode.

Since:

0.0.1

Author:

Sander Van Loock, Arne Vandamme

See Also:

WebCmsEndpointControllerAdvice, IgnoreEndpointModel

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_TEMPLATE_ATTRIBUTE Attribute value should be the view that will be resolved if a handler method has a void return type.

Constructor Summary

Constructors

Constructor and Description
WebCmsEndpointHandlerInterceptor()

Method Summary

Modifier and Type	Method and Description
void	postHandle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object handler, org.springframework.web.servlet.ModelAndView modelAndView)
boolean	preHandle(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Object handler)
void	registerPreviewModeWebResources(com.foreach.across.modules.web.events.BuildTemplateWebResourcesEvent webResourcesEvent)

Methods inherited from class org.springframework.web.servlet.handler.HandlerInterceptorAdapter

afterCompletion, afterConcurrentHandlingStarted

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TEMPLATE_ATTRIBUTE

public static final String DEFAULT_TEMPLATE_ATTRIBUTE

Attribute value should be the view that will be resolved if a handler method has a void return type.

Constructor Detail

WebCmsEndpointHandlerInterceptor

public WebCmsEndpointHandlerInterceptor()

Method Detail

preHandle

public boolean preHandle(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response,
                         Object handler)
                  throws Exception

Specified by:

preHandle in interface org.springframework.web.servlet.HandlerInterceptor

Overrides:

preHandle in class org.springframework.web.servlet.handler.HandlerInterceptorAdapter

Throws:

Exception

postHandle

public void postHandle(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response,
                       Object handler,
                       org.springframework.web.servlet.ModelAndView modelAndView)
                throws Exception

Specified by:

postHandle in interface org.springframework.web.servlet.HandlerInterceptor

Overrides:

postHandle in class org.springframework.web.servlet.handler.HandlerInterceptorAdapter

Throws:

Exception

registerPreviewModeWebResources

@EventListener
public void registerPreviewModeWebResources(com.foreach.across.modules.web.events.BuildTemplateWebResourcesEvent webResourcesEvent)