com.broadleafcommerce.tenant.service

Interface MultiTenantService

All Known Implementing Classes:

MultiTenantServiceImpl

public interface MultiTenantService

The MultiTenantService is used when provisioning new sites.

Author:

Jeff Fischer

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 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
SiteProvider	getSiteProvider()
String	getValidDomainRegex()
CatalogDerivedCatalogXref	saveDerivedCatalogXref(CatalogDerivedCatalogXref xref) Persists the given CatalogDerivedCatalogXref entity to the database.
void	setSiteProvider(SiteProvider siteProvider) Sets the siteProvider
void	setValidDomainRegex(String validDomainRegex) Sets the regex expression used to check if a domain is valid

Method Detail

createSite

SiteResponse createSite(SiteDto siteDto)

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.

Parameters:

siteDto -

Returns:

the siteResponse

getValidDomainRegex

String getValidDomainRegex()

Returns:

the regex expression used to check if a domain is valid

setValidDomainRegex

void setValidDomainRegex(String validDomainRegex)

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

Parameters:

validDomainRegex -

getSiteProvider

SiteProvider getSiteProvider()

Returns:

the siteProvider

setSiteProvider

void setSiteProvider(SiteProvider siteProvider)

Sets the siteProvider

Parameters:

siteProvider -

findDerivedSitesFromCatalogs

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

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

Parameters:

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

Returns:

the list of derived catalog containing sites

findDerivedSitesFromProfiles

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

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

Parameters:

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

Returns:

the list of derived profile containing sites

findStandardSitesForAssignedCatalog

List<MultiTenantSite> findStandardSitesForAssignedCatalog(Long assignedCatalogId)

Find any standard sites who have the designated catalog assigned

Parameters:

assignedCatalogId -

Returns:

findAllStandardSites

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

Find all standard sites

Returns:

a List of Site's

Throws:

org.broadleafcommerce.common.exception.ServiceException

findAllManagedSites

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

Find any standard sites whose parent matches the passed in id

Parameters:

parentSiteId -

Returns:

See Also:

findAllManagedSites(Long, Integer, Integer)

findAllManagedSites

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

Paged version of findAllManagedSites(Long)

Parameters:

parentSiteId -

limit - how many results to get

offset - where to start the result set

Returns:

See Also:

findAllManagedSites(Long)

findAllManagedProfiles

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

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

Parameters:

profileId -

Returns:

findDerivedCatalogXrefById

CatalogDerivedCatalogXref findDerivedCatalogXrefById(Long id)

Finds a given CatalogDerivedCatalogXref entity by its id

Parameters:

id -

Returns:

the CatalogDerivedCatalogXref

findSiteCatalogXref

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

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

Parameters:

id -

Returns:

saveDerivedCatalogXref

CatalogDerivedCatalogXref saveDerivedCatalogXref(CatalogDerivedCatalogXref xref)

Persists the given CatalogDerivedCatalogXref entity to the database.

Parameters:

xref -

Returns:

the persisted version of the CatalogDerivedCatalogXref

findAllStandardSiteCatalogs

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

findAllCatalogs

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

findAllCatalogs

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

findManagedProfileSites

List<MultiTenantSite> findManagedProfileSites(Long parentSiteId)

Find any profile sites whose parent matches the passed in id

Parameters:

parentSiteId -

Returns:

findVisibleProfileSites

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

Find any profile sites whose parent matches the passed in id

Parameters:

currentSite -

Returns:

findAllSandBoxes

List<org.broadleafcommerce.common.sandbox.domain.SandBox> findAllSandBoxes(org.broadleafcommerce.common.site.domain.Catalog catalog)
                                                                    throws org.broadleafcommerce.common.exception.ServiceException

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.

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

List<org.broadleafcommerce.common.sandbox.domain.SandBox> findAllSandBoxes(org.broadleafcommerce.common.site.domain.Site site)
                                                                    throws org.broadleafcommerce.common.exception.ServiceException

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.

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

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

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