com.broadleafcommerce.enterprise.common.persistence.entitymanager

Interface EntityManagerInvocationProvider

All Superinterfaces:

org.springframework.core.Ordered

All Known Implementing Classes:

EntityManagerInvocationProviderAdapter

public interface EntityManagerInvocationProvider
extends org.springframework.core.Ordered

Provider for handling standard entity manager operations

Invocation providers are generally added via the following approach in application context xml

 
 <bean id="blWorkflowEntityManagerInvocationProviders" class="org.springframework.beans.factory.config.ListFactoryBean">
      <property name="sourceList">
          <list>
              <ref bean="blSandBoxEntityManagerInvocationProvider"/>
          </list>
      </property>
 </bean>
 <bean class="org.broadleafcommerce.common.extensibility.context.merge.EarlyStageMergeBeanPostProcessor">
      <property name="collectionRef" value="blWorkflowEntityManagerInvocationProviders"/>
      <property name="targetRef" value="blEntityManagerInvocationProviders"/>
 </bean>
 

Author:

Jeff Fischer

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method and Description
void	disableFilters(org.hibernate.Session session, org.broadleafcommerce.common.web.BroadleafRequestContext context) Disable Filter for a session using @#getFilterEnablers()
void	enableFilters(org.hibernate.Session session, org.broadleafcommerce.common.web.BroadleafRequestContext context) Activate Filter for a session using getFilterEnablers()
List<FilterEnabler>	getFilterEnablers()
EntityManagerInvocationProviderResponse	handleCriteriaOperation(boolean shouldPerformAnyFilter, Object proxy, Method method, Object[] args, javax.persistence.EntityManager em, Object responseItem, org.hibernate.Criteria criteria) Handle a criteria operation
EntityManagerInvocationProviderResponse	handleFindOperation(boolean shouldPerformAnyFilter, Object proxy, Method method, Object[] args, javax.persistence.EntityManager em, Object responseItem) Handle a find operation (EntityManager.find(Class, Object)
EntityManagerInvocationProviderResponse	handlePersistence(boolean shouldPerformAnyFilter, Object proxy, Method method, Object entity, javax.persistence.EntityManager em) Handle any call to EntityManager.persist(Object), EntityManager.merge(Object) or EntityManager.remove(Object)
EntityManagerInvocationProviderResponse	handleQueryOperation(boolean shouldPerformAnyFilter, Object proxy, Method method, Object[] args, javax.persistence.EntityManager em, Object responseItem, Object query) Handle a query operation
boolean	isViableForEntityManager(javax.persistence.EntityManager em) Determine whether this provider should be used with this EntityManager
void	preHandleEntityManager(javax.persistence.EntityManager em) Perform some work before handling any operation on an EntityManager
void	setFilterEnablers(List<FilterEnabler> filterEnablers)
void	setOrder(int order) The order in which this provider should be executed.
boolean	shouldFilterOnFind(Class<?> entityClass) Whether or not Filter should be activated on a standard EntityManager.find(Class, Object)
boolean	shouldPerformFiltration(org.broadleafcommerce.common.web.BroadleafRequestContext context, javax.persistence.EntityManager em) Whether or not Filter should be activated based on the broadleaf request context.
boolean	shouldPerformFiltration(org.broadleafcommerce.common.web.BroadleafRequestContext context, org.hibernate.Session session) Whether or not Filter should be activated based on the broadleaf request context.

Methods inherited from interface org.springframework.core.Ordered

getOrder

Method Detail

getFilterEnablers

List<FilterEnabler> getFilterEnablers()

setFilterEnablers

void setFilterEnablers(List<FilterEnabler> filterEnablers)

enableFilters

void enableFilters(org.hibernate.Session session,
                   org.broadleafcommerce.common.web.BroadleafRequestContext context)

Activate Filter for a session using getFilterEnablers()

Parameters:

session - the Hibernate Session

context - the broadleaf request context

disableFilters

void disableFilters(org.hibernate.Session session,
                    org.broadleafcommerce.common.web.BroadleafRequestContext context)

Disable Filter for a session using @#getFilterEnablers()

Parameters:

session - the Hibernate Session

context - the broadleaf request context

shouldPerformFiltration

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

Whether or not Filter should be activated based on the broadleaf request context.

Parameters:

context - the broadleaf request context

Returns:

whether or not to activate Hibernate filters

shouldPerformFiltration

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

Whether or not Filter should be activated based on the broadleaf request context.

Parameters:

context - the broadleaf request context

Returns:

whether or not to activate Hibernate filters

shouldFilterOnFind

boolean shouldFilterOnFind(Class<?> entityClass)

Whether or not Filter should be activated on a standard EntityManager.find(Class, Object)

Parameters:

entityClass - the entity type

Returns:

whether or not to activate Hibernate filters

handlePersistence

EntityManagerInvocationProviderResponse handlePersistence(boolean shouldPerformAnyFilter,
                                                          Object proxy,
                                                          Method method,
                                                          Object entity,
                                                          javax.persistence.EntityManager em)

Handle any call to EntityManager.persist(Object), EntityManager.merge(Object) or EntityManager.remove(Object)

Parameters:

shouldPerformAnyFilter - should Hibernate filters be active at all

proxy - the proxied instance of EntityManager

method - the method on EntityManager being called

entity - the entity instance

em - the entity manager

Returns:

the response describing the result of the operation

handleQueryOperation

EntityManagerInvocationProviderResponse handleQueryOperation(boolean shouldPerformAnyFilter,
                                                             Object proxy,
                                                             Method method,
                                                             Object[] args,
                                                             javax.persistence.EntityManager em,
                                                             Object responseItem,
                                                             Object query)

Handle a query operation

Parameters:

shouldPerformAnyFilter - should Hibernate filters be active at all

proxy - the proxied instance of Query

method - the method on Query being called

args - the arguments provided to the method call on Query

em - the entity manager

responseItem - the result from any previous invocation of another invocation provider

query - the original, un-proxied Query instance

Returns:

the response describing the result of the operation

See Also:

Query

handleFindOperation

EntityManagerInvocationProviderResponse handleFindOperation(boolean shouldPerformAnyFilter,
                                                            Object proxy,
                                                            Method method,
                                                            Object[] args,
                                                            javax.persistence.EntityManager em,
                                                            Object responseItem)

Handle a find operation (EntityManager.find(Class, Object)

Parameters:

shouldPerformAnyFilter - should Hibernate filters be active at all

proxy - the proxied instance of EntityManager

method - the method on EntityManager being called

args - the arguments provided to the method call on Query

em - the entity manager

responseItem - the result from any previous invocation of another invocation provider

Returns:

the response describing the result of the operation

handleCriteriaOperation

EntityManagerInvocationProviderResponse handleCriteriaOperation(boolean shouldPerformAnyFilter,
                                                                Object proxy,
                                                                Method method,
                                                                Object[] args,
                                                                javax.persistence.EntityManager em,
                                                                Object responseItem,
                                                                org.hibernate.Criteria criteria)

Handle a criteria operation

Parameters:

shouldPerformAnyFilter - should Hibernate filters be active at all

proxy - the proxied instance of Criteria

method - the method on Criteria being called

args - the arguments provided to the method call on Query

em - the entity manager

responseItem - the result from any previous invocation of another invocation provider

criteria - the original, un-proxied Criteria instance

Returns:

the response describing the result of the operation

See Also:

Criteria

preHandleEntityManager

void preHandleEntityManager(javax.persistence.EntityManager em)

Perform some work before handling any operation on an EntityManager

Parameters:

em - the entity manager

setOrder

void setOrder(int order)

The order in which this provider should be executed. Providers are sorted and executed in order.

Parameters:

order - the execution order

isViableForEntityManager

boolean isViableForEntityManager(javax.persistence.EntityManager em)

Determine whether this provider should be used with this EntityManager

Parameters:

em -

Returns: