Package org.broadleafcommerce.common.web.filter

Class EntityManagerFindValidationFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.broadleafcommerce.common.web.filter.EntityManagerFindValidationFilter

All Implemented Interfaces:

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

@Order(500000)
public class EntityManagerFindValidationFilter
extends org.springframework.web.filter.OncePerRequestFilter

Used to validate usages of em.find() when querying for a primary key specifically across sibling Multi-Tenant sites. This Servlet filter should only turned on if you often query an entity by ID. Generally this only happens in API-based use cases since most other use cases rely on querying by name, url, etc and not directly on a primary key.

This is intentionally not activated by default but is included here for convenience within other projects. If you are in Spring Boot, this filter can be activated simply in an @Bean method. If you are not using Spring Boot, this filter must come after the BroadleafRequestFilter and is generally initialized in applicationContext-filter.xml.

Since:

5.2

Author:

Phillip Verheyden (phillipuniverse)

See Also:

• BroadleafRequestContext.setInternalIgnoreFilters(Boolean)

Field Summary

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	Description
EntityManagerFindValidationFilter()

Method Summary

Modifier and Type	Method	Description
protected void	doFilterInternal(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain filterChain)

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

Constructor Details

EntityManagerFindValidationFilter

public EntityManagerFindValidationFilter()

Method Details

doFilterInternal

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

Specified by:

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

Throws:

jakarta.servlet.ServletException

IOException