org.broadleafcommerce.cms.page.service

Class PageServiceImpl

java.lang.Object

org.broadleafcommerce.cms.page.service.PageServiceImpl

All Implemented Interfaces:

PageService

@Service(value="blPageService")
public class PageServiceImpl
extends Object
implements PageService

Author:

Brian Polster (bpolster), Nathan Moore (nathandmoore)

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	AND
protected javax.cache.CacheManager	cacheManager
protected PageServiceExtensionManager	extensionManager
protected LocaleService	localeService
protected static org.apache.commons.logging.Log	LOG
protected PageDTO	NULL_PAGE
protected javax.cache.Cache	pageCache
protected PageDao	pageDao
protected javax.cache.Cache	pageMapCache
protected List<RuleProcessor<PageDTO>>	pageRuleProcessors
protected PageServiceUtility	pageServiceUtility
protected PageQueryExtensionManager	queryExtensionManager
protected StaticAssetService	staticAssetService
protected StatisticsService	statisticsService
protected TemplateOverrideExtensionManager	templateOverrideManager
protected javax.cache.Cache	uriCachedDateCache

Constructor Summary

Constructors

Constructor and Description
PageServiceImpl()

Method Summary

Modifier and Type	Method and Description
protected void	addCachedDate(String key)
protected void	addPageListToCache(List<PageDTO> pageList, String identifier, Locale locale, boolean secure)
protected void	addPageListToPageDTOList(List<Page> pageList, boolean secure, List<PageDTO> dtoList)
protected void	addPageMapCacheEntry(String identifier, String key)
protected String	buildBaseKey(String identifier, String localeCode, Boolean secure)
protected String	buildKey(String identifier, Locale locale, Boolean secure)
protected String	buildKey(String identifier, String localeCode, Boolean secure, ResultType resultType)
List<PageDTO>	buildPageDTOList(List<Page> pageList, boolean secure, String identifier, Locale locale) Builds a list of PageDTO objects from the given list of Page objects and caches the list
protected List<PageDTO>	buildPageDTOListUsingCache(List<Page> pageList, String identifier, Locale locale, boolean secure)
protected List<PageDTO>	copyDTOList(List<PageDTO> dtoList)
protected PageDTO	evaluatePageRules(List<PageDTO> pageDTOList, Locale locale, Map<String,Object> ruleDTOs)
protected Locale	findLanguageOnlyLocale(Locale locale)
Page	findPageById(Long pageId) Returns the page with the passed in id.
PageDTO	findPageByURI(Locale locale, String uri, Map<String,Object> ruleDTOs, boolean secure) Looks up the page from the backend datastore.
Map<String,PageField>	findPageFieldMapByPageId(Long pageId) Returns the page-fields associated with a page.
PageTemplate	findPageTemplateById(Long id) Returns the page template with the passed in id.
protected Date	getCachedDate(String key)
protected List<PageDTO>	getCachedPageDTOList(List<Page> pageList, String identifier, Locale locale, boolean secure)
javax.cache.Cache	getPageCache()
protected List<PageDTO>	getPageDTOListForURI(Locale locale, String uri, boolean secure)
protected List<PageDTO>	getPageListFromCache(String key)
javax.cache.Cache	getPageMapCache()
String	getPageMapCacheKey(String uri, Long site)
javax.cache.Cache	getUriCachedDateCache()
protected boolean	isNullPageCached(Locale locale, String uri, boolean secure)
protected boolean	passesPageRules(PageDTO page, Map<String,Object> ruleDTOs)
List<Page>	readAllPages() Returns all pages, regardless of any sandbox they are apart of
List<PageTemplate>	readAllPageTemplates() Returns all page templates, regardless of any sandbox they are apart of
Boolean	removePageFromCache(String mapKey) Call to evict all known PageDTOs that are associated with the given page from cache
Boolean	removeTranslationPageFromCache(String uri, String localeCode, boolean isSecure) Call to evict translated page from cache
PageTemplate	savePageTemplate(PageTemplate template) Saves the given PageTemplate

Methods inherited from class java.lang.Object

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

Field Detail

LOG

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

AND

protected static String AND

pageDao

protected PageDao pageDao

pageRuleProcessors

protected List<RuleProcessor<PageDTO>> pageRuleProcessors

localeService

protected LocaleService localeService

staticAssetService

protected StaticAssetService staticAssetService

statisticsService

protected StatisticsService statisticsService

templateOverrideManager

protected TemplateOverrideExtensionManager templateOverrideManager

pageServiceUtility

protected PageServiceUtility pageServiceUtility

extensionManager

protected PageServiceExtensionManager extensionManager

queryExtensionManager

protected PageQueryExtensionManager queryExtensionManager

cacheManager

protected javax.cache.CacheManager cacheManager

pageCache

protected javax.cache.Cache pageCache

pageMapCache

protected javax.cache.Cache pageMapCache

uriCachedDateCache

protected javax.cache.Cache uriCachedDateCache

NULL_PAGE

protected final PageDTO NULL_PAGE

Constructor Detail

PageServiceImpl

public PageServiceImpl()

Method Detail

findPageById

public Page findPageById(Long pageId)

Description copied from interface: PageService

Returns the page with the passed in id.

Specified by:

findPageById in interface PageService

Parameters:

pageId - - The id of the page.

Returns:

The associated page.

findPageFieldMapByPageId

public Map<String,PageField> findPageFieldMapByPageId(Long pageId)

Description copied from interface: PageService

Returns the page-fields associated with a page.

Specified by:

findPageFieldMapByPageId in interface PageService

Returns:

findPageTemplateById

public PageTemplate findPageTemplateById(Long id)

Description copied from interface: PageService

Returns the page template with the passed in id.

Specified by:

findPageTemplateById in interface PageService

Parameters:

id - - the id of the page template

Returns:

The associated page template.

savePageTemplate

@Transactional(value="blTransactionManager")
public PageTemplate savePageTemplate(PageTemplate template)

Description copied from interface: PageService

Saves the given PageTemplate

Specified by:

savePageTemplate in interface PageService

Parameters:

template - the PageTemplate to save

Returns:

the database-saved PageTemplate

findPageByURI

public PageDTO findPageByURI(Locale locale,
                             String uri,
                             Map<String,Object> ruleDTOs,
                             boolean secure)

Description copied from interface: PageService

Looks up the page from the backend datastore. Processes the page's fields to fix the URL if the site has overridden the URL for images. If secure is true and images are being overridden, the system will use https.

Specified by:

findPageByURI in interface PageService

Parameters:

locale - - current locale

uri - - the URI to return a page for

ruleDTOs - - ruleDTOs that are used as the data to process page rules

secure - - set to true if current request is over HTTPS

Returns:

isNullPageCached

protected boolean isNullPageCached(Locale locale,
                                   String uri,
                                   boolean secure)

getPageDTOListForURI

protected List<PageDTO> getPageDTOListForURI(Locale locale,
                                             String uri,
                                             boolean secure)

addCachedDate

protected void addCachedDate(String key)

getCachedDate

protected Date getCachedDate(String key)

buildPageDTOList

public List<PageDTO> buildPageDTOList(List<Page> pageList,
                                      boolean secure,
                                      String identifier,
                                      Locale locale)

Description copied from interface: PageService

Builds a list of PageDTO objects from the given list of Page objects and caches the list

Specified by:

buildPageDTOList in interface PageService

Returns:

copy of DTOList

buildPageDTOListUsingCache

protected List<PageDTO> buildPageDTOListUsingCache(List<Page> pageList,
                                                   String identifier,
                                                   Locale locale,
                                                   boolean secure)

getCachedPageDTOList

protected List<PageDTO> getCachedPageDTOList(List<Page> pageList,
                                             String identifier,
                                             Locale locale,
                                             boolean secure)

addPageListToPageDTOList

protected void addPageListToPageDTOList(List<Page> pageList,
                                        boolean secure,
                                        List<PageDTO> dtoList)

getPageListFromCache

protected List<PageDTO> getPageListFromCache(String key)

addPageListToCache

protected void addPageListToCache(List<PageDTO> pageList,
                                  String identifier,
                                  Locale locale,
                                  boolean secure)

addPageMapCacheEntry

protected void addPageMapCacheEntry(String identifier,
                                    String key)

getPageMapCacheKey

public String getPageMapCacheKey(String uri,
                                 Long site)

Specified by:

getPageMapCacheKey in interface PageService

buildKey

protected String buildKey(String identifier,
                          Locale locale,
                          Boolean secure)

buildKey

protected String buildKey(String identifier,
                          String localeCode,
                          Boolean secure,
                          ResultType resultType)

buildBaseKey

protected String buildBaseKey(String identifier,
                              String localeCode,
                              Boolean secure)

findLanguageOnlyLocale

protected Locale findLanguageOnlyLocale(Locale locale)

getPageCache

public javax.cache.Cache getPageCache()

Specified by:

getPageCache in interface PageService

getPageMapCache

public javax.cache.Cache getPageMapCache()

Specified by:

getPageMapCache in interface PageService

getUriCachedDateCache

public javax.cache.Cache getUriCachedDateCache()

Specified by:

getUriCachedDateCache in interface PageService

copyDTOList

protected List<PageDTO> copyDTOList(List<PageDTO> dtoList)

evaluatePageRules

protected PageDTO evaluatePageRules(List<PageDTO> pageDTOList,
                                    Locale locale,
                                    Map<String,Object> ruleDTOs)

passesPageRules

protected boolean passesPageRules(PageDTO page,
                                  Map<String,Object> ruleDTOs)

readAllPages

public List<Page> readAllPages()

Description copied from interface: PageService

Returns all pages, regardless of any sandbox they are apart of

Specified by:

readAllPages in interface PageService

Returns:

all Pages configured in the system

readAllPageTemplates

public List<PageTemplate> readAllPageTemplates()

Description copied from interface: PageService

Returns all page templates, regardless of any sandbox they are apart of

Specified by:

readAllPageTemplates in interface PageService

Returns:

all PageTemplates configured in the system

removePageFromCache

public Boolean removePageFromCache(String mapKey)

Description copied from interface: PageService

Call to evict all known PageDTOs that are associated with the given page from cache

Specified by:

removePageFromCache in interface PageService

Returns:

whether successful

removeTranslationPageFromCache

public Boolean removeTranslationPageFromCache(String uri,
                                              String localeCode,
                                              boolean isSecure)

Description copied from interface: PageService

Call to evict translated page from cache

Specified by:

removeTranslationPageFromCache in interface PageService

Returns:

whether successful