org.broadleafcommerce.common.web

Class BroadleafRequestFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.broadleafcommerce.common.web.BroadleafRequestFilter

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.web.context.ServletContextAware

@Component(value="blRequestFilter")
public class BroadleafRequestFilter
extends org.springframework.web.filter.OncePerRequestFilter

Responsible for setting up the site and locale used by Broadleaf Commerce components.

Author:

bpolster

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADMIN_USER_ID_PARAM_NAME
static String	REQUEST_DTO_PARAM_NAME Parameter/Attribute name for the current language
protected BroadleafRequestProcessor	requestProcessor

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

ALREADY_FILTERED_SUFFIX

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

logger

Constructor Summary

Constructors

Constructor and Description
BroadleafRequestFilter()

Method Summary

Methods

Modifier and Type	Method and Description
void	doFilterInternal(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.
protected boolean	shouldProcessURL(javax.servlet.http.HttpServletRequest request, String requestURI) Determines if the passed in URL should be processed by the content management system.

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

doFilter, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterAsyncDispatch, shouldNotFilterErrorDispatch

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

addRequiredProperty, afterPropertiesSet, destroy, 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

REQUEST_DTO_PARAM_NAME

public static String REQUEST_DTO_PARAM_NAME

Parameter/Attribute name for the current language

ADMIN_USER_ID_PARAM_NAME

public static final String ADMIN_USER_ID_PARAM_NAME

See Also:

Constant Field Values

requestProcessor

protected BroadleafRequestProcessor requestProcessor

Constructor Detail

BroadleafRequestFilter

public BroadleafRequestFilter()

Method Detail

doFilterInternal

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

Specified by:

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

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

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.