org.broadleafcommerce.openadmin.web.filter

Class AbstractBroadleafAdminRequestFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.broadleafcommerce.common.web.filter.AbstractIgnorableOncePerRequestFilter

org.broadleafcommerce.openadmin.web.filter.AbstractBroadleafAdminRequestFilter

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

Direct Known Subclasses:

BroadleafAdminRequestFilter, BroadleafAdminTypedEntityRequestFilter

public abstract class AbstractBroadleafAdminRequestFilter
extends AbstractIgnorableOncePerRequestFilter

Author:

Jeff Fischer

Field Summary

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
AbstractBroadleafAdminRequestFilter()

Method Summary

Modifier and Type	Method and Description
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.broadleafcommerce.common.web.filter.AbstractIgnorableOncePerRequestFilter

doFilterInternal, doFilterInternalUnlessIgnored, isIgnored

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

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

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

Methods inherited from interface org.springframework.core.Ordered

getOrder

Constructor Detail

AbstractBroadleafAdminRequestFilter

public AbstractBroadleafAdminRequestFilter()

Method Detail

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.