Package com.broadleafcommerce.advancedcms.service

Class ContentItemServiceImpl

java.lang.Object

com.broadleafcommerce.advancedcms.service.ContentItemServiceImpl

All Implemented Interfaces:

ContentItemService

@Repository("blContentItemService")
public class ContentItemServiceImpl
extends Object
implements ContentItemService

Author:

Elbert Bautista (elbertbautista)

Field Summary

Fields

Modifier and Type	Field	Description
protected javax.cache.CacheManager	cacheManager
protected ContentItemDao	contentItemDao
protected ContentZoneServiceExtensionManager	extensionManager
protected static final String	FOREIGN_LOOKUP
protected org.broadleafcommerce.common.dao.GenericEntityDao	genericDao
protected OverrideContentService	overrideContentService
protected ContentZoneQueryExtensionHandler	queryExtensionManager
protected org.broadleafcommerce.common.sandbox.SandBoxHelper	sandBoxHelper
protected org.broadleafcommerce.common.cache.StatisticsService	statisticsService
protected javax.cache.Cache	structuredContentMapCache
protected org.broadleafcommerce.cms.structure.service.StructuredContentService	structuredContentService

Constructor Summary

Constructors

Constructor	Description
ContentItemServiceImpl()

Method Summary

Modifier and Type	Method	Description
protected void	addStructuredContentDTOsToCache(ContentItemDTO contentItemDto, ContentItem item, boolean secure)
protected String	buildCacheKey(ContentItemDTO contentItemDto, ContentItem item)
protected List<String>	buildCacheKeys(ContentItemDTO contentItemDto, ContentItem item)
protected String	buildMapKey(ContentItemDTO contentItemDto, boolean secure, org.broadleafcommerce.common.web.BroadleafRequestContext context)
protected ContentItemDTO	createContentItemDto(ContentItem contentItem)	Creates the ContentItemDTO given a contentItem.
ContentItemDTO	createContentItemDTOFromContentItem(boolean secure, Map<String,Object> args, ContentItem ci)	Creates a ContentItemDTO from the passed in ContentItem and caches it
protected List<org.broadleafcommerce.common.structure.dto.StructuredContentDTO>	createStructuredContentDTOs(ContentItem ci, boolean isSecure)	Creates StructuredContentDTO objects.
List<OverrideContentItem>	findAllOverrideContentItemsByContentItemId(Long contentItemId)	Returns a list of all OverrideContentItems
ContentItem	findContentItemById(Long id)	Returns the ContentItem that has the given id
OverrideContentItem	findOverrideContentItemByContentItemId(Long contentItemId)	Returns the appropriate OverrideContentItem for the given ContentItem id
ContentItem	generateContentItemByOverrideContentItem(OverrideContentItem overrideContentItem)	Creates a transient ContentItem that takes into consideration the overrides present in the given OverrideContentItem.
protected List<StructuredContentContentItemXref>	generateContentItemFields(OverrideContentItem overrideContentItem, ContentItem clonedCI)
protected List<StructuredContentContentItemXref>	generateSCCIXref(OverrideContentItem overrideContentItem, ContentItem clonedCI)
protected String	getCacheKey(String cacheKey, org.broadleafcommerce.common.extension.ResultType resultType)
protected List<String>	getCacheKeys(String cacheKey, org.broadleafcommerce.common.extension.ResultType resultType)
ContentItemDTO	getClonedContentItemDTO(ContentItemDTO ciDto)	When passing in the ContentItemDTO to the post retrieval method we clone the DTO to prevent unwanted changes to the original.
protected boolean	getIncludeNonOverriddenSCItemsFlag()
protected org.broadleafcommerce.common.extension.ResultType	getResultType(Object object)
protected javax.cache.Cache	getStructuredContentMapCache()
List<org.broadleafcommerce.common.structure.dto.StructuredContentDTO>	hydrateForeignLookups(List<org.broadleafcommerce.common.structure.dto.StructuredContentDTO> dtos)	StructuredContentDTO objects are sometimes cached in the StructuredContentService.
protected boolean	isMasterContentData(org.broadleafcommerce.common.structure.dto.StructuredContentDTO scDto)
protected boolean	isValueObjectTranslatable(Object value)
protected List<org.broadleafcommerce.common.structure.dto.StructuredContentDTO>	lookupStructuredContentDTOsFromCache(ContentItemDTO contentItemDto, ContentItem item, boolean secure)
ContentItemDTO	postRetrievalContentItemModification(ContentItemDTO ciDto, String name, boolean secure, Map<String,Object> args)	Used to modify the ContentItemDTO created.
OverrideContentItem	readOverrideContentItemById(Long id)	Returns the OverrideContentItem that has the given id
boolean	removeContentItemFromCache(ContentItem contentItem)	Removes the passed in contentItem (and its associated StructuredContent items) from cache
ContentItem	saveContentItem(ContentItem contentItem)	Saves a ContentItem and returns the saved version
protected void	setMasterStructuredContentDTOs(ContentItemDTO ciDto)
protected void	setStructuredContentDTOTranslations(ContentItem contentItem, List<org.broadleafcommerce.common.structure.dto.StructuredContentDTO> dtos)
void	setStructuredContentForDTO(ContentItem contentItem, boolean isSecure, ContentItemDTO ciDto)	Adds StructuredContentDTO to ContentItemDTO
protected void	sortDTOsByPriority(List<org.broadleafcommerce.common.structure.dto.StructuredContentDTO> dtos)
protected void	translateStructuredContentDTO(org.broadleafcommerce.common.structure.dto.StructuredContentDTO dto, ContentItem contentItem)
protected List<org.broadleafcommerce.common.structure.dto.StructuredContentDTO>	utilizeCache(ContentItem contentItem, boolean isSecure, ContentItemDTO ciDto)

Methods inherited from class java.lang.Object

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

Field Details

FOREIGN_LOOKUP

protected static final String FOREIGN_LOOKUP

See Also:

• Constant Field Values

contentItemDao

protected ContentItemDao contentItemDao

overrideContentService

protected OverrideContentService overrideContentService

extensionManager

protected ContentZoneServiceExtensionManager extensionManager

queryExtensionManager

protected ContentZoneQueryExtensionHandler queryExtensionManager

genericDao

protected org.broadleafcommerce.common.dao.GenericEntityDao genericDao

statisticsService

protected org.broadleafcommerce.common.cache.StatisticsService statisticsService

structuredContentService

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

sandBoxHelper

protected org.broadleafcommerce.common.sandbox.SandBoxHelper sandBoxHelper

cacheManager

protected javax.cache.CacheManager cacheManager

structuredContentMapCache

protected javax.cache.Cache structuredContentMapCache

Constructor Details

ContentItemServiceImpl

public ContentItemServiceImpl()

Method Details

getIncludeNonOverriddenSCItemsFlag

protected boolean getIncludeNonOverriddenSCItemsFlag()

findContentItemById

public ContentItem findContentItemById(Long id)

Description copied from interface: ContentItemService

Returns the ContentItem that has the given id

Specified by:

findContentItemById in interface ContentItemService

Returns:

the ContentItem

findOverrideContentItemByContentItemId

public OverrideContentItem findOverrideContentItemByContentItemId(Long contentItemId)

Description copied from interface: ContentItemService

Returns the appropriate OverrideContentItem for the given ContentItem id

Specified by:

findOverrideContentItemByContentItemId in interface ContentItemService

Returns:

the OverrideContentItem

saveContentItem

public ContentItem saveContentItem(ContentItem contentItem)

Description copied from interface: ContentItemService

Saves a ContentItem and returns the saved version

Specified by:

saveContentItem in interface ContentItemService

Returns:

the saved ContentItem

readOverrideContentItemById

public OverrideContentItem readOverrideContentItemById(Long id)

Description copied from interface: ContentItemService

Returns the OverrideContentItem that has the given id

Specified by:

readOverrideContentItemById in interface ContentItemService

Returns:

the OverrideContentItem

generateContentItemByOverrideContentItem

public ContentItem generateContentItemByOverrideContentItem(OverrideContentItem overrideContentItem)

Description copied from interface: ContentItemService

Creates a transient ContentItem that takes into consideration the overrides present in the given OverrideContentItem. This method will iterate through the OverrideSCItems in the override content item and generate a content item that has the overrides in place.

This method is used to allow downstream code to only think about rendering a content item and not have to worry about handling things differently if there is an override content item present.

Specified by:

generateContentItemByOverrideContentItem in interface ContentItemService

Returns:

the generated ContentItem

generateContentItemFields

protected List<StructuredContentContentItemXref> generateContentItemFields(OverrideContentItem overrideContentItem,
 ContentItem clonedCI)

generateSCCIXref

protected List<StructuredContentContentItemXref> generateSCCIXref(OverrideContentItem overrideContentItem,
 ContentItem clonedCI)

findAllOverrideContentItemsByContentItemId

public List<OverrideContentItem> findAllOverrideContentItemsByContentItemId(Long contentItemId)

Description copied from interface: ContentItemService

Returns a list of all OverrideContentItems

Specified by:

findAllOverrideContentItemsByContentItemId in interface ContentItemService

Returns:

the list of all OverrideContentItems

createContentItemDTOFromContentItem

public ContentItemDTO createContentItemDTOFromContentItem(boolean secure,
 Map<String,Object> args,
 ContentItem ci)

Description copied from interface: ContentItemService

Creates a ContentItemDTO from the passed in ContentItem and caches it

Specified by:

createContentItemDTOFromContentItem in interface ContentItemService

Returns:

setStructuredContentForDTO

public void setStructuredContentForDTO(ContentItem contentItem,
 boolean isSecure,
 ContentItemDTO ciDto)

Adds StructuredContentDTO to ContentItemDTO

Specified by:

setStructuredContentForDTO in interface ContentItemService

Parameters:

contentItem -

ciDto -

isSecure -

utilizeCache

protected List<org.broadleafcommerce.common.structure.dto.StructuredContentDTO> utilizeCache(ContentItem contentItem,
 boolean isSecure,
 ContentItemDTO ciDto)

setMasterStructuredContentDTOs

protected void setMasterStructuredContentDTOs(ContentItemDTO ciDto)

isMasterContentData

protected boolean isMasterContentData(org.broadleafcommerce.common.structure.dto.StructuredContentDTO scDto)

createStructuredContentDTOs

protected List<org.broadleafcommerce.common.structure.dto.StructuredContentDTO> createStructuredContentDTOs(ContentItem ci,
 boolean isSecure)

Creates StructuredContentDTO objects.

Parameters:

ci -

isSecure -

Returns:

setStructuredContentDTOTranslations

protected void setStructuredContentDTOTranslations(ContentItem contentItem,
 List<org.broadleafcommerce.common.structure.dto.StructuredContentDTO> dtos)

Parameters:

contentItem -

dtos -

translateStructuredContentDTO

protected void translateStructuredContentDTO(org.broadleafcommerce.common.structure.dto.StructuredContentDTO dto,
 ContentItem contentItem)

Parameters:

dto -

contentItem -

isValueObjectTranslatable

protected boolean isValueObjectTranslatable(Object value)

Parameters:

value -

Returns:

sortDTOsByPriority

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

getClonedContentItemDTO

public ContentItemDTO getClonedContentItemDTO(ContentItemDTO ciDto)

Description copied from interface: ContentItemService

When passing in the ContentItemDTO to the post retrieval method we clone the DTO to prevent unwanted changes to the original. With this hook point implementors can override this behavior if needed.

Specified by:

getClonedContentItemDTO in interface ContentItemService

Returns:

postRetrievalContentItemModification

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

Description copied from interface: ContentItemService

Used to modify the ContentItemDTO created. This allows for a hook point to allow implementors to add custom logic to change, add, remove any element(s) in this DTO.

The default implementation does not make any modifications.

One example would be to modify the StructuredContentDTO that has been retrieved with the ContentItem. The list can be filtered, reordered, etc.

Specified by:

postRetrievalContentItemModification in interface ContentItemService

Returns:

hydrateForeignLookups

public List<org.broadleafcommerce.common.structure.dto.StructuredContentDTO> hydrateForeignLookups(List<org.broadleafcommerce.common.structure.dto.StructuredContentDTO> dtos)

Description copied from interface: ContentItemService

StructuredContentDTO objects are sometimes cached in the StructuredContentService. Furthermore, this cached version contains information about the kind of value the DTO might hold. In the cases where the value is a foreign key lookup, we want to get the object that it represents and set that as the internal value. However, since these DTOs are not Hibernate entities and are possibly stored in a cache, we need to load the target object on each request to avoid lazy initialization exceptions. This method performs that hydration.

Specified by:

hydrateForeignLookups in interface ContentItemService

Returns:

the same list that was passed in

lookupStructuredContentDTOsFromCache

protected List<org.broadleafcommerce.common.structure.dto.StructuredContentDTO> lookupStructuredContentDTOsFromCache(ContentItemDTO contentItemDto,
 ContentItem item,
 boolean secure)

buildCacheKey

protected String buildCacheKey(ContentItemDTO contentItemDto,
 ContentItem item)

buildCacheKeys

protected List<String> buildCacheKeys(ContentItemDTO contentItemDto,
 ContentItem item)

buildMapKey

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

getCacheKey

protected String getCacheKey(String cacheKey,
 org.broadleafcommerce.common.extension.ResultType resultType)

getCacheKeys

protected List<String> getCacheKeys(String cacheKey,
 org.broadleafcommerce.common.extension.ResultType resultType)

getResultType

protected org.broadleafcommerce.common.extension.ResultType getResultType(Object object)

removeContentItemFromCache

public boolean removeContentItemFromCache(ContentItem contentItem)

Description copied from interface: ContentItemService

Removes the passed in contentItem (and its associated StructuredContent items) from cache

Specified by:

removeContentItemFromCache in interface ContentItemService

addStructuredContentDTOsToCache

protected void addStructuredContentDTOsToCache(ContentItemDTO contentItemDto,
 ContentItem item,
 boolean secure)

getStructuredContentMapCache

protected javax.cache.Cache getStructuredContentMapCache()

createContentItemDto

protected ContentItemDTO createContentItemDto(ContentItem contentItem)

Creates the ContentItemDTO given a contentItem.