com.broadleafcommerce.advancedcms.service

Class ContentZoneServiceImpl

java.lang.Object

com.broadleafcommerce.advancedcms.service.ContentZoneServiceImpl

All Implemented Interfaces:

ContentZoneService

@Repository(value="blContentZoneService")
public class ContentZoneServiceImpl
extends Object
implements ContentZoneService

Author:

Andre Azzolini (apazzolini)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	ContentZoneServiceImpl.BuildMapKey

Field Summary

Fields

Modifier and Type	Field and Description
protected ContentItemService	contentItemService
protected ContentTargeterService	contentTargeterService
protected ContentZoneDao	contentZoneDao
protected ContentZoneServiceExtensionManager	extensionManager
protected static String	FOREIGN_LOOKUP
protected org.broadleafcommerce.common.dao.GenericEntityDao	genericDao
protected OverrideContentService	overrideContentService
protected org.broadleafcommerce.common.cache.StatisticsService	statisticsService
protected static String	STRUCTURED_CONTENT_MAP_CACHE_HIT_RATE
protected net.sf.ehcache.Cache	structuredContentMapCache
protected org.broadleafcommerce.cms.structure.service.StructuredContentService	structuredContentService

Constructor Summary

Constructors

Constructor and Description
ContentZoneServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addMasterStructuredContentDTOsToCache(ContentItemDTO contentItemDto, boolean secure)
protected void	addStructuredContentDTOsToCache(ContentItemDTO contentItemDto, boolean secure)
protected String	buildCacheKey(ContentItem contentItem) Build the cache key using sandbox original item id.
protected String	buildCacheKey(ContentItemDTO contentItemDto) Build the cache key using the current item's id.
protected void	buildCiDtos(ContentItemDTO ciDto, boolean secure, ContentItem ci, Object translationBase)
protected void	buildCiMasterDtos(ContentItemDTO ciDto, boolean secure, ContentItem ci, Object translationBase)
protected String	buildMapKey(ContentItemDTO contentItemDto, boolean secure, org.broadleafcommerce.common.web.BroadleafRequestContext context)
protected String	buildMasterMapKey(ContentItemDTO contentItemDto, boolean secure, org.broadleafcommerce.common.web.BroadleafRequestContext context)
protected ContentItemDTO	createContentItemDto(ContentItem contentItem) Creates the ContentItemDTO given a contentItem.
List<ContentZone>	findAllContentZonesUsingDefinition(ContentZoneDefinition contentZoneDefinition)
ContentItemDTO	findContentItemDTOForZoneName(String name, boolean secure) Returns the ContentItemDTO associated with the given zone name
ContentItemDTO	findContentItemDTOForZoneName(String name, boolean secure, Map<String,Object> args) Returns the ContentItemDTO associated with the given zone name and extra arguments.
ContentZone	findContentZoneById(Long id)
ContentZone	findContentZoneByName(String name) Returns the ContentZone associated with the given name
ContentZoneDefinition	findContentZoneDefinitionById(Long id)
List<ContentZoneDefinition>	findContentZoneDefinitionsAllowingWidget(Widget widget)
protected org.broadleafcommerce.common.structure.dto.StructuredContentDTO	getStructuredContentDTO(boolean secure, Object translationBase, org.broadleafcommerce.cms.structure.domain.StructuredContent sc)
protected net.sf.ehcache.Cache	getStructuredContentMapCache()
protected ContentItem	lookupContentItemForZone(ContentZone cz)
protected List<org.broadleafcommerce.common.structure.dto.StructuredContentDTO>	lookupStructuredContentDTOsFromCache(ContentItemDTO contentItemDto, boolean secure, ContentZoneServiceImpl.BuildMapKey buildMapKey)
boolean	removeStructuredContentDTOsFromCache(ContentItem contentItem) Call to evict a DTOList from the cache.
ContentZone	saveContentZone(ContentZone contentZone) Saves the given ContentZone and returns the saved version
protected void	sortDTOsByPriority(List<org.broadleafcommerce.common.structure.dto.StructuredContentDTO> dtos)

Methods inherited from class java.lang.Object

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

Field Detail

FOREIGN_LOOKUP

protected static final String FOREIGN_LOOKUP

See Also:

Constant Field Values

STRUCTURED_CONTENT_MAP_CACHE_HIT_RATE

protected static final String STRUCTURED_CONTENT_MAP_CACHE_HIT_RATE

See Also:

Constant Field Values

contentZoneDao

protected ContentZoneDao contentZoneDao

overrideContentService

protected OverrideContentService overrideContentService

contentTargeterService

protected ContentTargeterService contentTargeterService

contentItemService

protected ContentItemService contentItemService

extensionManager

protected ContentZoneServiceExtensionManager extensionManager

genericDao

protected org.broadleafcommerce.common.dao.GenericEntityDao genericDao

structuredContentService

protected org.broadleafcommerce.cms.structure.service.StructuredContentService structuredContentService

statisticsService

protected org.broadleafcommerce.common.cache.StatisticsService statisticsService

structuredContentMapCache

protected net.sf.ehcache.Cache structuredContentMapCache

Constructor Detail

ContentZoneServiceImpl

public ContentZoneServiceImpl()

Method Detail

findContentZoneByName

public ContentZone findContentZoneByName(String name)

Description copied from interface: ContentZoneService

Returns the ContentZone associated with the given name

Specified by:

findContentZoneByName in interface ContentZoneService

Returns:

the ContentZone

saveContentZone

public ContentZone saveContentZone(ContentZone contentZone)

Description copied from interface: ContentZoneService

Saves the given ContentZone and returns the saved version

Specified by:

saveContentZone in interface ContentZoneService

Returns:

the saved ContentZone

findContentItemDTOForZoneName

public ContentItemDTO findContentItemDTOForZoneName(String name,
                                           boolean secure)

Description copied from interface: ContentZoneService

Returns the ContentItemDTO associated with the given zone name

Specified by:

findContentItemDTOForZoneName in interface ContentZoneService

secure - Some ContentItems contain HTML with URLs that must be modified based on HTTP or HTTPS

Returns:

the ContentItemDTO

buildCacheKey

protected String buildCacheKey(ContentItemDTO contentItemDto)

Build the cache key using the current item's id.

Parameters:

contentItemDto -

Returns:

cache key

buildCacheKey

protected String buildCacheKey(ContentItem contentItem)

Build the cache key using sandbox original item id. If null, revert to the current content item's id.

Parameters:

contentItem -

Returns:

cache key

buildMasterMapKey

protected String buildMasterMapKey(ContentItemDTO contentItemDto,
                       boolean secure,
                       org.broadleafcommerce.common.web.BroadleafRequestContext context)

buildMapKey

protected String buildMapKey(ContentItemDTO contentItemDto,
                 boolean secure,
                 org.broadleafcommerce.common.web.BroadleafRequestContext context)

lookupStructuredContentDTOsFromCache

protected List<org.broadleafcommerce.common.structure.dto.StructuredContentDTO> lookupStructuredContentDTOsFromCache(ContentItemDTO contentItemDto,
                                                                                                         boolean secure,
                                                                                                         ContentZoneServiceImpl.BuildMapKey buildMapKey)

addStructuredContentDTOsToCache

protected void addStructuredContentDTOsToCache(ContentItemDTO contentItemDto,
                                   boolean secure)

addMasterStructuredContentDTOsToCache

protected void addMasterStructuredContentDTOsToCache(ContentItemDTO contentItemDto,
                                         boolean secure)

getStructuredContentMapCache

protected net.sf.ehcache.Cache getStructuredContentMapCache()

removeStructuredContentDTOsFromCache

public boolean removeStructuredContentDTOsFromCache(ContentItem contentItem)

Description copied from interface: ContentZoneService

Call to evict a DTOList from the cache.

Specified by:

removeStructuredContentDTOsFromCache in interface ContentZoneService

Returns:

whether remove was successful

findContentItemDTOForZoneName

public ContentItemDTO findContentItemDTOForZoneName(String name,
                                           boolean secure,
                                           Map<String,Object> args)

Description copied from interface: ContentZoneService

Returns the ContentItemDTO associated with the given zone name and extra arguments.

Specified by:

findContentItemDTOForZoneName in interface ContentZoneService

secure - Some ContentItems contain HTML with URLs that must be modified based on HTTP or HTTPS

args - - additional arguments that an implementation might want to use to more specifically find a ContentItem

Returns:

the ContentItemDTO

buildCiDtos

protected void buildCiDtos(ContentItemDTO ciDto,
               boolean secure,
               ContentItem ci,
               Object translationBase)

buildCiMasterDtos

protected void buildCiMasterDtos(ContentItemDTO ciDto,
                     boolean secure,
                     ContentItem ci,
                     Object translationBase)

getStructuredContentDTO

protected org.broadleafcommerce.common.structure.dto.StructuredContentDTO getStructuredContentDTO(boolean secure,
                                                                                      Object translationBase,
                                                                                      org.broadleafcommerce.cms.structure.domain.StructuredContent sc)

sortDTOsByPriority

protected void sortDTOsByPriority(List<org.broadleafcommerce.common.structure.dto.StructuredContentDTO> dtos)

lookupContentItemForZone

protected ContentItem lookupContentItemForZone(ContentZone cz)

createContentItemDto

protected ContentItemDTO createContentItemDto(ContentItem contentItem)

Creates the ContentItemDTO given a contentItem.

findContentZoneDefinitionsAllowingWidget

public List<ContentZoneDefinition> findContentZoneDefinitionsAllowingWidget(Widget widget)

Specified by:

findContentZoneDefinitionsAllowingWidget in interface ContentZoneService

Returns:

a list of ContentZoneDefinitions that allow the given Widget

findAllContentZonesUsingDefinition

public List<ContentZone> findAllContentZonesUsingDefinition(ContentZoneDefinition contentZoneDefinition)

Specified by:

findAllContentZonesUsingDefinition in interface ContentZoneService

Returns:

a list of ContentZones that are using the given ContentZoneDefinition

findContentZoneDefinitionById

public ContentZoneDefinition findContentZoneDefinitionById(Long id)

Specified by:

findContentZoneDefinitionById in interface ContentZoneService

Returns:

the ContentZoneDefinition matching the given id

findContentZoneById

public ContentZone findContentZoneById(Long id)

Specified by:

findContentZoneById in interface ContentZoneService

Returns:

the ContentZone matching the given id