com.broadleafcommerce.tenant.admin.handler

Class MultiTenantSiteCustomPersistenceHandler

java.lang.Object

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

com.broadleafcommerce.tenant.admin.handler.MultiTenantSiteCustomPersistenceHandler

All Implemented Interfaces:

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

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

Author:

Jeff Fischer, bpolster

Field Summary

Fields

Modifier and Type	Field and Description
protected MultiTenantService	multiTenantService
protected ProfileSitePropagationEventConsumer	profileSitePropagationEventConsumer
protected org.broadleafcommerce.common.site.dao.SiteDao	siteDao
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
MultiTenantSiteCustomPersistenceHandler()

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 void	addAdditionalFields(Map<org.broadleafcommerce.openadmin.dto.MergedPropertyType,Map<String,org.broadleafcommerce.openadmin.dto.FieldMetadata>> allMergedProperties)
protected void	addSiteTypeProperty(org.broadleafcommerce.openadmin.dto.Entity entity, SiteType siteType) Adds the SiteType which is one of SiteType.PROFILE, SiteType.STANDARD, or SiteType.TEMPLATE
protected org.broadleafcommerce.openadmin.server.service.persistence.module.criteria.FilterMapping	buildBaseProfileSelfAssignmentFilterMapping(org.broadleafcommerce.openadmin.dto.SectionCrumb crumb) Filter restriction such that a Profile cannot select itself as the Base Profile.
protected org.broadleafcommerce.openadmin.server.service.persistence.module.criteria.FilterMapping	buildExcludeProfileSitesFilterMapping()
protected org.broadleafcommerce.openadmin.server.service.persistence.module.criteria.FilterMapping	buildFilterMappingForSiteList(org.broadleafcommerce.common.site.domain.Site site, List<Long> includeIds)
protected org.broadleafcommerce.openadmin.server.service.persistence.module.criteria.FilterMapping	buildFilterMappingFromSite(org.broadleafcommerce.common.site.domain.Site site, Long thisSiteId)
protected org.broadleafcommerce.openadmin.server.service.persistence.module.criteria.FilterMapping	buildFinishedSiteFilterMapping()
protected org.broadleafcommerce.openadmin.server.service.persistence.module.criteria.FilterMapping	buildOwningOrAssignedSiteFilterMapping(org.broadleafcommerce.common.site.domain.Site site)
protected org.broadleafcommerce.openadmin.server.service.persistence.module.criteria.FilterMapping	buildOwningSiteFilterMapping(org.broadleafcommerce.common.site.domain.Site site) Filter to select catalogs owned by the current site.
protected org.broadleafcommerce.openadmin.server.service.persistence.module.criteria.FilterMapping	buildSiteTypeFilterMapping(String siteType) Filter to select based on site type.
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	canHandleRemove(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
Boolean	canHandleUpdate(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
protected org.broadleafcommerce.common.site.domain.Site	createSiteInstance(org.broadleafcommerce.openadmin.dto.Entity entity)
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 org.broadleafcommerce.openadmin.dto.BasicFieldMetadata	getBaseProfileRequiredField()
protected org.broadleafcommerce.common.site.domain.Site	getCurrentSite()
protected SiteType	getSiteType(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePkg) Controllers that front this CustomPersistenceHandler need to pass customCriteria indicating the SiteType.
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	isAssetProfileToOneLookup(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
protected boolean	isBaseProfileToOneLookup(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
protected boolean	isFromRootSite(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
protected boolean	isFromSiteField(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
protected boolean	isSwitchToSiteLookup(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)
protected boolean	profileAncestorsIncludeSite(org.broadleafcommerce.common.site.domain.Site profile, Long siteId)
void	remove(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage, org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao, org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper)
protected void	removeSite(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage, org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao dynamicEntityDao, org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper helper, org.broadleafcommerce.openadmin.dto.Entity entity)
protected void	removeSiteProfileXref(org.broadleafcommerce.openadmin.dto.Entity entity)
protected Map<String,org.broadleafcommerce.openadmin.dto.FieldMetadata>	removeUnusedProfileProperties(Map<String,org.broadleafcommerce.openadmin.dto.FieldMetadata> adminProperties)
protected void	sendPropagationEvent(Long fromSiteId, Long toSiteId)
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	updateFriendlyName(org.broadleafcommerce.openadmin.dto.ClassMetadata cmd, SiteType siteType) Updates the name of the top level entity which changes depending on the context (e.g.
protected void	updateProperties(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage, org.broadleafcommerce.openadmin.dto.ClassMetadata mergedMetadata, SiteType siteType) Updates the name of the top level entity which changes depending on the context (e.g.
protected void	updatePropertyFriendlyName(org.broadleafcommerce.openadmin.dto.Property property, String friendlyName) Update the friendlyName for a property

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

getClassForName, getMetadata, getOrder, getPolymorphicClasses, getResultSet, isAdornedListOperation, isAssignableFrom, isBasicOperation, isMapOperation, meetsCustomCriteria, willHandleSecurity

Methods inherited from class java.lang.Object

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

Field Detail

multiTenantService

protected MultiTenantService multiTenantService

siteDao

protected org.broadleafcommerce.common.site.dao.SiteDao siteDao

siteService

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

systemEventSender

protected com.broadleafcommerce.jobsevents.service.SystemEventSender systemEventSender

profileSitePropagationEventConsumer

protected ProfileSitePropagationEventConsumer profileSitePropagationEventConsumer

Constructor Detail

MultiTenantSiteCustomPersistenceHandler

public MultiTenantSiteCustomPersistenceHandler()

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

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

canHandleRemove

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

Specified by:

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

Overrides:

canHandleRemove 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

buildSiteTypeFilterMapping

protected org.broadleafcommerce.openadmin.server.service.persistence.module.criteria.FilterMapping buildSiteTypeFilterMapping(String siteType)

Filter to select based on site type.

Parameters:

site -

Returns:

isBaseProfileToOneLookup

protected boolean isBaseProfileToOneLookup(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)

isAssetProfileToOneLookup

protected boolean isAssetProfileToOneLookup(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)

isFromSiteField

protected boolean isFromSiteField(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)

isFromRootSite

protected boolean isFromRootSite(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)

isSwitchToSiteLookup

protected boolean isSwitchToSiteLookup(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage)

getSiteType

protected SiteType getSiteType(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePkg)

Controllers that front this CustomPersistenceHandler need to pass customCriteria indicating the SiteType.

Parameters:

persistencePackage -

Returns:

buildFilterMappingFromSite

protected org.broadleafcommerce.openadmin.server.service.persistence.module.criteria.FilterMapping buildFilterMappingFromSite(org.broadleafcommerce.common.site.domain.Site site,
                                                                                                                              Long thisSiteId)

profileAncestorsIncludeSite

protected boolean profileAncestorsIncludeSite(org.broadleafcommerce.common.site.domain.Site profile,
                                              Long siteId)

buildOwningSiteFilterMapping

protected org.broadleafcommerce.openadmin.server.service.persistence.module.criteria.FilterMapping buildOwningSiteFilterMapping(org.broadleafcommerce.common.site.domain.Site site)

Filter to select catalogs owned by the current site.

Parameters:

site -

Returns:

buildExcludeProfileSitesFilterMapping

protected org.broadleafcommerce.openadmin.server.service.persistence.module.criteria.FilterMapping buildExcludeProfileSitesFilterMapping()

buildOwningOrAssignedSiteFilterMapping

protected org.broadleafcommerce.openadmin.server.service.persistence.module.criteria.FilterMapping buildOwningOrAssignedSiteFilterMapping(org.broadleafcommerce.common.site.domain.Site site)

buildBaseProfileSelfAssignmentFilterMapping

protected org.broadleafcommerce.openadmin.server.service.persistence.module.criteria.FilterMapping buildBaseProfileSelfAssignmentFilterMapping(org.broadleafcommerce.openadmin.dto.SectionCrumb crumb)

Filter restriction such that a Profile cannot select itself as the Base Profile.

Parameters:

crumb -

buildFilterMappingForSiteList

protected org.broadleafcommerce.openadmin.server.service.persistence.module.criteria.FilterMapping buildFilterMappingForSiteList(org.broadleafcommerce.common.site.domain.Site site,
                                                                                                                                 List<Long> includeIds)

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

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

addAdditionalFields

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

getBaseProfileRequiredField

protected org.broadleafcommerce.openadmin.dto.BasicFieldMetadata getBaseProfileRequiredField()

remove

public void remove(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:

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

Overrides:

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

Throws:

org.broadleafcommerce.common.exception.ServiceException

buildFinishedSiteFilterMapping

protected org.broadleafcommerce.openadmin.server.service.persistence.module.criteria.FilterMapping buildFinishedSiteFilterMapping()

removeSite

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

Throws:

org.broadleafcommerce.common.exception.ServiceException

removeSiteProfileXref

protected void removeSiteProfileXref(org.broadleafcommerce.openadmin.dto.Entity entity)
                              throws org.broadleafcommerce.common.exception.ServiceException

Throws:

org.broadleafcommerce.common.exception.ServiceException

updateProperties

protected void updateProperties(org.broadleafcommerce.openadmin.dto.PersistencePackage persistencePackage,
                                org.broadleafcommerce.openadmin.dto.ClassMetadata mergedMetadata,
                                SiteType siteType)

Updates the name of the top level entity which changes depending on the context (e.g. Template Site, Site, or Profile)

updatePropertyFriendlyName

protected void updatePropertyFriendlyName(org.broadleafcommerce.openadmin.dto.Property property,
                                          String friendlyName)

Update the friendlyName for a property

Parameters:

property -

friendlyName -

updateFriendlyName

protected void updateFriendlyName(org.broadleafcommerce.openadmin.dto.ClassMetadata cmd,
                                  SiteType siteType)

Updates the name of the top level entity which changes depending on the context (e.g. Template Site, Site, or Profile)

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

addSiteTypeProperty

protected void addSiteTypeProperty(org.broadleafcommerce.openadmin.dto.Entity entity,
                                   SiteType siteType)

Adds the SiteType which is one of SiteType.PROFILE, SiteType.STANDARD, or SiteType.TEMPLATE

Parameters:

entity -

siteType -

createSiteInstance

protected org.broadleafcommerce.common.site.domain.Site createSiteInstance(org.broadleafcommerce.openadmin.dto.Entity entity)
                                                                    throws org.broadleafcommerce.common.exception.ServiceException

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

removeUnusedProfileProperties

protected Map<String,org.broadleafcommerce.openadmin.dto.FieldMetadata> removeUnusedProfileProperties(Map<String,org.broadleafcommerce.openadmin.dto.FieldMetadata> adminProperties)

sendPropagationEvent

protected void sendPropagationEvent(Long fromSiteId,
                                    Long toSiteId)

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

getCurrentSite

protected org.broadleafcommerce.common.site.domain.Site getCurrentSite()