com.broadleafcommerce.tenant.dao

Class MultiTenantDaoImpl

java.lang.Object

com.broadleafcommerce.tenant.dao.MultiTenantDaoImpl

All Implemented Interfaces:

MultiTenantDao

@Repository(value="blMultiTenantDao")
public class MultiTenantDaoImpl
extends Object
implements MultiTenantDao

Author:

Jeff Fischer

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.persistence.EntityManager	em

Constructor Summary

Constructors

Constructor and Description
MultiTenantDaoImpl()

Method Summary

Modifier and Type	Method and Description
protected void	applyParameterizedAssociatedSubqueryRestrictions(org.broadleafcommerce.common.site.domain.Site currentSite, javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.Subquery<Long> subquery, javax.persistence.criteria.Root<org.broadleafcommerce.common.site.domain.SiteCatalogXrefImpl> siteCatalogRoot, boolean alwaysAllowAdminStatus)
void	completeParameterizedAssociatedCatalogSubQuery(javax.persistence.Query query, org.broadleafcommerce.common.site.domain.Site currentSite) Set the currentSite parameter on the catalog sub query.
Long	countAllManagedSites(Long parentSiteId)
List<org.broadleafcommerce.common.site.domain.Catalog>	findAllCatalogs()
List<org.broadleafcommerce.common.site.domain.Catalog>	findAllCatalogs(boolean excludeArchived)
List<org.broadleafcommerce.common.site.domain.Site>	findAllManagedProfiles(Long profileId) Find all standard sites whose base profile matches the passed in id
List<org.broadleafcommerce.common.site.domain.Site>	findAllManagedSites(Long parentSiteId) Find any standard sites whose parent matches the passed in id
List<org.broadleafcommerce.common.site.domain.Site>	findAllManagedSites(Long parentSiteId, Integer limit, Integer offset) Paged version of MultiTenantDao.findAllManagedSites(Long)
List<org.broadleafcommerce.common.site.domain.Catalog>	findAllStandardSiteCatalogs()
List<MultiTenantSite>	findAllStandardSites() Finds all standard sites
List<org.broadleafcommerce.common.site.domain.SiteCatalogXref>	findCatalogAssociationsById(Long siteId, Long catalogId) Find the association with the specific catalog id
List<org.broadleafcommerce.common.site.domain.SiteCatalogXref>	findCatalogAssociationsByName(Long siteId, String catalogName) Find the association with the specific catalog name
org.broadleafcommerce.common.site.domain.Catalog	findCatalogById(Long catalogId) Find Catalog by Id
List<CatalogDerivedCatalogXref>	findCatalogXrefsForCatalog(org.broadleafcommerce.common.site.domain.Catalog catalog) Find CatalogDerivedCatalogXref for the passed in catalog.
List<org.broadleafcommerce.common.site.domain.SiteCatalogXref>	findCatalogXrefsForSite(org.broadleafcommerce.common.site.domain.Site site) Find SiteCatalogXref for the passed in site.
List<Long>	findDefaultCatalogIdsByAssignedCatalogId(Long assignedCatalogId) Find the default catalogs for sites that are assigned the given catalog.
List<org.broadleafcommerce.common.site.domain.Site>	findDerivedSitesFromCatalogs(List<Long> parentCatalogs) Find Site instances whose catalogs have this catalog as a parent.
List<org.broadleafcommerce.common.site.domain.Site>	findDerivedSitesFromProfiles(List<Long> parentProfiles) Find Site instances whose profile have this profile as a parent.
List<MultiTenantSite>	findManagedProfileSites(Long parentSiteId) Find any profile sites whose parent matches the passed in id
org.broadleafcommerce.common.site.domain.Catalog	findOwnedCatalog(Long siteId, Long catalogId) If the candidate catalog is owned by the current site, return it.
List<Long>	findSiteCatalogIdsByAssignedCatalogId(Long assignedCatalogId) Find the catalogs that hold site overrides or synced copies for this assigned catalog's id.
org.broadleafcommerce.common.site.domain.SiteCatalogXref	findSiteCatalogXref(Long id) Find the xref, if exists, for the given site and catalog
List<MultiTenantSite>	findStandardSitesForAssignedCatalog(Long assignedCatalogId) Find any standard sites who have the designated catalog assigned
javax.persistence.criteria.Subquery<Long>	getAssociatedCatalogSubQuery(org.broadleafcommerce.common.site.domain.Site currentSite, javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.CriteriaQuery criteria) Provide a criteria builder subquery (useful for placing in an IN clause) that will retrieve the distinct list of catalogs assigned to a site.
javax.persistence.criteria.Subquery<Long>	getAssociatedSiteSubQuery(org.broadleafcommerce.common.site.domain.Site currentSite, javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.CriteriaQuery criteria, boolean alwaysAllowAdminStatus) Provide a criteria builder subquery (useful for placing in an IN clause) that will retrieve the distinct list of owning sites for all catalogs assigned to a site.
protected List<javax.persistence.criteria.Predicate>	getAssociatedSubqueryRestrictions(org.broadleafcommerce.common.site.domain.Site currentSite, javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.Subquery<Long> subquery, javax.persistence.criteria.Root<org.broadleafcommerce.common.site.domain.SiteCatalogXrefImpl> siteCatalogRoot, boolean alwaysAllowAdminStatus)
javax.persistence.criteria.Subquery<Long>	getOwnedCatalogsSubQuery(org.broadleafcommerce.common.site.domain.Site currentSite, javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.CriteriaQuery criteria) Similar to MultiTenantDao.getAssociatedCatalogSubQuery(Site, CriteriaBuilder, CriteriaQuery) except that this places a further restriction on only retrieving the associated catalogs that are also owned by the currentSite
javax.persistence.criteria.Subquery<Long>	getParameterizedAssociatedCatalogSubQuery(org.broadleafcommerce.common.site.domain.Site currentSite, javax.persistence.criteria.CriteriaBuilder builder, javax.persistence.criteria.CriteriaQuery criteria) Same as MultiTenantDao.getAssociatedCatalogSubQuery(Site, CriteriaBuilder, CriteriaQuery), except that the subquery returns uses a parameter for the currentSite.
org.broadleafcommerce.common.site.domain.Catalog	getTargetCatalogBasedOnMutability(Long candidateCatalogId, Long siteId) Get the current catalog context based on a candidate catalog.
Boolean	isCatalogUsedByChildSites(Long parentSiteId, Long catalogId) Whether the catalog of the passed in id is assigned to children of the passed in parent site id
Boolean	isMultipleManagedCatalogs(Long siteId) Determine, in a performant way, whether or not the current site is managing more than one active catalog
Boolean	isMultipleManagedCatalogsEligibleForAdd(Long siteId) Determine, in a performant way, whether or not the current site is managing more than one active and eligible for add catalog.
CatalogDerivedCatalogXref	readDerivedCatalogXrefById(Long id) Finds a given CatalogDerivedCatalogXref entity by its id
List<org.broadleafcommerce.common.site.domain.Site>	retrieveChildrenSitesByParentSiteId(Long id) Retrieves a list of children sites for the site id passed in
CatalogDerivedCatalogXref	saveDerivedCatalogXref(CatalogDerivedCatalogXref xref) Persists the given CatalogDerivedCatalogXref entity to the database.

Methods inherited from class java.lang.Object

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

Field Detail

em

protected javax.persistence.EntityManager em

Constructor Detail

MultiTenantDaoImpl

public MultiTenantDaoImpl()

Method Detail

findDerivedSitesFromCatalogs

public List<org.broadleafcommerce.common.site.domain.Site> findDerivedSitesFromCatalogs(List<Long> parentCatalogs)

Description copied from interface: MultiTenantDao

Find Site instances whose catalogs have this catalog as a parent.

Specified by:

findDerivedSitesFromCatalogs in interface MultiTenantDao

Parameters:

parentCatalogs - the catalog on which a derived site's catalog is based

Returns:

the list of derived catalog containing sites

findDerivedSitesFromProfiles

public List<org.broadleafcommerce.common.site.domain.Site> findDerivedSitesFromProfiles(List<Long> parentProfiles)

Description copied from interface: MultiTenantDao

Find Site instances whose profile have this profile as a parent.

Specified by:

findDerivedSitesFromProfiles in interface MultiTenantDao

Parameters:

parentProfiles - the profile on which a derived site's profile is based

Returns:

the list of derived profile containing sites

findStandardSitesForAssignedCatalog

public List<MultiTenantSite> findStandardSitesForAssignedCatalog(Long assignedCatalogId)

Description copied from interface: MultiTenantDao

Find any standard sites who have the designated catalog assigned

Specified by:

findStandardSitesForAssignedCatalog in interface MultiTenantDao

Returns:

findManagedProfileSites

public List<MultiTenantSite> findManagedProfileSites(Long parentSiteId)

Description copied from interface: MultiTenantDao

Find any profile sites whose parent matches the passed in id

Specified by:

findManagedProfileSites in interface MultiTenantDao

Returns:

findAllManagedSites

public List<org.broadleafcommerce.common.site.domain.Site> findAllManagedSites(Long parentSiteId)

Description copied from interface: MultiTenantDao

Find any standard sites whose parent matches the passed in id

Specified by:

findAllManagedSites in interface MultiTenantDao

Returns:

See Also:

#findAllManagedSites(Long, Integer, Integer)}

findAllManagedSites

public List<org.broadleafcommerce.common.site.domain.Site> findAllManagedSites(Long parentSiteId,
                                                                               Integer limit,
                                                                               Integer offset)

Description copied from interface: MultiTenantDao

Paged version of MultiTenantDao.findAllManagedSites(Long)

Specified by:

findAllManagedSites in interface MultiTenantDao

limit - how many results to limit

offset - where to start the result set

Returns:

See Also:

#findAllManagedSites(Long, Integer, Integer)}

countAllManagedSites

public Long countAllManagedSites(Long parentSiteId)

Specified by:

countAllManagedSites in interface MultiTenantDao

findAllManagedProfiles

public List<org.broadleafcommerce.common.site.domain.Site> findAllManagedProfiles(Long profileId)

Description copied from interface: MultiTenantDao

Find all standard sites whose base profile matches the passed in id

Specified by:

findAllManagedProfiles in interface MultiTenantDao

Returns:

isCatalogUsedByChildSites

public Boolean isCatalogUsedByChildSites(Long parentSiteId,
                                         Long catalogId)

Description copied from interface: MultiTenantDao

Whether the catalog of the passed in id is assigned to children of the passed in parent site id

Specified by:

isCatalogUsedByChildSites in interface MultiTenantDao

Returns:

isMultipleManagedCatalogs

public Boolean isMultipleManagedCatalogs(Long siteId)

Description copied from interface: MultiTenantDao

Determine, in a performant way, whether or not the current site is managing more than one active catalog

Specified by:

isMultipleManagedCatalogs in interface MultiTenantDao

Returns:

isMultipleManagedCatalogsEligibleForAdd

public Boolean isMultipleManagedCatalogsEligibleForAdd(Long siteId)

Description copied from interface: MultiTenantDao

Determine, in a performant way, whether or not the current site is managing more than one active and eligible for add catalog.

Specified by:

isMultipleManagedCatalogsEligibleForAdd in interface MultiTenantDao

Returns:

findOwnedCatalog

public org.broadleafcommerce.common.site.domain.Catalog findOwnedCatalog(Long siteId,
                                                                         Long catalogId)

Description copied from interface: MultiTenantDao

If the candidate catalog is owned by the current site, return it. Otherwise, return null;

Specified by:

findOwnedCatalog in interface MultiTenantDao

Returns:

findCatalogById

public org.broadleafcommerce.common.site.domain.Catalog findCatalogById(Long catalogId)

Description copied from interface: MultiTenantDao

Find Catalog by Id

Specified by:

findCatalogById in interface MultiTenantDao

Parameters:

catalogId - of the catalog to find.

Returns:

the catalog

findCatalogXrefsForSite

public List<org.broadleafcommerce.common.site.domain.SiteCatalogXref> findCatalogXrefsForSite(org.broadleafcommerce.common.site.domain.Site site)

Description copied from interface: MultiTenantDao

Find SiteCatalogXref for the passed in site.

Specified by:

findCatalogXrefsForSite in interface MultiTenantDao

Returns:

the List of SiteCatalogXrefs

findSiteCatalogIdsByAssignedCatalogId

public List<Long> findSiteCatalogIdsByAssignedCatalogId(Long assignedCatalogId)

Description copied from interface: MultiTenantDao

Find the catalogs that hold site overrides or synced copies for this assigned catalog's id.

Specified by:

findSiteCatalogIdsByAssignedCatalogId in interface MultiTenantDao

Parameters:

assignedCatalogId - usually the id of a TEMPLATE Site-level Catalog.

Returns:

a List of the site override catalogs

findDefaultCatalogIdsByAssignedCatalogId

public List<Long> findDefaultCatalogIdsByAssignedCatalogId(Long assignedCatalogId)

Description copied from interface: MultiTenantDao

Find the default catalogs for sites that are assigned the given catalog.

Specified by:

findDefaultCatalogIdsByAssignedCatalogId in interface MultiTenantDao

Parameters:

assignedCatalogId - usually the id of a TEMPLATE Site-level Catalog.

Returns:

a List of the default catalogs

findCatalogXrefsForCatalog

public List<CatalogDerivedCatalogXref> findCatalogXrefsForCatalog(org.broadleafcommerce.common.site.domain.Catalog catalog)

Description copied from interface: MultiTenantDao

Find CatalogDerivedCatalogXref for the passed in catalog.

Specified by:

findCatalogXrefsForCatalog in interface MultiTenantDao

Returns:

the List of CatalogDerivedCatalogXref

findAllStandardSiteCatalogs

public List<org.broadleafcommerce.common.site.domain.Catalog> findAllStandardSiteCatalogs()

Specified by:

findAllStandardSiteCatalogs in interface MultiTenantDao

findAllCatalogs

public List<org.broadleafcommerce.common.site.domain.Catalog> findAllCatalogs()

Specified by:

findAllCatalogs in interface MultiTenantDao

findAllCatalogs

public List<org.broadleafcommerce.common.site.domain.Catalog> findAllCatalogs(boolean excludeArchived)

Specified by:

findAllCatalogs in interface MultiTenantDao

readDerivedCatalogXrefById

public CatalogDerivedCatalogXref readDerivedCatalogXrefById(Long id)

Description copied from interface: MultiTenantDao

Finds a given CatalogDerivedCatalogXref entity by its id

Specified by:

readDerivedCatalogXrefById in interface MultiTenantDao

Returns:

the CatalogDerivedCatalogXref

findSiteCatalogXref

public org.broadleafcommerce.common.site.domain.SiteCatalogXref findSiteCatalogXref(Long id)

Description copied from interface: MultiTenantDao

Find the xref, if exists, for the given site and catalog

Specified by:

findSiteCatalogXref in interface MultiTenantDao

Returns:

saveDerivedCatalogXref

public CatalogDerivedCatalogXref saveDerivedCatalogXref(CatalogDerivedCatalogXref xref)

Description copied from interface: MultiTenantDao

Persists the given CatalogDerivedCatalogXref entity to the database.

Specified by:

saveDerivedCatalogXref in interface MultiTenantDao

Returns:

the persisted version of the CatalogDerivedCatalogXref

findAllStandardSites

public List<MultiTenantSite> findAllStandardSites()

Description copied from interface: MultiTenantDao

Finds all standard sites

Specified by:

findAllStandardSites in interface MultiTenantDao

Returns:

a List of Site's

retrieveChildrenSitesByParentSiteId

public List<org.broadleafcommerce.common.site.domain.Site> retrieveChildrenSitesByParentSiteId(Long id)

Description copied from interface: MultiTenantDao

Retrieves a list of children sites for the site id passed in

Specified by:

retrieveChildrenSitesByParentSiteId in interface MultiTenantDao

Returns:

getAssociatedSiteSubQuery

public javax.persistence.criteria.Subquery<Long> getAssociatedSiteSubQuery(org.broadleafcommerce.common.site.domain.Site currentSite,
                                                                           javax.persistence.criteria.CriteriaBuilder builder,
                                                                           javax.persistence.criteria.CriteriaQuery criteria,
                                                                           boolean alwaysAllowAdminStatus)

Description copied from interface: MultiTenantDao

Provide a criteria builder subquery (useful for placing in an IN clause) that will retrieve the distinct list of owning sites for all catalogs assigned to a site.

Specified by:

getAssociatedSiteSubQuery in interface MultiTenantDao

Parameters:

currentSite - the site whose assigned catalogs are reviewed

builder - the CriteriaBuilder from the containing criteria creation

criteria - the CriteriaQuery from the containing criteria creation

alwaysAllowAdminStatus - whether or not calls should allow both PENDING and ONLINE catalog associations, regardless of the request context state

Returns:

the subquery

getAssociatedCatalogSubQuery

public javax.persistence.criteria.Subquery<Long> getAssociatedCatalogSubQuery(org.broadleafcommerce.common.site.domain.Site currentSite,
                                                                              javax.persistence.criteria.CriteriaBuilder builder,
                                                                              javax.persistence.criteria.CriteriaQuery criteria)

Description copied from interface: MultiTenantDao

Provide a criteria builder subquery (useful for placing in an IN clause) that will retrieve the distinct list of catalogs assigned to a site.

Specified by:

getAssociatedCatalogSubQuery in interface MultiTenantDao

Parameters:

currentSite - the site whose assigned catalogs are reviewed

builder - the CriteriaBuilder from the containing criteria creation

criteria - the CriteriaQuery from the containing criteria creation

Returns:

the subquery

getOwnedCatalogsSubQuery

public javax.persistence.criteria.Subquery<Long> getOwnedCatalogsSubQuery(org.broadleafcommerce.common.site.domain.Site currentSite,
                                                                          javax.persistence.criteria.CriteriaBuilder builder,
                                                                          javax.persistence.criteria.CriteriaQuery criteria)

Description copied from interface: MultiTenantDao

Similar to MultiTenantDao.getAssociatedCatalogSubQuery(Site, CriteriaBuilder, CriteriaQuery) except that this places a further restriction on only retrieving the associated catalogs that are also owned by the currentSite

Specified by:

getOwnedCatalogsSubQuery in interface MultiTenantDao

Parameters:

currentSite - the site whose assigned catalogs are reviewed

builder - the CriteriaBuilder from the containing criteria creation

criteria - the CriteriaQuery from the containing criteria creation

Returns:

the subquery

getParameterizedAssociatedCatalogSubQuery

public javax.persistence.criteria.Subquery<Long> getParameterizedAssociatedCatalogSubQuery(org.broadleafcommerce.common.site.domain.Site currentSite,
                                                                                           javax.persistence.criteria.CriteriaBuilder builder,
                                                                                           javax.persistence.criteria.CriteriaQuery criteria)

Description copied from interface: MultiTenantDao

Same as MultiTenantDao.getAssociatedCatalogSubQuery(Site, CriteriaBuilder, CriteriaQuery), except that the subquery returns uses a parameter for the currentSite. The final Query instance should be passed to MultiTenantDao.completeParameterizedAssociatedCatalogSubQuery(Query, Site).

Specified by:

getParameterizedAssociatedCatalogSubQuery in interface MultiTenantDao

Returns:

completeParameterizedAssociatedCatalogSubQuery

public void completeParameterizedAssociatedCatalogSubQuery(javax.persistence.Query query,
                                                           org.broadleafcommerce.common.site.domain.Site currentSite)

Description copied from interface: MultiTenantDao

Set the currentSite parameter on the catalog sub query.

Specified by:

completeParameterizedAssociatedCatalogSubQuery in interface MultiTenantDao

getTargetCatalogBasedOnMutability

public org.broadleafcommerce.common.site.domain.Catalog getTargetCatalogBasedOnMutability(Long candidateCatalogId,
                                                                                          Long siteId)

Description copied from interface: MultiTenantDao

Get the current catalog context based on a candidate catalog. If a synced catalog association is found, then use this catalog. If a sparse, customizable association is found whose implicit catalog matches the candidate, then use the real catalog (not the implicit catalog) from the association.

Specified by:

getTargetCatalogBasedOnMutability in interface MultiTenantDao

Parameters:

candidateCatalogId - the candidate catalog (presumably taken from a catalog discriminated entity)

siteId - the current site

Returns:

findCatalogAssociationsById

public List<org.broadleafcommerce.common.site.domain.SiteCatalogXref> findCatalogAssociationsById(Long siteId,
                                                                                                  Long catalogId)

Description copied from interface: MultiTenantDao

Find the association with the specific catalog id

Specified by:

findCatalogAssociationsById in interface MultiTenantDao

Returns:

findCatalogAssociationsByName

public List<org.broadleafcommerce.common.site.domain.SiteCatalogXref> findCatalogAssociationsByName(Long siteId,
                                                                                                    String catalogName)

Description copied from interface: MultiTenantDao

Find the association with the specific catalog name

Specified by:

findCatalogAssociationsByName in interface MultiTenantDao

Returns:

getAssociatedSubqueryRestrictions

protected List<javax.persistence.criteria.Predicate> getAssociatedSubqueryRestrictions(org.broadleafcommerce.common.site.domain.Site currentSite,
                                                                                       javax.persistence.criteria.CriteriaBuilder builder,
                                                                                       javax.persistence.criteria.Subquery<Long> subquery,
                                                                                       javax.persistence.criteria.Root<org.broadleafcommerce.common.site.domain.SiteCatalogXrefImpl> siteCatalogRoot,
                                                                                       boolean alwaysAllowAdminStatus)

applyParameterizedAssociatedSubqueryRestrictions

protected void applyParameterizedAssociatedSubqueryRestrictions(org.broadleafcommerce.common.site.domain.Site currentSite,
                                                                javax.persistence.criteria.CriteriaBuilder builder,
                                                                javax.persistence.criteria.Subquery<Long> subquery,
                                                                javax.persistence.criteria.Root<org.broadleafcommerce.common.site.domain.SiteCatalogXrefImpl> siteCatalogRoot,
                                                                boolean alwaysAllowAdminStatus)