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

Created by bpolster.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	AND
protected PageServiceExtensionManager	extensionManager
protected static String	FOREIGN_LOOKUP
protected LocaleService	localeService
protected static org.apache.commons.logging.Log	LOG
protected PageDTO	NULL_PAGE
protected net.sf.ehcache.Cache	pageCache
protected PageDao	pageDao
protected net.sf.ehcache.Cache	pageMapCache
protected List<RuleProcessor<PageDTO>>	pageRuleProcessors
protected PageServiceUtility	pageServiceUtility
protected StaticAssetService	staticAssetService
protected StatisticsService	statisticsService
protected TemplateOverrideExtensionManager	templateOverrideManager

Constructor Summary

Constructors

Constructor and Description
PageServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addPageListToCache(List<PageDTO> pageList, String key, String uri, Long sandBox, Long site)
protected void	addPageMapCacheEntry(String keyToStore, String uri, Long sandBox, Long site)
protected String	buildKey(Long currentSandBox, Long site, Locale locale, String uri)
protected String	buildKey(SandBox sandBox, Page page)
List<PageDTO>	buildPageDTOList(List<Page> pageList, boolean secure) Converts a list of pages to a list of pageDTOs. Internally calls buildPageDTO(...).
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) Retrieve the page if one is available for the passed in uri.
Map<String,PageField>	findPageFieldMapByPageId(Long pageId) Returns the page with the passed in id.
PageTemplate	findPageTemplateById(Long id) Returns the page template with the passed in id.
net.sf.ehcache.Cache	getPageCache()
protected List<PageDTO>	getPageListFromCache(String key)
net.sf.ehcache.Cache	getPageMapCache()
String	getPageMapCacheKey(String uri, Long sandBox, Long site)
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
void	removePageFromCache(String key) Call to evict all known PageDTOs that are associated with the given 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

FOREIGN_LOOKUP

protected static final String FOREIGN_LOOKUP

See Also:

Constant Field Values

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

pageCache

protected net.sf.ehcache.Cache pageCache

pageMapCache

protected net.sf.ehcache.Cache pageMapCache

NULL_PAGE

protected final PageDTO NULL_PAGE

Constructor Detail

PageServiceImpl

public PageServiceImpl()

Method Detail

findPageById

public Page findPageById(Long pageId)

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)

Returns the page with the passed in id.

Specified by:

findPageFieldMapByPageId in interface PageService

Parameters:

pageId - - The id of the page.

Returns:

The associated page.

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)

Retrieve the page if one is available for the passed in uri.

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:

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 void removePageFromCache(String key)

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

buildPageDTOList

public List<PageDTO> buildPageDTOList(List<Page> pageList,
                             boolean secure)

Converts a list of pages to a list of pageDTOs.
Internally calls buildPageDTO(...).

Specified by:

buildPageDTOList in interface PageService

Parameters:

pageList -

secure -

Returns:

evaluatePageRules

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

passesPageRules

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

findLanguageOnlyLocale

protected Locale findLanguageOnlyLocale(Locale locale)

buildKey

protected String buildKey(Long currentSandBox,
              Long site,
              Locale locale,
              String uri)

getPageCache

public net.sf.ehcache.Cache getPageCache()

Specified by:

getPageCache in interface PageService

getPageMapCache

public net.sf.ehcache.Cache getPageMapCache()

Specified by:

getPageMapCache in interface PageService

buildKey

protected String buildKey(SandBox sandBox,
              Page page)

addPageListToCache

protected void addPageListToCache(List<PageDTO> pageList,
                      String key,
                      String uri,
                      Long sandBox,
                      Long site)

addPageMapCacheEntry

protected void addPageMapCacheEntry(String keyToStore,
                        String uri,
                        Long sandBox,
                        Long site)

getPageMapCacheKey

public String getPageMapCacheKey(String uri,
                        Long sandBox,
                        Long site)

Specified by:

getPageMapCacheKey in interface PageService

getPageListFromCache

protected List<PageDTO> getPageListFromCache(String key)