com.broadleafcommerce.enterprise.common.persistence.entitymanager

Class EntityManagerInvocationProviderAdapter

java.lang.Object

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

All Implemented Interfaces:

EntityManagerInvocationProvider, org.springframework.core.Ordered

public class EntityManagerInvocationProviderAdapter
extends Object
implements EntityManagerInvocationProvider

Adapter class for EntityManagerInvocationProvider Subclasses can extend for easier implementation.

Author:

Jeff Fischer

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
EntityManagerInvocationProviderAdapter()

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 EntityManagerInvocationProvider.getFilterEnablers()
List<FilterEnabler>	getFilterEnablers()
int	getOrder()
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 class java.lang.Object

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

Constructor Detail

EntityManagerInvocationProviderAdapter

public EntityManagerInvocationProviderAdapter()

Method Detail

disableFilters

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

Description copied from interface: EntityManagerInvocationProvider

Disable Filter for a session using @#getFilterEnablers()

Specified by:

disableFilters in interface EntityManagerInvocationProvider

Parameters:

session - the Hibernate Session

context - the broadleaf request context

getFilterEnablers

public List<FilterEnabler> getFilterEnablers()

Specified by:

getFilterEnablers in interface EntityManagerInvocationProvider

setFilterEnablers

public void setFilterEnablers(List<FilterEnabler> filterEnablers)

Specified by:

setFilterEnablers in interface EntityManagerInvocationProvider

enableFilters

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

Description copied from interface: EntityManagerInvocationProvider

Activate Filter for a session using EntityManagerInvocationProvider.getFilterEnablers()

Specified by:

enableFilters in interface EntityManagerInvocationProvider

Parameters:

session - the Hibernate Session

context - the broadleaf request context

shouldPerformFiltration

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

Description copied from interface: EntityManagerInvocationProvider

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

Specified by:

shouldPerformFiltration in interface EntityManagerInvocationProvider

Parameters:

context - the broadleaf request context

Returns:

whether or not to activate Hibernate filters

shouldPerformFiltration

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

Description copied from interface: EntityManagerInvocationProvider

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

Specified by:

shouldPerformFiltration in interface EntityManagerInvocationProvider

Parameters:

context - the broadleaf request context

Returns:

whether or not to activate Hibernate filters

shouldFilterOnFind

public boolean shouldFilterOnFind(Class<?> entityClass)

Description copied from interface: EntityManagerInvocationProvider

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

Specified by:

shouldFilterOnFind in interface EntityManagerInvocationProvider

Parameters:

entityClass - the entity type

Returns:

whether or not to activate Hibernate filters

handlePersistence

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

Description copied from interface: EntityManagerInvocationProvider

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

Specified by:

handlePersistence in interface EntityManagerInvocationProvider

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

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

Description copied from interface: EntityManagerInvocationProvider

Handle a query operation

Specified by:

handleQueryOperation in interface EntityManagerInvocationProvider

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

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

Description copied from interface: EntityManagerInvocationProvider

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

Specified by:

handleFindOperation in interface EntityManagerInvocationProvider

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

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

Description copied from interface: EntityManagerInvocationProvider

Handle a criteria operation

Specified by:

handleCriteriaOperation in interface EntityManagerInvocationProvider

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

public void preHandleEntityManager(javax.persistence.EntityManager em)

Description copied from interface: EntityManagerInvocationProvider

Perform some work before handling any operation on an EntityManager

Specified by:

preHandleEntityManager in interface EntityManagerInvocationProvider

Parameters:

em - the entity manager

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

setOrder

public void setOrder(int order)

Description copied from interface: EntityManagerInvocationProvider

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

Specified by:

setOrder in interface EntityManagerInvocationProvider

Parameters:

order - the execution order

isViableForEntityManager

public boolean isViableForEntityManager(javax.persistence.EntityManager em)

Description copied from interface: EntityManagerInvocationProvider

Determine whether this provider should be used with this EntityManager

Specified by:

isViableForEntityManager in interface EntityManagerInvocationProvider

Returns: