org.broadleafcommerce.common.web

Class BroadleafThemeResolverFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.broadleafcommerce.common.web.filter.AbstractIgnorableOncePerRequestFilter

org.broadleafcommerce.common.web.BroadleafThemeResolverFilter

All Implemented Interfaces:

javax.servlet.Filter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.EnvironmentAware, org.springframework.core.env.EnvironmentCapable, org.springframework.core.Ordered, org.springframework.web.context.ServletContextAware

@Component(value="blThemeResolverFilter")
 @ConditionalOnNotAdmin
public class BroadleafThemeResolverFilter
extends AbstractIgnorableOncePerRequestFilter

Responsible for setting up the theme used by Broadleaf Commerce components. This Filter is specifically placed after the CustomerState is established to that a Content Targeter altering the Theme can make use of Customer/CustomerSegment attributes.

Author:

Stanislav Fedorov

Field Summary

Fields

Modifier and Type	Field and Description
protected BroadleafThemeProcessor	themeProcessor

Fields inherited from class org.springframework.web.filter.OncePerRequestFilter

ALREADY_FILTERED_SUFFIX

Fields inherited from class org.springframework.web.filter.GenericFilterBean

logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
BroadleafThemeResolverFilter()

Method Summary

Modifier and Type	Method and Description
protected void	doFilterInternalUnlessIgnored(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain filterChain)
protected Set	getIgnoreSuffixes() Returns a set of suffixes that can be ignored by content processing.
int	getOrder()
protected boolean	shouldNotFilterErrorDispatch()
protected boolean	shouldProcessURL(javax.servlet.http.HttpServletRequest request, String requestURI) Determines if the passed in URL should be processed by the content management system.
protected boolean	shouldProcessURL(javax.servlet.http.HttpServletRequest request, String requestURI, boolean ignoreSessionCheck)

Methods inherited from class org.broadleafcommerce.common.web.filter.AbstractIgnorableOncePerRequestFilter

doFilterInternal, isIgnored

Methods inherited from class org.springframework.web.filter.OncePerRequestFilter

doFilter, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterAsyncDispatch

Methods inherited from class org.springframework.web.filter.GenericFilterBean

addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

Methods inherited from class java.lang.Object

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

Field Detail

themeProcessor

@Autowired
 @Qualifier(value="blThemeProcessor")
protected BroadleafThemeProcessor themeProcessor

Constructor Detail

BroadleafThemeResolverFilter

public BroadleafThemeResolverFilter()

Method Detail

doFilterInternalUnlessIgnored

protected void doFilterInternalUnlessIgnored(javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response,
                                             javax.servlet.FilterChain filterChain)
                                      throws IOException,
                                             javax.servlet.ServletException

Specified by:

doFilterInternalUnlessIgnored in class AbstractIgnorableOncePerRequestFilter

Throws:

IOException

javax.servlet.ServletException

shouldProcessURL

protected boolean shouldProcessURL(javax.servlet.http.HttpServletRequest request,
                                   String requestURI)

Determines if the passed in URL should be processed by the content management system.

By default, this method returns false for any BLC-Admin URLs and service calls and for all common image/digital mime-types (as determined by an internal call to getIgnoreSuffixes.

This check is called with the doFilterInternal method to short-circuit the content processing which can be expensive for requests that do not require it.

Parameters:

requestURI - - the HttpServletRequest.getRequestURI

Returns:

true if the HttpServletRequest should be processed

shouldProcessURL

protected boolean shouldProcessURL(javax.servlet.http.HttpServletRequest request,
                                   String requestURI,
                                   boolean ignoreSessionCheck)

getIgnoreSuffixes

protected Set getIgnoreSuffixes()

Returns a set of suffixes that can be ignored by content processing. The following are returned:

List of suffixes ignored: ".aif", ".aiff", ".asf", ".avi", ".bin", ".bmp", ".doc", ".eps", ".gif", ".hqx", ".jpg", ".jpeg", ".mid", ".midi", ".mov", ".mp3", ".mpg", ".mpeg", ".p65", ".pdf", ".pic", ".pict", ".png", ".ppt", ".psd", ".qxd", ".ram", ".ra", ".rm", ".sea", ".sit", ".stk", ".swf", ".tif", ".tiff", ".txt", ".rtf", ".vob", ".wav", ".wmf", ".xls", ".zip";

Returns:

set of suffixes to ignore.

shouldNotFilterErrorDispatch

protected boolean shouldNotFilterErrorDispatch()

Overrides:

shouldNotFilterErrorDispatch in class org.springframework.web.filter.OncePerRequestFilter

getOrder

public int getOrder()