com.broadleafcommerce.tenant.persistence

Class MultiTenantQualifyingEntityManagerInvocationProvider

java.lang.Object

com.broadleafcommerce.enterprise.common.persistence.entitymanager.EntityManagerInvocationProviderAdapter

com.broadleafcommerce.tenant.persistence.MultiTenantQualifyingEntityManagerInvocationProvider

All Implemented Interfaces:

com.broadleafcommerce.enterprise.common.persistence.entitymanager.EntityManagerInvocationProvider, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, org.springframework.core.Ordered

public class MultiTenantQualifyingEntityManagerInvocationProvider
extends com.broadleafcommerce.enterprise.common.persistence.entitymanager.EntityManagerInvocationProviderAdapter
implements org.springframework.context.ApplicationContextAware, org.springframework.context.SmartLifecycle

For performance, EntityManager find operations do not include Hibernate Filter operations. This creates a unique problem with multi-site scenarios where a find on a catalog or site discriminated entity could allow one site to improperly access a entity from another site. The purpose of this class is to perform a validation on a site or catalog discriminated entity to make sure the entity is within the purview of the requesting site. This validation is performed with the same catalog and/or site id list that is used during normal multitenant query filtering to guarantee accuracy. The validation method employed also takes into account dual discriminated entities (i.e. both site and catalog discriminated).

This functionality is ignored by default. To engage this validation, BroadleafRequestContext.setInternalValidateFind(Boolean) must be set to true.

Author:

Jeff Fischer

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.context.ApplicationContext	applicationContext
protected CatalogFilterEnabler	catalogFilterEnabler
protected MultiTenantDao	multiTenantDao
protected int	order
static int	ORDER
protected SiteFilterEnabler	siteFilterEnabler
protected Map<Integer,Boolean>	viabilityCache

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
MultiTenantQualifyingEntityManagerInvocationProvider()

Method Summary

Modifier and Type	Method and Description
int	getOrder()
int	getPhase()
com.broadleafcommerce.enterprise.common.persistence.entitymanager.EntityManagerInvocationProviderResponse	handleFindOperation(boolean shouldPerformAnyFilter, Object proxy, Method method, Object[] args, javax.persistence.EntityManager em, Object responseItem)
boolean	isAutoStartup()
boolean	isRunning()
boolean	isViableForEntityManager(javax.persistence.EntityManager em)
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setOrder(int order)
boolean	shouldPerformFiltration(org.broadleafcommerce.common.web.BroadleafRequestContext context, javax.persistence.EntityManager em)
boolean	shouldPerformFiltration(org.broadleafcommerce.common.web.BroadleafRequestContext context, org.hibernate.Session session)
void	start()
void	stop()
void	stop(Runnable callback)

Methods inherited from class com.broadleafcommerce.enterprise.common.persistence.entitymanager.EntityManagerInvocationProviderAdapter

disableFilters, enableFilters, getFilterEnablers, handleCriteriaOperation, handlePersistence, handleQueryOperation, preHandleEntityManager, setFilterEnablers, shouldFilterOnFind

Methods inherited from class java.lang.Object

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

Field Detail

ORDER

public static final int ORDER

See Also:

Constant Field Values

order

protected int order

viabilityCache

protected Map<Integer,Boolean> viabilityCache

catalogFilterEnabler

protected CatalogFilterEnabler catalogFilterEnabler

siteFilterEnabler

protected SiteFilterEnabler siteFilterEnabler

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

multiTenantDao

protected MultiTenantDao multiTenantDao

Constructor Detail

MultiTenantQualifyingEntityManagerInvocationProvider

public MultiTenantQualifyingEntityManagerInvocationProvider()

Method Detail

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface org.springframework.context.SmartLifecycle

stop

public void stop(Runnable callback)

Specified by:

stop in interface org.springframework.context.SmartLifecycle

start

public void start()

Specified by:

start in interface org.springframework.context.Lifecycle

stop

public void stop()

Specified by:

stop in interface org.springframework.context.Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface org.springframework.context.Lifecycle

getPhase

public int getPhase()

Specified by:

getPhase in interface org.springframework.context.Phased

Specified by:

getPhase in interface org.springframework.context.SmartLifecycle

isViableForEntityManager

public boolean isViableForEntityManager(javax.persistence.EntityManager em)

Specified by:

isViableForEntityManager in interface com.broadleafcommerce.enterprise.common.persistence.entitymanager.EntityManagerInvocationProvider

Overrides:

isViableForEntityManager in class com.broadleafcommerce.enterprise.common.persistence.entitymanager.EntityManagerInvocationProviderAdapter

shouldPerformFiltration

public boolean shouldPerformFiltration(org.broadleafcommerce.common.web.BroadleafRequestContext context,
                                       javax.persistence.EntityManager em)

Specified by:

shouldPerformFiltration in interface com.broadleafcommerce.enterprise.common.persistence.entitymanager.EntityManagerInvocationProvider

Overrides:

shouldPerformFiltration in class com.broadleafcommerce.enterprise.common.persistence.entitymanager.EntityManagerInvocationProviderAdapter

shouldPerformFiltration

public boolean shouldPerformFiltration(org.broadleafcommerce.common.web.BroadleafRequestContext context,
                                       org.hibernate.Session session)

Specified by:

shouldPerformFiltration in interface com.broadleafcommerce.enterprise.common.persistence.entitymanager.EntityManagerInvocationProvider

Overrides:

shouldPerformFiltration in class com.broadleafcommerce.enterprise.common.persistence.entitymanager.EntityManagerInvocationProviderAdapter

handleFindOperation

public com.broadleafcommerce.enterprise.common.persistence.entitymanager.EntityManagerInvocationProviderResponse handleFindOperation(boolean shouldPerformAnyFilter,
                                                                                                                                     Object proxy,
                                                                                                                                     Method method,
                                                                                                                                     Object[] args,
                                                                                                                                     javax.persistence.EntityManager em,
                                                                                                                                     Object responseItem)

Specified by:

handleFindOperation in interface com.broadleafcommerce.enterprise.common.persistence.entitymanager.EntityManagerInvocationProvider

Overrides:

handleFindOperation in class com.broadleafcommerce.enterprise.common.persistence.entitymanager.EntityManagerInvocationProviderAdapter

setOrder

public void setOrder(int order)

Specified by:

setOrder in interface com.broadleafcommerce.enterprise.common.persistence.entitymanager.EntityManagerInvocationProvider

Overrides:

setOrder in class com.broadleafcommerce.enterprise.common.persistence.entitymanager.EntityManagerInvocationProviderAdapter

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

Overrides:

getOrder in class com.broadleafcommerce.enterprise.common.persistence.entitymanager.EntityManagerInvocationProviderAdapter