Package de.hybris.platform.cmsfacades.synchronization.impl

Class DefaultItemSynchronizationFacade

java.lang.Object

de.hybris.platform.cmsfacades.synchronization.impl.DefaultItemSynchronizationFacade

All Implemented Interfaces:

ItemSynchronizationFacade

public class DefaultItemSynchronizationFacade
extends Object
implements ItemSynchronizationFacade

Default implementation of the ItemSynchronizationFacade facade. Its main purpose is to coordinate the recursive calls for the ItemSynchronizationService respecting the maxDepth attribute (either given in the method or using the default value). It makes usage of the ItemCollectorRegistry and ItemCollector classes to identify item models that are directly referenced or that are shared by a given item model.

Constructor Summary

Constructors

Constructor	Description
DefaultItemSynchronizationFacade()

Method Summary

Modifier and Type	Method	Description
protected List<SyncItemStatusData>	collectItemsAndGetSynchronizationItemStatus(SyncRequestData syncRequestData, ItemModel item, SyncItemStatusConfig config, Integer level, ItemCollectorRegistry collectorRegistry)	Collects the items that also requires information about the synchronization status details and make more calls to getSynchronizationItemStatus(SyncRequestData, ItemModel, SyncItemStatusConfig, Integer) from individual items that were collected.
protected List<SyncItemStatusData>	findUnavailableDependencies(SyncRequestData syncRequestData, ItemModel item, Integer level)	Find all dependent items which have never been synchronized to the target catalog.
protected ItemCollectorRegistry	getBasicItemCollectorRegistry()
protected org.springframework.validation.Validator	getCatalogSynchronizationCompositeValidator()
protected org.springframework.validation.Validator	getCmsItemSynchronizationValidator()
protected ItemCollectorRegistry	getDependentItemCollectorRegistry()
protected FacadeValidationService	getFacadeValidationService()
protected ItemModel	getItem(ItemSynchronizationData itemSynchronizationData)	Will convert a itemId/itemType pair to a of ItemModel
protected ItemSynchronizationService	getItemSynchronizationService()
protected List<ItemModel>	getListOfItems(SynchronizationData synchronizationData)	Will convert a list of itemId/itemType pairs to a list of ItemModel
protected SessionSearchRestrictionsDisabler	getSessionSearchRestrictionsDisabler()
protected ItemCollectorRegistry	getSharedItemCollectorRegistry()
protected SyncConfig	getSyncConfig()
SynchronizationCacheService	getSynchronizationCacheService()
SyncItemStatusData	getSynchronizationItemStatus(SyncRequestData syncRequestData, ItemSynchronizationData itemSynchronizationData)	Retrieves the synchronization status for a given ItemModel.
SyncItemStatusData	getSynchronizationItemStatus(SyncRequestData syncRequestData, ItemSynchronizationData itemSynchronizationData, SyncItemStatusConfig config)	Retrieves the synchronization status for a given ItemModel.
protected SyncItemStatusData	getSynchronizationItemStatus(SyncRequestData syncRequestData, ItemModel item, SyncItemStatusConfig config, Integer level)	Gets the synchronization status by calling ItemSynchronizationService.getSynchronizationItemStatus(SyncRequestData, ItemModel).
protected SyncItemStatusConfig	getSyncItemStatusConfig()
protected Converter<SynchronizationItemDetailsData,SyncItemStatusData>	getSyncItemStatusConverter()
protected UniqueItemIdentifierService	getUniqueItemIdentifierService()
void	performItemSynchronization(SyncRequestData syncRequestData, SynchronizationData synchronizationData)	Performs the synchronization for a list of ItemModel.
void	performItemSynchronization(SyncRequestData syncRequestData, SynchronizationData synchronizationData, SyncConfig config)	Performs the synchronization for a list of ItemModel.
void	setBasicItemCollectorRegistry(ItemCollectorRegistry basicItemCollectorRegistry)
void	setCatalogSynchronizationCompositeValidator(org.springframework.validation.Validator catalogSynchronizationCompositeValidator)
void	setCmsItemSynchronizationValidator(org.springframework.validation.Validator cmsItemSynchronizationValidator)
void	setDependentItemCollectorRegistry(ItemCollectorRegistry dependentItemCollectorRegistry)
void	setFacadeValidationService(FacadeValidationService facadeValidationService)
void	setItemSynchronizationService(ItemSynchronizationService itemSynchronizationService)
void	setSessionSearchRestrictionsDisabler(SessionSearchRestrictionsDisabler sessionSearchRestrictionsDisabler)
void	setSharedItemCollectorRegistry(ItemCollectorRegistry sharedItemCollectorRegistry)
void	setSyncConfig(SyncConfig syncConfig)
void	setSynchronizationCacheService(SynchronizationCacheService synchronizationCacheService)
void	setSyncItemStatusConfig(SyncItemStatusConfig syncItemStatusConfig)
void	setSyncItemStatusConverter(Converter<SynchronizationItemDetailsData,SyncItemStatusData> syncItemStatusConverter)
void	setUniqueItemIdentifierService(UniqueItemIdentifierService uniqueItemIdentifierService)

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultItemSynchronizationFacade

public DefaultItemSynchronizationFacade()

Method Details

getSynchronizationItemStatus

public SyncItemStatusData getSynchronizationItemStatus(SyncRequestData syncRequestData,
 ItemSynchronizationData itemSynchronizationData)

Description copied from interface: ItemSynchronizationFacade

Retrieves the synchronization status for a given ItemModel. In the method signature the client needs to provide the SyncRequestData which contains the source and target catalog versions. The implementation should provide a default maximum depth property to prevent the mechanism to crawl too many items.

Specified by:

getSynchronizationItemStatus in interface ItemSynchronizationFacade

Parameters:

syncRequestData - the synchronization request containing the source and target catalog versions

itemSynchronizationData - the pair of identifier/type to retrieve the ItemModel of which we want to get the synchronization status

Returns:

the synchronization status details for a given ItemModel.

getSynchronizationItemStatus

public SyncItemStatusData getSynchronizationItemStatus(SyncRequestData syncRequestData,
 ItemSynchronizationData itemSynchronizationData,
 SyncItemStatusConfig config)

Description copied from interface: ItemSynchronizationFacade

Retrieves the synchronization status for a given ItemModel. In the method signature the client needs to provide the SyncRequestData which contains the source and target catalog versions. This method lets the client decide what is the maximum depth level to navigate on the item's dependencies.

Specified by:

getSynchronizationItemStatus in interface ItemSynchronizationFacade

Parameters:

syncRequestData - the synchronization request containing the source and target catalog versions

itemSynchronizationData - the pair of identifier/type to retrieve the ItemModel of which we want to get the synchronization status

config - the get status configuration. See SyncItemStatusConfig for more details.

Returns:

the synchronization status details for a given ItemModel.

performItemSynchronization

public void performItemSynchronization(SyncRequestData syncRequestData,
 SynchronizationData synchronizationData)

Description copied from interface: ItemSynchronizationFacade

Performs the synchronization for a list of ItemModel. In the method signature the client needs to provide the SyncRequestData which contains the source and target catalog versions.

Specified by:

performItemSynchronization in interface ItemSynchronizationFacade

Parameters:

syncRequestData - the synchronization request containing the source and target catalog versions

synchronizationData - contains the list of ItemSynchronizationData pairs of itemId/itemType that we want to synchronize

performItemSynchronization

public void performItemSynchronization(SyncRequestData syncRequestData,
 SynchronizationData synchronizationData,
 SyncConfig config)

Description copied from interface: ItemSynchronizationFacade

Performs the synchronization for a list of ItemModel. In the method signature the client needs to provide the SyncRequestData which contains the source and target catalog versions.

Specified by:

performItemSynchronization in interface ItemSynchronizationFacade

Parameters:

syncRequestData - the synchronization request containing the source and target catalog versions

synchronizationData - contains the list of pairs of ItemSynchronizationData itemId/itemType that we want to synchronize

config - the synchronization configuration . See SyncConfig for more details.

getListOfItems

protected List<ItemModel> getListOfItems(SynchronizationData synchronizationData)

Will convert a list of itemId/itemType pairs to a list of ItemModel

Parameters:

synchronizationData - the list of ItemSynchronizationData candidates on which to perform synchronization

Returns:

the list of ItemModel to be synchronized

getItem

protected ItemModel getItem(ItemSynchronizationData itemSynchronizationData)

Will convert a itemId/itemType pair to a of ItemModel

Parameters:

itemSynchronizationData - the ItemSynchronizationData candidate on which to perform synchronization

Returns:

the ItemModel to be synchronized

getSynchronizationItemStatus

protected SyncItemStatusData getSynchronizationItemStatus(SyncRequestData syncRequestData,
 ItemModel item,
 SyncItemStatusConfig config,
 Integer level)

Gets the synchronization status by calling ItemSynchronizationService.getSynchronizationItemStatus(SyncRequestData, ItemModel). It also converts the result into an instance of SyncItemStatusData that will be then post populated by recursive calls to this method.

Parameters:

syncRequestData - the synchronization request data containing the source and target catalog versions.

item - the item model currently being inspected

config - the configuration for getting the synchronization status

level - the current level on the data structure.

Returns:

the SyncItemStatusData information about a given item model and all related items collected during execution.

findUnavailableDependencies

protected List<SyncItemStatusData> findUnavailableDependencies(SyncRequestData syncRequestData,
 ItemModel item,
 Integer level)

Find all dependent items which have never been synchronized to the target catalog.

Parameters:

syncRequestData - the synchronization request data containing the source and target catalog versions.

item - the item model currently being inspected

level - the current level on the data structure

Returns:

a list of SyncItemStatusData for never-synchronized dependent items

collectItemsAndGetSynchronizationItemStatus

protected List<SyncItemStatusData> collectItemsAndGetSynchronizationItemStatus(SyncRequestData syncRequestData,
 ItemModel item,
 SyncItemStatusConfig config,
 Integer level,
 ItemCollectorRegistry collectorRegistry)

Collects the items that also requires information about the synchronization status details and make more calls to getSynchronizationItemStatus(SyncRequestData, ItemModel, SyncItemStatusConfig, Integer) from individual items that were collected.

Parameters:

syncRequestData - the synchronization request data containing the source and target catalog versions.

item - the item model currently being inspected

config - the configuration for getting the synchronization status

level - the current level on the data structure.

collectorRegistry - the collector registry to get an instance of ItemCollector

Returns:

a list of SyncItemStatusData beans collected and converted recursively.

getBasicItemCollectorRegistry

protected ItemCollectorRegistry getBasicItemCollectorRegistry()

setBasicItemCollectorRegistry

public void setBasicItemCollectorRegistry(ItemCollectorRegistry basicItemCollectorRegistry)

getSharedItemCollectorRegistry

protected ItemCollectorRegistry getSharedItemCollectorRegistry()

setSharedItemCollectorRegistry

public void setSharedItemCollectorRegistry(ItemCollectorRegistry sharedItemCollectorRegistry)

getDependentItemCollectorRegistry

protected ItemCollectorRegistry getDependentItemCollectorRegistry()

setDependentItemCollectorRegistry

public void setDependentItemCollectorRegistry(ItemCollectorRegistry dependentItemCollectorRegistry)

setItemSynchronizationService

public void setItemSynchronizationService(ItemSynchronizationService itemSynchronizationService)

getItemSynchronizationService

protected ItemSynchronizationService getItemSynchronizationService()

getSyncItemStatusConverter

protected Converter<SynchronizationItemDetailsData,SyncItemStatusData> getSyncItemStatusConverter()

setSyncItemStatusConverter

public void setSyncItemStatusConverter(Converter<SynchronizationItemDetailsData,SyncItemStatusData> syncItemStatusConverter)

getSyncItemStatusConfig

protected SyncItemStatusConfig getSyncItemStatusConfig()

setSyncItemStatusConfig

public void setSyncItemStatusConfig(SyncItemStatusConfig syncItemStatusConfig)

setSyncConfig

public void setSyncConfig(SyncConfig syncConfig)

getSyncConfig

protected SyncConfig getSyncConfig()

setUniqueItemIdentifierService

public void setUniqueItemIdentifierService(UniqueItemIdentifierService uniqueItemIdentifierService)

getUniqueItemIdentifierService

protected UniqueItemIdentifierService getUniqueItemIdentifierService()

getCatalogSynchronizationCompositeValidator

protected org.springframework.validation.Validator getCatalogSynchronizationCompositeValidator()

setCatalogSynchronizationCompositeValidator

public void setCatalogSynchronizationCompositeValidator(org.springframework.validation.Validator catalogSynchronizationCompositeValidator)

getFacadeValidationService

protected FacadeValidationService getFacadeValidationService()

setFacadeValidationService

public void setFacadeValidationService(FacadeValidationService facadeValidationService)

getCmsItemSynchronizationValidator

protected org.springframework.validation.Validator getCmsItemSynchronizationValidator()

setCmsItemSynchronizationValidator

public void setCmsItemSynchronizationValidator(org.springframework.validation.Validator cmsItemSynchronizationValidator)

getSessionSearchRestrictionsDisabler

protected SessionSearchRestrictionsDisabler getSessionSearchRestrictionsDisabler()

setSessionSearchRestrictionsDisabler

public void setSessionSearchRestrictionsDisabler(SessionSearchRestrictionsDisabler sessionSearchRestrictionsDisabler)

getSynchronizationCacheService

public SynchronizationCacheService getSynchronizationCacheService()

setSynchronizationCacheService

public void setSynchronizationCacheService(SynchronizationCacheService synchronizationCacheService)