com.broadleafcommerce.tenant.service.extension

Class MultiTenantQueryExtensionHandler

java.lang.Object

org.broadleafcommerce.common.extension.AbstractExtensionHandler

com.broadleafcommerce.tenant.service.extension.MultiTenantQueryExtensionHandler

All Implemented Interfaces:

org.broadleafcommerce.common.extension.ExtensionHandler, org.broadleafcommerce.common.extension.QueryExtensionHandler

@Component(value="blMultiTenantQueryExtensionHandler")
public class MultiTenantQueryExtensionHandler
extends org.broadleafcommerce.common.extension.AbstractExtensionHandler
implements org.broadleafcommerce.common.extension.QueryExtensionHandler

Some entities (e.g. CustomField) must receive special treatment for multi-tenancy. Rather than the normal auto-filtering provided by the multi-tenant module, we will manually specify a retrieval based on all sites up the site hierarchy.

Author:

Jeff Fischer

Field Summary

Fields

Modifier and Type	Field and Description
protected MultiTenantAssetFolderUtil	assetFolderUtil
protected List<org.broadleafcommerce.common.extension.ExtensionManager<org.broadleafcommerce.common.extension.QueryExtensionHandler>>	extensionManagers
protected MultiTenantDao	multiTenantDao
protected MultiTenantSiteUtil	siteUtil
protected MultiTenantStaticAssetUtil	staticAssetUtil

Fields inherited from class org.broadleafcommerce.common.extension.AbstractExtensionHandler

enabled, priority

Constructor Summary

Constructors

Constructor and Description
MultiTenantQueryExtensionHandler()

Method Summary

Modifier and Type	Method and Description
org.broadleafcommerce.common.extension.ExtensionResultStatusType	breakdown(Class<?> type, String[] config)
int	getPriority()
void	init()
protected boolean	isQualified(Class<?> type, String[] config)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	refineOrder(Class<?> type, String[] config, javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.CriteriaQuery criteria, javax.persistence.criteria.Root root, List<javax.persistence.criteria.Order> sorts)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	refineResults(Class<?> type, String[] config, List queryResults, org.broadleafcommerce.common.extension.ExtensionResultHolder<List> response) Subclasses should override for custom, in-memory results filtering.
org.broadleafcommerce.common.extension.ExtensionResultStatusType	refineRetrieve(Class<?> type, String[] config, javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.CriteriaQuery criteria, javax.persistence.criteria.Root root, List<javax.persistence.criteria.Predicate> restrictions)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	setup(Class<?> type, String[] config)

Methods inherited from class org.broadleafcommerce.common.extension.AbstractExtensionHandler

isEnabled, setEnabled, setPriority

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.broadleafcommerce.common.extension.ExtensionHandler

isEnabled

Field Detail

extensionManagers

protected List<org.broadleafcommerce.common.extension.ExtensionManager<org.broadleafcommerce.common.extension.QueryExtensionHandler>> extensionManagers

siteUtil

protected MultiTenantSiteUtil siteUtil

staticAssetUtil

protected MultiTenantStaticAssetUtil staticAssetUtil

assetFolderUtil

protected MultiTenantAssetFolderUtil assetFolderUtil

multiTenantDao

protected MultiTenantDao multiTenantDao

Constructor Detail

MultiTenantQueryExtensionHandler

public MultiTenantQueryExtensionHandler()

Method Detail

init

@PostConstruct
public void init()

refineRetrieve

public org.broadleafcommerce.common.extension.ExtensionResultStatusType refineRetrieve(Class<?> type,
                                                                                       String[] config,
                                                                                       javax.persistence.criteria.CriteriaBuilder builder,
                                                                                       javax.persistence.criteria.CriteriaQuery criteria,
                                                                                       javax.persistence.criteria.Root root,
                                                                                       List<javax.persistence.criteria.Predicate> restrictions)

Specified by:

refineRetrieve in interface org.broadleafcommerce.common.extension.QueryExtensionHandler

refineOrder

public org.broadleafcommerce.common.extension.ExtensionResultStatusType refineOrder(Class<?> type,
                                                                                    String[] config,
                                                                                    javax.persistence.criteria.CriteriaBuilder builder,
                                                                                    javax.persistence.criteria.CriteriaQuery criteria,
                                                                                    javax.persistence.criteria.Root root,
                                                                                    List<javax.persistence.criteria.Order> sorts)

Specified by:

refineOrder in interface org.broadleafcommerce.common.extension.QueryExtensionHandler

refineResults

public org.broadleafcommerce.common.extension.ExtensionResultStatusType refineResults(Class<?> type,
                                                                                      String[] config,
                                                                                      List queryResults,
                                                                                      org.broadleafcommerce.common.extension.ExtensionResultHolder<List> response)

Subclasses should override for custom, in-memory results filtering.

Specified by:

refineResults in interface org.broadleafcommerce.common.extension.QueryExtensionHandler

Parameters:

config - config information

queryResults - the original query results

response - the container in which filtered query results are included

Returns:

the execution status

setup

public org.broadleafcommerce.common.extension.ExtensionResultStatusType setup(Class<?> type,
                                                                              String[] config)

Specified by:

setup in interface org.broadleafcommerce.common.extension.QueryExtensionHandler

breakdown

public org.broadleafcommerce.common.extension.ExtensionResultStatusType breakdown(Class<?> type,
                                                                                  String[] config)

Specified by:

breakdown in interface org.broadleafcommerce.common.extension.QueryExtensionHandler

isQualified

protected boolean isQualified(Class<?> type,
                              String[] config)

getPriority

public int getPriority()

Specified by:

getPriority in interface org.broadleafcommerce.common.extension.ExtensionHandler

Overrides:

getPriority in class org.broadleafcommerce.common.extension.AbstractExtensionHandler