com.broadleafcommerce.tenant.admin.handler

Class MultiTenantTemplateContextSiteCatalogXrefCustomPersistenceHandler

java.lang.Object

org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandlerAdapter

com.broadleafcommerce.tenant.admin.handler.MultiTenantTemplateContextSiteCatalogXrefCustomPersistenceHandler

All Implemented Interfaces:

org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandler, org.springframework.core.Ordered

public class MultiTenantTemplateContextSiteCatalogXrefCustomPersistenceHandler
extends org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandlerAdapter

Handle SiteCatalogXref entries for standard site configuration. This is primarily to handle the creation of a sparse, implicit catalog for assignment of a catalog in CUSTOMIZABLE mode. Or, to handle the creation of a fully synced, implicit catalog for assignment of a catalog in SYNCED_COPY mode. This handler only applies to template sites configuring a standard site.

Author:

Jeff Fischer

Field Summary

Fields

Modifier and Type	Field and Description
protected com.broadleafcommerce.jobsevents.service.consumer.CacheInvalidationHelper	cacheInvalidationHelper
protected DerivedCatalogPropagationEventConsumer	derivedCatalogPropagationEventConsumer
protected static org.apache.commons.logging.Log	LOG
protected MultiTenantDao	multiTenantDao
protected MultiTenantService	multiTenantService
protected MultiTenantSiteUtil	multiTenantSiteUtil
static int	ORDER
protected org.broadleafcommerce.common.site.service.SiteService	siteService
protected com.broadleafcommerce.jobsevents.service.SystemEventSender	systemEventSender

Fields inherited from interface org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandler

DEFAULT_ORDER

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
MultiTenantTemplateContextSiteCatalogXrefCustomPersistenceHandler()

Method Summary

Modifier and Type	Method and Description
org.broadleafcommerce.openadmin.dto.Entity	add(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage, org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao, org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper)
protected org.broadleafcommerce.openadmin.dto.Entity	addReferenceCatalog(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage, org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao, org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper)
protected org.broadleafcommerce.openadmin.dto.Entity	addSparseImplicitCatalog(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage, org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao, org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper)
protected org.broadleafcommerce.openadmin.dto.Entity	addSyncedImplicitCatalog(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage, org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao, org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper)
protected void	assignInheritedReferenceCatalogs(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage, org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao, org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper, org.broadleafcommerce.common.site.domain.Site assignedSite, org.broadleafcommerce.common.site.domain.Catalog assignedCatalog) This method is responsible for assigning any reference catalogs inherited from the given assigned catalog to the assigned site.
protected void	attachAbbreviationMetadata(Map<org.broadleafcommerce.openadmin.dto.MergedPropertyType,Map<String,org.broadleafcommerce.openadmin.dto.FieldMetadata>> allMergedProperties)
protected void	attachAbbreviationProperty(org.broadleafcommerce.openadmin.dto.DynamicResultSet resultSet)
protected org.broadleafcommerce.openadmin.dto.Entity	buildPayload(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage, org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao, org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper, org.broadleafcommerce.common.site.domain.SiteCatalogXref xref)
Boolean	canHandleAdd(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
Boolean	canHandleFetch(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
Boolean	canHandleInspect(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
Boolean	canHandleUpdate(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
org.broadleafcommerce.openadmin.dto.DynamicResultSet	fetch(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage, org.broadleafcommerce.openadmin.dto.CriteriaTransferObject cto, org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao, org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper)
protected void	filterFieldsByOperationType(org.broadleafcommerce.openadmin.dto.PersistencePackage pp, Map<org.broadleafcommerce.openadmin.dto.MergedPropertyType,Map<String,org.broadleafcommerce.openadmin.dto.FieldMetadata>> allMergedProperties)
protected void	filterFieldsBySiteType(org.broadleafcommerce.openadmin.dto.PersistencePackage pp, Map<org.broadleafcommerce.openadmin.dto.MergedPropertyType,Map<String,org.broadleafcommerce.openadmin.dto.FieldMetadata>> allMergedProperties)
protected String	findCatalogAbbreviation(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage, org.broadleafcommerce.common.site.domain.Catalog assignedCatalog, org.broadleafcommerce.common.site.domain.Site assignedSite)
int	getOrder()
org.broadleafcommerce.openadmin.dto.DynamicResultSet	inspect(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage, org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao, org.broadleafcommerce.openadmin.server.service.persistence.module.InspectHelper helper)
protected Boolean	isAssignedCatalog(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
protected Boolean	isAssignedCatalogInspect(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
protected Boolean	isSiteCatalogFetch(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
protected Boolean	isStandardSite(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage) Confirm the persistence package is assigning an xref for a standard site and the current context site is the parent of that site.
protected Boolean	isTemplateSite()
protected boolean	referenceCatalogNotAssigned(org.broadleafcommerce.common.site.domain.Site assignedSite, org.broadleafcommerce.common.site.domain.Catalog referenceCatalog) Verifies that the catalog is not already assigned to the site as a REFERENCE catalog.
protected void	sendManagedCatalogsInvalidationEvent(org.broadleafcommerce.common.site.domain.Site site)
protected void	sendPropagationEvent(CatalogDerivedCatalogXref xref, org.broadleafcommerce.common.site.domain.SiteCatalogXref siteCatalogXref)
org.broadleafcommerce.openadmin.dto.Entity	update(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage, org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao, org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper)
protected void	validate(Serializable populatedInstance, org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage, org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper)

Methods inherited from class org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandlerAdapter

canHandleRemove, getClassForName, getMetadata, getPolymorphicClasses, getResultSet, isAdornedListOperation, isAssignableFrom, isBasicOperation, isMapOperation, meetsCustomCriteria, remove, willHandleSecurity

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

LOG

protected static final org.apache.commons.logging.Log LOG

siteService

protected org.broadleafcommerce.common.site.service.SiteService siteService

multiTenantService

protected MultiTenantService multiTenantService

systemEventSender

protected com.broadleafcommerce.jobsevents.service.SystemEventSender systemEventSender

derivedCatalogPropagationEventConsumer

protected DerivedCatalogPropagationEventConsumer derivedCatalogPropagationEventConsumer

cacheInvalidationHelper

protected com.broadleafcommerce.jobsevents.service.consumer.CacheInvalidationHelper cacheInvalidationHelper

multiTenantDao

protected MultiTenantDao multiTenantDao

multiTenantSiteUtil

protected MultiTenantSiteUtil multiTenantSiteUtil

Constructor Detail

MultiTenantTemplateContextSiteCatalogXrefCustomPersistenceHandler

public MultiTenantTemplateContextSiteCatalogXrefCustomPersistenceHandler()

Method Detail

canHandleInspect

public Boolean canHandleInspect(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)

Specified by:

canHandleInspect in interface org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandler

Overrides:

canHandleInspect in class org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandlerAdapter

canHandleAdd

public Boolean canHandleAdd(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)

Specified by:

canHandleAdd in interface org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandler

Overrides:

canHandleAdd in class org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandlerAdapter

canHandleUpdate

public Boolean canHandleUpdate(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)

Specified by:

canHandleUpdate in interface org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandler

Overrides:

canHandleUpdate in class org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandlerAdapter

canHandleFetch

public Boolean canHandleFetch(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)

Specified by:

canHandleFetch in interface org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandler

Overrides:

canHandleFetch in class org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandlerAdapter

inspect

public org.broadleafcommerce.openadmin.dto.DynamicResultSet inspect(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage,
                                                                    org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao,
                                                                    org.broadleafcommerce.openadmin.server.service.persistence.module.InspectHelper helper)
                                                             throws org.broadleafcommerce.common.exception.ServiceException

Specified by:

inspect in interface org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandler

Overrides:

inspect in class org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandlerAdapter

Throws:

org.broadleafcommerce.common.exception.ServiceException

fetch

public org.broadleafcommerce.openadmin.dto.DynamicResultSet fetch(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage,
                                                                  org.broadleafcommerce.openadmin.dto.CriteriaTransferObject cto,
                                                                  org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao,
                                                                  org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper)
                                                           throws org.broadleafcommerce.common.exception.ServiceException

Specified by:

fetch in interface org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandler

Overrides:

fetch in class org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandlerAdapter

Throws:

org.broadleafcommerce.common.exception.ServiceException

add

public org.broadleafcommerce.openadmin.dto.Entity add(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage,
                                                      org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao,
                                                      org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper)
                                               throws org.broadleafcommerce.common.exception.ServiceException

Specified by:

add in interface org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandler

Overrides:

add in class org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandlerAdapter

Throws:

org.broadleafcommerce.common.exception.ServiceException

update

public org.broadleafcommerce.openadmin.dto.Entity update(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage,
                                                         org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao,
                                                         org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper)
                                                  throws org.broadleafcommerce.common.exception.ServiceException

Specified by:

update in interface org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandler

Overrides:

update in class org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandlerAdapter

Throws:

org.broadleafcommerce.common.exception.ServiceException

attachAbbreviationProperty

protected void attachAbbreviationProperty(org.broadleafcommerce.openadmin.dto.DynamicResultSet resultSet)

attachAbbreviationMetadata

protected void attachAbbreviationMetadata(Map<org.broadleafcommerce.openadmin.dto.MergedPropertyType,Map<String,org.broadleafcommerce.openadmin.dto.FieldMetadata>> allMergedProperties)

filterFieldsByOperationType

protected void filterFieldsByOperationType(org.broadleafcommerce.openadmin.dto.PersistencePackage pp,
                                           Map<org.broadleafcommerce.openadmin.dto.MergedPropertyType,Map<String,org.broadleafcommerce.openadmin.dto.FieldMetadata>> allMergedProperties)

filterFieldsBySiteType

protected void filterFieldsBySiteType(org.broadleafcommerce.openadmin.dto.PersistencePackage pp,
                                      Map<org.broadleafcommerce.openadmin.dto.MergedPropertyType,Map<String,org.broadleafcommerce.openadmin.dto.FieldMetadata>> allMergedProperties)

isStandardSite

protected Boolean isStandardSite(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)

Confirm the persistence package is assigning an xref for a standard site and the current context site is the parent of that site. We should only be working with standard sites and we should not be manipulating site configuration for a site not owned by this context.

Parameters:

persistencePackage -

Returns:

isTemplateSite

protected Boolean isTemplateSite()

isAssignedCatalog

protected Boolean isAssignedCatalog(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)

isAssignedCatalogInspect

protected Boolean isAssignedCatalogInspect(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)

isSiteCatalogFetch

protected Boolean isSiteCatalogFetch(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)

addSyncedImplicitCatalog

protected org.broadleafcommerce.openadmin.dto.Entity addSyncedImplicitCatalog(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage,
                                                                              org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao,
                                                                              org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper)
                                                                       throws org.broadleafcommerce.common.exception.ServiceException

Throws:

org.broadleafcommerce.common.exception.ServiceException

addSparseImplicitCatalog

protected org.broadleafcommerce.openadmin.dto.Entity addSparseImplicitCatalog(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage,
                                                                              org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao,
                                                                              org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper)
                                                                       throws org.broadleafcommerce.common.exception.ServiceException

Throws:

org.broadleafcommerce.common.exception.ServiceException

addReferenceCatalog

protected org.broadleafcommerce.openadmin.dto.Entity addReferenceCatalog(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage,
                                                                         org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao,
                                                                         org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper)
                                                                  throws org.broadleafcommerce.openadmin.server.service.ValidationException

Throws:

org.broadleafcommerce.openadmin.server.service.ValidationException

assignInheritedReferenceCatalogs

protected void assignInheritedReferenceCatalogs(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage,
                                                org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao,
                                                org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper,
                                                org.broadleafcommerce.common.site.domain.Site assignedSite,
                                                org.broadleafcommerce.common.site.domain.Catalog assignedCatalog)
                                         throws org.broadleafcommerce.openadmin.server.service.ValidationException

This method is responsible for assigning any reference catalogs inherited from the given assigned catalog to the assigned site. This ensures that a site can have read-only access to the any catalogs the assigned catalog is dependent upon.

Parameters:

persistencePackage -

dynamicEntityDao -

helper -

assignedSite -

assignedCatalog -

Throws:

org.broadleafcommerce.openadmin.server.service.ValidationException

referenceCatalogNotAssigned

protected boolean referenceCatalogNotAssigned(org.broadleafcommerce.common.site.domain.Site assignedSite,
                                              org.broadleafcommerce.common.site.domain.Catalog referenceCatalog)

Verifies that the catalog is not already assigned to the site as a REFERENCE catalog. This is used by assignInheritedReferenceCatalogs(PersistencePackage, DynamicEntityDao, RecordHelper, Site, Catalog) to ensure that we don't unnecessarily duplicate a reference.

Parameters:

assignedSite -

referenceCatalog -

Returns:

whether the catalog is assigned as a reference to the site

buildPayload

protected org.broadleafcommerce.openadmin.dto.Entity buildPayload(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage,
                                                                  org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao,
                                                                  org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper,
                                                                  org.broadleafcommerce.common.site.domain.SiteCatalogXref xref)

sendPropagationEvent

protected void sendPropagationEvent(CatalogDerivedCatalogXref xref,
                                    org.broadleafcommerce.common.site.domain.SiteCatalogXref siteCatalogXref)

validate

protected void validate(Serializable populatedInstance,
                        org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage,
                        org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper)
                 throws org.broadleafcommerce.openadmin.server.service.ValidationException

Throws:

org.broadleafcommerce.openadmin.server.service.ValidationException

sendManagedCatalogsInvalidationEvent

protected void sendManagedCatalogsInvalidationEvent(org.broadleafcommerce.common.site.domain.Site site)

findCatalogAbbreviation

protected String findCatalogAbbreviation(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage,
                                         org.broadleafcommerce.common.site.domain.Catalog assignedCatalog,
                                         org.broadleafcommerce.common.site.domain.Site assignedSite)

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

Overrides:

getOrder in class org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandlerAdapter