com.broadleafcommerce.tenant.admin.service.module.extension

Class MultiTenantBasicPersistenceModuleExtensionHandler

java.lang.Object

org.broadleafcommerce.common.extension.AbstractExtensionHandler

org.broadleafcommerce.openadmin.server.service.persistence.module.extension.AbstractBasicPersistenceModuleExtensionHandler

com.broadleafcommerce.enterprise.workflow.admin.service.module.extension.WorkflowBasicPersistenceModuleExtensionHandler

com.broadleafcommerce.tenant.admin.service.module.extension.MultiTenantBasicPersistenceModuleExtensionHandler

All Implemented Interfaces:

org.broadleafcommerce.common.extension.ExtensionHandler, org.broadleafcommerce.openadmin.server.service.persistence.module.extension.BasicPersistenceModuleExtensionHandler

public class MultiTenantBasicPersistenceModuleExtensionHandler
extends com.broadleafcommerce.enterprise.workflow.admin.service.module.extension.WorkflowBasicPersistenceModuleExtensionHandler

Provides special sort behavior for multitenant installation (above and beyond what's already provided by WorkflowBasicPersistenceModuleExtensionHandler. Generally, this means taking into account catalog and/or site discriminators into queries related to sort column rebalancing. Also, different behavior is indicated when the sorting is taking place in a standard site, as opposed to a template site.

Author:

Jeff Fischer

Nested Class Summary

Nested classes/interfaces inherited from class com.broadleafcommerce.enterprise.workflow.admin.service.module.extension.WorkflowBasicPersistenceModuleExtensionHandler

com.broadleafcommerce.enterprise.workflow.admin.service.module.extension.WorkflowBasicPersistenceModuleExtensionHandler.SequenceValue

Field Summary

Fields

Modifier and Type	Field and Description
protected org.broadleafcommerce.common.util.DeployBehaviorUtil	deployBehaviorUtil
protected javax.persistence.EntityManager	em
static int	MT_PRIORITY

Fields inherited from class com.broadleafcommerce.enterprise.workflow.admin.service.module.extension.WorkflowBasicPersistenceModuleExtensionHandler

decimalIncrement, extensionManager, sandBoxHelper, sortRebalance, WORKFLOW_PRIORITY, workflowLogger

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

enabled, priority

Fields inherited from interface org.broadleafcommerce.openadmin.server.service.persistence.module.extension.BasicPersistenceModuleExtensionHandler

DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor and Description
MultiTenantBasicPersistenceModuleExtensionHandler()

Method Summary

Modifier and Type	Method and Description
protected void	appendMultiTenantInfo(org.broadleafcommerce.openadmin.dto.Entity entity, org.broadleafcommerce.common.web.BroadleafRequestContext context, StringBuilder sb) Add additional WHERE clause values related to catalog, profile or site.
protected StringBuilder	buildRebalanceWhereClause(org.broadleafcommerce.openadmin.dto.Entity entity, String foreignKeyColumnName, String foreignKeyColumnValue) Refine the rebalance WHERE clause to include multitenant related restrictions for catalog, profile and site.
protected StringBuilder	buildShouldRebalanceWhereClause(org.broadleafcommerce.openadmin.dto.Entity entity, String foreignKeyColumnName, String foreignKeyColumnValue, List<Long> up) Refine the should rebalance WHERE clause to include multitenant related restrictions for catalog, profile and site.
protected Class<?>	getForeignKeyClass(org.broadleafcommerce.openadmin.dto.ForeignKey foreignKey)
protected Long	getObjectId(org.broadleafcommerce.openadmin.dto.ForeignKey foreignKey, org.broadleafcommerce.openadmin.dto.Entity entity)
protected Object	getVal(org.broadleafcommerce.openadmin.dto.Entity entity, org.broadleafcommerce.openadmin.dto.ForeignKey foreignKey, Class<?> foreignKeyClass)
void	init()
protected boolean	isCurrentCatalog(Object val, org.broadleafcommerce.common.web.BroadleafRequestContext context)
protected boolean	isCurrentProfile(Object val, org.broadleafcommerce.common.web.BroadleafRequestContext context)
protected boolean	isCurrentSite(Object val, MultiTenantSite mtSite)
protected boolean	useDecimalRebalance(org.broadleafcommerce.openadmin.dto.Entity entity, org.broadleafcommerce.openadmin.dto.ForeignKey foreignKey) Determination of whether or not a sort column should use decimal or integer rebalancing is further complicated by hierarchical data in a multitenant context.
protected boolean	useIntegerRebalance(org.broadleafcommerce.openadmin.dto.Entity entity, org.broadleafcommerce.openadmin.dto.ForeignKey foreignKey, org.broadleafcommerce.common.web.BroadleafRequestContext context, MultiTenantSite mtSite)

Methods inherited from class com.broadleafcommerce.enterprise.workflow.admin.service.module.extension.WorkflowBasicPersistenceModuleExtensionHandler

calculateNewSequence, getSequenceValue, nextSequenceVal, rebalanceCollection, rebalanceForAdd, rebalanceForUpdate, shouldRebalance

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

getPriority, 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

getPriority, isEnabled

Field Detail

MT_PRIORITY

public static final int MT_PRIORITY

See Also:

Constant Field Values

em

protected javax.persistence.EntityManager em

deployBehaviorUtil

protected org.broadleafcommerce.common.util.DeployBehaviorUtil deployBehaviorUtil

Constructor Detail

MultiTenantBasicPersistenceModuleExtensionHandler

public MultiTenantBasicPersistenceModuleExtensionHandler()

Method Detail

init

@PostConstruct
public void init()

Overrides:

init in class com.broadleafcommerce.enterprise.workflow.admin.service.module.extension.WorkflowBasicPersistenceModuleExtensionHandler

buildRebalanceWhereClause

protected StringBuilder buildRebalanceWhereClause(org.broadleafcommerce.openadmin.dto.Entity entity,
                                                  String foreignKeyColumnName,
                                                  String foreignKeyColumnValue)

Refine the rebalance WHERE clause to include multitenant related restrictions for catalog, profile and site.

Overrides:

buildRebalanceWhereClause in class com.broadleafcommerce.enterprise.workflow.admin.service.module.extension.WorkflowBasicPersistenceModuleExtensionHandler

Parameters:

entity -

foreignKeyColumnName -

foreignKeyColumnValue -

Returns:

WHERE clause including MT related restrictions

buildShouldRebalanceWhereClause

protected StringBuilder buildShouldRebalanceWhereClause(org.broadleafcommerce.openadmin.dto.Entity entity,
                                                        String foreignKeyColumnName,
                                                        String foreignKeyColumnValue,
                                                        List<Long> up)

Refine the should rebalance WHERE clause to include multitenant related restrictions for catalog, profile and site.

Overrides:

buildShouldRebalanceWhereClause in class com.broadleafcommerce.enterprise.workflow.admin.service.module.extension.WorkflowBasicPersistenceModuleExtensionHandler

Parameters:

entity -

foreignKeyColumnName -

foreignKeyColumnValue -

up -

Returns:

WHERE clause including MT relate restrictions

useDecimalRebalance

protected boolean useDecimalRebalance(org.broadleafcommerce.openadmin.dto.Entity entity,
                                      org.broadleafcommerce.openadmin.dto.ForeignKey foreignKey)

Determination of whether or not a sort column should use decimal or integer rebalancing is further complicated by hierarchical data in a multitenant context. When the context dictates that the current editing site is a template site, or is a standard site that does not use production sandbox mode (i.e. no hierarchical data - each site entirely owns its whole catalog), then we can use integer rebalancing in production. Template sites, when editing, will be dealing with a synced copy (or their own copy), so in this sense, they wholly own all the members of the sorted collection. Also, if the standard site happens to own the foreign key entity to which the sorted collection is associated, then we can also rebalance using integers in production, since the standard site wholly owns the collection. Otherwise, whether we're in a standard site override, or a sandbox, we'll need to use decimal values for the rebalance.

Overrides:

useDecimalRebalance in class com.broadleafcommerce.enterprise.workflow.admin.service.module.extension.WorkflowBasicPersistenceModuleExtensionHandler

Parameters:

entity -

foreignKey -

Returns:

Whether a sort column should use decimals for rebalancing

See Also:

WorkflowBasicPersistenceModuleExtensionHandler.useDecimalRebalance(Entity, ForeignKey)

useIntegerRebalance

protected boolean useIntegerRebalance(org.broadleafcommerce.openadmin.dto.Entity entity,
                                      org.broadleafcommerce.openadmin.dto.ForeignKey foreignKey,
                                      org.broadleafcommerce.common.web.BroadleafRequestContext context,
                                      MultiTenantSite mtSite)

getForeignKeyClass

protected Class<?> getForeignKeyClass(org.broadleafcommerce.openadmin.dto.ForeignKey foreignKey)

getVal

protected Object getVal(org.broadleafcommerce.openadmin.dto.Entity entity,
                        org.broadleafcommerce.openadmin.dto.ForeignKey foreignKey,
                        Class<?> foreignKeyClass)

getObjectId

protected Long getObjectId(org.broadleafcommerce.openadmin.dto.ForeignKey foreignKey,
                           org.broadleafcommerce.openadmin.dto.Entity entity)

isCurrentCatalog

protected boolean isCurrentCatalog(Object val,
                                   org.broadleafcommerce.common.web.BroadleafRequestContext context)

isCurrentProfile

protected boolean isCurrentProfile(Object val,
                                   org.broadleafcommerce.common.web.BroadleafRequestContext context)

isCurrentSite

protected boolean isCurrentSite(Object val,
                                MultiTenantSite mtSite)

appendMultiTenantInfo

protected void appendMultiTenantInfo(org.broadleafcommerce.openadmin.dto.Entity entity,
                                     org.broadleafcommerce.common.web.BroadleafRequestContext context,
                                     StringBuilder sb)

Add additional WHERE clause values related to catalog, profile or site. This will serve to refine results for multitenant usage.

Parameters:

entity -

context -

sb -