com.broadleafcommerce.tenant.service

Class MultiTenantServiceImpl

java.lang.Object

com.broadleafcommerce.tenant.service.MultiTenantServiceImpl

All Implemented Interfaces:

MultiTenantService

@Service(value="blMultiTenantService")
public class MultiTenantServiceImpl
extends Object
implements MultiTenantService

Author:

Jeff Fischer

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	initDisabled
protected MultiTenantDao	multiTenantDao
protected org.broadleafcommerce.common.sandbox.service.SandBoxService	sandBoxService
protected List<org.broadleafcommerce.common.site.service.provider.SiteConfigProvider>	siteConfigProviders
protected SiteProvider	siteProvider
protected org.broadleafcommerce.common.site.service.SiteService	siteService
protected org.broadleafcommerce.common.site.service.SiteServiceExtensionManager	siteServiceExtensionManager
protected org.springframework.transaction.PlatformTransactionManager	transactionManager
protected org.broadleafcommerce.common.util.StreamingTransactionCapableUtil	transUtil
protected String	validDomainPrefixRegex
protected String	validDomainRegex

Constructor Summary

Constructors

Constructor and Description
MultiTenantServiceImpl()

Method Summary

Modifier and Type	Method and Description
SiteResponse	createSite(SiteDto siteDto) Creates a site matching the requested siteDto.
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 MultiTenantService.findAllManagedSites(Long)
List<org.broadleafcommerce.common.sandbox.domain.SandBox>	findAllSandBoxes(org.broadleafcommerce.common.site.domain.Catalog catalog) Retrieves the sandboxes for the given catalog and its owning site.
List<org.broadleafcommerce.common.sandbox.domain.SandBox>	findAllSandBoxes(org.broadleafcommerce.common.site.domain.Site site) Retrieves the sandboxes for the given catalog and its owning site.
List<org.broadleafcommerce.common.site.domain.Catalog>	findAllStandardSiteCatalogs()
List<MultiTenantSite>	findAllStandardSites() Find all standard sites
List<org.broadleafcommerce.common.site.domain.Site>	findChildrenSitesByParentSiteId(Long id) Returns a list of children sites for the site id passed in
CatalogDerivedCatalogXref	findDerivedCatalogXrefById(Long id) Finds a given CatalogDerivedCatalogXref entity by its id
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.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
Set<org.broadleafcommerce.common.site.domain.Site>	findVisibleProfileSites(MultiTenantSite currentSite) Find any profile sites whose parent matches the passed in id
protected MultiTenantSite	getNonPersistentSite(MultiTenantSite mts)
SiteProvider	getSiteProvider()
String	getValidDomainRegex()
boolean	isInitDisabled()
CatalogDerivedCatalogXref	saveDerivedCatalogXref(CatalogDerivedCatalogXref xref) Persists the given CatalogDerivedCatalogXref entity to the database.
void	setInitDisabled(boolean initDisabled)
void	setSiteProvider(SiteProvider siteProvider) Sets the siteProvider
void	setValidDomainRegex(String validDomainRegex) Sets the regex expression used to check if a domain is valid

Methods inherited from class java.lang.Object

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

Field Detail

validDomainRegex

protected String validDomainRegex

validDomainPrefixRegex

protected String validDomainPrefixRegex

transUtil

protected org.broadleafcommerce.common.util.StreamingTransactionCapableUtil transUtil

siteProvider

protected SiteProvider siteProvider

multiTenantDao

protected MultiTenantDao multiTenantDao

siteConfigProviders

protected List<org.broadleafcommerce.common.site.service.provider.SiteConfigProvider> siteConfigProviders

siteService

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

sandBoxService

protected org.broadleafcommerce.common.sandbox.service.SandBoxService sandBoxService

transactionManager

protected org.springframework.transaction.PlatformTransactionManager transactionManager

siteServiceExtensionManager

protected org.broadleafcommerce.common.site.service.SiteServiceExtensionManager siteServiceExtensionManager

initDisabled

protected boolean initDisabled

Constructor Detail

MultiTenantServiceImpl

public MultiTenantServiceImpl()

Method Detail

createSite

@Transactional(value="blTransactionManager")
public SiteResponse createSite(SiteDto siteDto)

Description copied from interface: MultiTenantService

Creates a site matching the requested siteDto. Performs some initial setup and will then delegate to the configured SiteProvider for the actual creation of the site.

Specified by:

createSite in interface MultiTenantService

Returns:

the siteResponse

getValidDomainRegex

public String getValidDomainRegex()

Specified by:

getValidDomainRegex in interface MultiTenantService

Returns:

the regex expression used to check if a domain is valid

setValidDomainRegex

public void setValidDomainRegex(String validDomainRegex)

Description copied from interface: MultiTenantService

Sets the regex expression used to check if a domain is valid

Specified by:

setValidDomainRegex in interface MultiTenantService

getSiteProvider

public SiteProvider getSiteProvider()

Specified by:

getSiteProvider in interface MultiTenantService

Returns:

the siteProvider

setSiteProvider

public void setSiteProvider(SiteProvider siteProvider)

Description copied from interface: MultiTenantService

Sets the siteProvider

Specified by:

setSiteProvider in interface MultiTenantService

isInitDisabled

public boolean isInitDisabled()

setInitDisabled

public void setInitDisabled(boolean initDisabled)

findDerivedSitesFromCatalogs

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

Description copied from interface: MultiTenantService

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

Specified by:

findDerivedSitesFromCatalogs in interface MultiTenantService

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: MultiTenantService

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

Specified by:

findDerivedSitesFromProfiles in interface MultiTenantService

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: MultiTenantService

Find any standard sites who have the designated catalog assigned

Specified by:

findStandardSitesForAssignedCatalog in interface MultiTenantService

Returns:

findAllStandardSites

public List<MultiTenantSite> findAllStandardSites()
                                           throws org.broadleafcommerce.common.exception.ServiceException

Description copied from interface: MultiTenantService

Find all standard sites

Specified by:

findAllStandardSites in interface MultiTenantService

Returns:

a List of Site's

Throws:

org.broadleafcommerce.common.exception.ServiceException

getNonPersistentSite

protected MultiTenantSite getNonPersistentSite(MultiTenantSite mts)

findManagedProfileSites

public List<MultiTenantSite> findManagedProfileSites(Long parentSiteId)

Description copied from interface: MultiTenantService

Find any profile sites whose parent matches the passed in id

Specified by:

findManagedProfileSites in interface MultiTenantService

Returns:

findAllManagedSites

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

Description copied from interface: MultiTenantService

Find any standard sites whose parent matches the passed in id

Specified by:

findAllManagedSites in interface MultiTenantService

Returns:

See Also:

MultiTenantService.findAllManagedSites(Long, Integer, Integer)

findAllManagedSites

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

Description copied from interface: MultiTenantService

Paged version of MultiTenantService.findAllManagedSites(Long)

Specified by:

findAllManagedSites in interface MultiTenantService

limit - how many results to get

offset - where to start the result set

Returns:

See Also:

MultiTenantService.findAllManagedSites(Long)

findAllManagedProfiles

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

Description copied from interface: MultiTenantService

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

Specified by:

findAllManagedProfiles in interface MultiTenantService

Returns:

findDerivedCatalogXrefById

public CatalogDerivedCatalogXref findDerivedCatalogXrefById(Long id)

Description copied from interface: MultiTenantService

Finds a given CatalogDerivedCatalogXref entity by its id

Specified by:

findDerivedCatalogXrefById in interface MultiTenantService

Returns:

the CatalogDerivedCatalogXref

findSiteCatalogXref

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

Description copied from interface: MultiTenantService

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

Specified by:

findSiteCatalogXref in interface MultiTenantService

Returns:

saveDerivedCatalogXref

public CatalogDerivedCatalogXref saveDerivedCatalogXref(CatalogDerivedCatalogXref xref)

Description copied from interface: MultiTenantService

Persists the given CatalogDerivedCatalogXref entity to the database.

Specified by:

saveDerivedCatalogXref in interface MultiTenantService

Returns:

the persisted version of the CatalogDerivedCatalogXref

findAllStandardSiteCatalogs

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

Specified by:

findAllStandardSiteCatalogs in interface MultiTenantService

findAllCatalogs

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

Specified by:

findAllCatalogs in interface MultiTenantService

findAllCatalogs

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

Specified by:

findAllCatalogs in interface MultiTenantService

findVisibleProfileSites

public Set<org.broadleafcommerce.common.site.domain.Site> findVisibleProfileSites(MultiTenantSite currentSite)

Description copied from interface: MultiTenantService

Find any profile sites whose parent matches the passed in id

Specified by:

findVisibleProfileSites in interface MultiTenantService

Returns:

findAllSandBoxes

@Transactional(value="blTransactionManager")
public List<org.broadleafcommerce.common.sandbox.domain.SandBox> findAllSandBoxes(org.broadleafcommerce.common.site.domain.Catalog catalog)
                                                                                                                        throws org.broadleafcommerce.common.exception.ServiceException

Description copied from interface: MultiTenantService

Retrieves the sandboxes for the given catalog and its owning site.

This will give all sandboxes that exist within the catalog and its owning site and no others. So if there are three sandboxes for catalog -2 on site -3, this will return exactly 3 sandboxes. If there is one sandbox for catalog -1 on site -1 (global), this will return that sandbox.

Any implementation of this method should be wrapped with @Transactional to avoid lazy initialization exceptions on startup.

Specified by:

findAllSandBoxes in interface MultiTenantService

Parameters:

catalog - the catalog to find sandboxes for

Returns:

a list of sandboxes for the given catalog and its owning site

Throws:

org.broadleafcommerce.common.exception.ServiceException

findAllSandBoxes

@Transactional(value="blTransactionManager")
public List<org.broadleafcommerce.common.sandbox.domain.SandBox> findAllSandBoxes(org.broadleafcommerce.common.site.domain.Site site)
                                                                                                                        throws org.broadleafcommerce.common.exception.ServiceException

Description copied from interface: MultiTenantService

Retrieves the sandboxes for the given catalog and its owning site.

This will give all sandboxes that exist within the catalog and its owning site and no others. So if there are three sandboxes for catalog -2 on site -3, this will return exactly 3 sandboxes. If there is one sandbox for catalog -1 on site -1 (global), this will return that sandbox.

Any implementation of this method should be wrapped with @Transactional to avoid lazy initialization exceptions on startup.

Specified by:

findAllSandBoxes in interface MultiTenantService

Parameters:

site - the site to find sandboxes for

Returns:

a list of sandboxes for the given catalog and its owning site

Throws:

org.broadleafcommerce.common.exception.ServiceException

findChildrenSitesByParentSiteId

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

Description copied from interface: MultiTenantService

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

Specified by:

findChildrenSitesByParentSiteId in interface MultiTenantService