org.broadleafcommerce.authapi.filter

Class ApiCustomerStateFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.broadleafcommerce.common.web.filter.AbstractIgnorableOncePerRequestFilter

org.broadleafcommerce.authapi.filter.ApiCustomerStateFilter

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="blApiCustomerStateFilter")
public class ApiCustomerStateFilter
extends org.broadleafcommerce.common.web.filter.AbstractIgnorableOncePerRequestFilter

This filter runs after spring security and is responsible for setting up the customer state. This will be automatically registered in post-security filter chain.

Author:

Nick Crum ncrum

Field Summary

Fields

Modifier and Type	Field and Description
static String	BLC_RULE_MAP_PARAM
protected CustomerStateService	customerStateService

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
ApiCustomerStateFilter(CustomerStateService customerStateService)

Method Summary

Modifier and Type	Method and Description
protected void	doFilterInternalUnlessIgnored(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain chain)
int	getOrder()
protected boolean	shouldNotFilterErrorDispatch()

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

BLC_RULE_MAP_PARAM

public static final String BLC_RULE_MAP_PARAM

See Also:

Constant Field Values

customerStateService

protected final CustomerStateService customerStateService

Constructor Detail

ApiCustomerStateFilter

public ApiCustomerStateFilter(CustomerStateService customerStateService)

Method Detail

doFilterInternalUnlessIgnored

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

Specified by:

doFilterInternalUnlessIgnored in class org.broadleafcommerce.common.web.filter.AbstractIgnorableOncePerRequestFilter

Throws:

IOException

javax.servlet.ServletException

getOrder

public int getOrder()

shouldNotFilterErrorDispatch

protected boolean shouldNotFilterErrorDispatch()

Overrides:

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