de.hybris.platform.cockpit.services.sync.impl

Class SynchronizationServiceImpl

java.lang.Object

de.hybris.platform.cockpit.services.impl.AbstractServiceImpl

de.hybris.platform.cockpit.services.sync.impl.SynchronizationServiceImpl

All Implemented Interfaces:

SynchronizationService

Direct Known Subclasses:

BTGSynchronizationService, CMSSynchronizationService

public class SynchronizationServiceImpl
extends AbstractServiceImpl
implements SynchronizationService

Contains all necessary method responsible for synchronization activity

Spring Bean ID:

synchronizationService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SynchronizationServiceImpl.CockpitDummySyncConfigurator
protected class	SynchronizationServiceImpl.SyncContextImpl
protected class	SynchronizationServiceImpl.SyncInfo

Nested classes/interfaces inherited from interface de.hybris.platform.cockpit.services.sync.SynchronizationService

SynchronizationService.SyncContext

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISABLE_RESTRICTION

Fields inherited from class de.hybris.platform.cockpit.services.impl.AbstractServiceImpl

modelService, typeService

Fields inherited from interface de.hybris.platform.cockpit.services.sync.SynchronizationService

INITIAL_SYNC_IS_NEEDED, SYNCHRONIZATION_NOT_AVAILABLE, SYNCHRONIZATION_NOT_OK, SYNCHRONIZATION_OK

Constructor Summary

Constructors

Constructor and Description
SynchronizationServiceImpl()

Method Summary

Modifier and Type	Method and Description
protected boolean	checkRootOrSubType(TypedObject item, SyncItemJob syncJob)
Map<String,String>[]	getAllSynchronizationRules(Collection items) Retrieves all matching synchronization rules (at first position - all accessible, at second position - all forbidden)
CatalogManager	getCatalogManager()
CatalogVersionModel	getCatalogVersionForItem(TypedObject item) Retrieves source catalog version for given item
protected List<String>	getConfiguredReferenceTypes(TypedObject typedObject) Returns configured reference types.
Long	getLastTargetProductSyncTimestamp(Item product) Retrieves a time of last executed synchronization on the given product
int	getPullSyncStatus(TypedObject product)
protected List<TypedObject>	getRelatedReferences(TypedObject typedObject) Retrieves all related references according to current configuration.
protected int	getRelatedReferencesMaxDepth()
protected Map<String,List<String>>	getRelatedReferencesTypesMap()
SynchronizationService.SyncContext	getSyncContext(TypedObject product)
SynchronizationService.SyncContext	getSyncContext(TypedObject product, boolean pullSync)
List<String>	getSynchronizationStatuses(List<SyncItemJobModel> rules, TypedObject sourceObject) Retrieves synchronization statuses for given item
List<String>	getSynchronizationStatusesSimple(List<SyncItemJobModel> rules, TypedObject sourceObject)
protected SynchronizationServiceImpl.SyncInfo	getSyncInfo(TypedObject object)
protected SynchronizationServiceImpl.SyncInfo	getSyncInfoSimple(TypedObject object)
List<SyncItemJobModel>[]	getSyncJobs(ItemModel source, ObjectType objectType) Methods retrieves all matching catalog version (at first position - all accessible, at second position - all forbidden)
Collection<TypedObject>	getSyncSources(TypedObject object) Gets the all sync source objects.
Collection<TypedObject>	getSyncSourcesAndTargets(TypedObject object)
Collection<TypedObject>	getSyncTargets(TypedObject object) Gets the all sync targets.
SystemService	getSystemService()
List<SyncItemJobModel>[]	getTargetCatalogVersions(TypedObject item) Methods retrieves all matching catalog version (at first position - all accessible, at second position - all forbidden)
TypeManager	getTypeManager()
boolean	hasMultipleRules(Collection items) Check whether some of passed items has ambigous synchronization rule
int	isObjectSynchronized(TypedObject object) TODO FIXME - Find way to get appropriate synchronization status, condition that is used below is not correct.
protected Boolean	isSearchRestrictionDisabled() Checks if the restrictions should be disabled for the internal search operations of the service.
boolean	isVersionSynchronizedAtLeastOnce(List list) Checks whether particular product version was synchronized at least once!
void	performCatalogVersionSynchronization(Collection<CatalogVersionModel> data, List<String> syncRulePkList, CatalogVersionModel targetCatalogVersion, String qualifier) Responsible for catalog version synchronization //TODO should be refactor
void	performPullSynchronization(List<TypedObject> targetItems)
Collection<TypedObject>	performSynchronization(Collection<? extends Object> items, List<String> syncJobPkList, CatalogVersionModel targetCatalogVersion, String qualifier) Method that runs particular synchronization
<E extends TypedObject> CatalogVersion	retrieveCatalogVersion(E item) Retrieves source catalog version for given product
void	setItemSyncTimestampDao(ItemSyncTimestampDao itemSyncTimestampDao)
void	setRelatedReferencesMaxDepth(int relatedReferencesMaxDepth)
void	setRelatedReferencesTypesMap(Map<String,List<String>> relatedReferencesTypesMap)
void	setSearchRestrictionsDisabled(boolean disabled)
void	setSynchronizationServiceDao(SynchronizationServiceDao synchronizationServiceDao) Sets the synchronization service DAO.
void	setSystemService(SystemService systemService)
void	setValueHandlerRegistry(ObjectValueHandlerRegistry valueHandlerRegistry)

Methods inherited from class de.hybris.platform.cockpit.services.impl.AbstractServiceImpl

getEnum, getEnums, getLocalizedLabel, getLocalizedLabel, getModelService, getTypeService, setCockpitTypeService, setLabelResolver, setModelService

Methods inherited from class java.lang.Object

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

Field Detail

DISABLE_RESTRICTION

public static final String DISABLE_RESTRICTION

See Also:

Constant Field Values

Constructor Detail

SynchronizationServiceImpl

public SynchronizationServiceImpl()

Method Detail

getRelatedReferencesTypesMap

protected Map<String,List<String>> getRelatedReferencesTypesMap()

setRelatedReferencesTypesMap

public void setRelatedReferencesTypesMap(Map<String,List<String>> relatedReferencesTypesMap)

getRelatedReferencesMaxDepth

protected int getRelatedReferencesMaxDepth()

setRelatedReferencesMaxDepth

public void setRelatedReferencesMaxDepth(int relatedReferencesMaxDepth)

getTypeManager

public TypeManager getTypeManager()

getCatalogManager

public CatalogManager getCatalogManager()

getSyncSources

public Collection<TypedObject> getSyncSources(TypedObject object)

Description copied from interface: SynchronizationService

Gets the all sync source objects.

Specified by:

getSyncSources in interface SynchronizationService

Parameters:

object - the object

Returns:

the sync sources

getSyncTargets

public Collection<TypedObject> getSyncTargets(TypedObject object)

Description copied from interface: SynchronizationService

Gets the all sync targets.

Specified by:

getSyncTargets in interface SynchronizationService

Parameters:

object - the object

Returns:

the sync targets

getSyncSourcesAndTargets

public Collection<TypedObject> getSyncSourcesAndTargets(TypedObject object)

Specified by:

getSyncSourcesAndTargets in interface SynchronizationService

performPullSynchronization

public void performPullSynchronization(List<TypedObject> targetItems)

Specified by:

performPullSynchronization in interface SynchronizationService

performSynchronization

public Collection<TypedObject> performSynchronization(Collection<? extends Object> items,
                                                      List<String> syncJobPkList,
                                                      CatalogVersionModel targetCatalogVersion,
                                                      String qualifier)

Description copied from interface: SynchronizationService

Method that runs particular synchronization

Specified by:

performSynchronization in interface SynchronizationService

Parameters:

items - - products passed for synchronizations

Returns:

the collection of typed objects which were affected by the sync, i.e. which may need to be updated

retrieveCatalogVersion

public <E extends TypedObject> CatalogVersion retrieveCatalogVersion(E item)

Retrieves source catalog version for given product

Parameters:

item - - passed item

getPullSyncStatus

public int getPullSyncStatus(TypedObject product)

Specified by:

getPullSyncStatus in interface SynchronizationService

isObjectSynchronized

public final int isObjectSynchronized(TypedObject object)

TODO FIXME - Find way to get appropriate synchronization status, condition that is used below is not correct. Maybe there are or will be some core mechanisms to achieve that! Checks whether given product is synchronized

Specified by:

isObjectSynchronized in interface SynchronizationService

Parameters:

object - - passed item

getSyncInfo

protected SynchronizationServiceImpl.SyncInfo getSyncInfo(TypedObject object)

getSyncInfoSimple

protected SynchronizationServiceImpl.SyncInfo getSyncInfoSimple(TypedObject object)

isVersionSynchronizedAtLeastOnce

public boolean isVersionSynchronizedAtLeastOnce(List list)

Checks whether particular product version was synchronized at least once!

Specified by:

isVersionSynchronizedAtLeastOnce in interface SynchronizationService

getLastTargetProductSyncTimestamp

public Long getLastTargetProductSyncTimestamp(Item product)

Retrieves a time of last executed synchronization on the given product

Parameters:

product - - passed product

Returns:

- time in milliseconds

isSearchRestrictionDisabled

protected Boolean isSearchRestrictionDisabled()

Checks if the restrictions should be disabled for the internal search operations of the service. By default the method returns TRUE. You can change this behavior by setting false value using setSearchRestrictionsDisabled(boolean) injection.

checkRootOrSubType

protected boolean checkRootOrSubType(TypedObject item,
                                     SyncItemJob syncJob)

getTargetCatalogVersions

public List<SyncItemJobModel>[] getTargetCatalogVersions(TypedObject item)

Description copied from interface: SynchronizationService

Methods retrieves all matching catalog version (at first position - all accessible, at second position - all forbidden)

Specified by:

getTargetCatalogVersions in interface SynchronizationService

getSyncJobs

public List<SyncItemJobModel>[] getSyncJobs(ItemModel source,
                                            ObjectType objectType)

Description copied from interface: SynchronizationService

Methods retrieves all matching catalog version (at first position - all accessible, at second position - all forbidden)

Specified by:

getSyncJobs in interface SynchronizationService

getCatalogVersionForItem

public CatalogVersionModel getCatalogVersionForItem(TypedObject item)

Description copied from interface: SynchronizationService

Retrieves source catalog version for given item

Specified by:

getCatalogVersionForItem in interface SynchronizationService

Parameters:

item - - passed item

getAllSynchronizationRules

public Map<String,String>[] getAllSynchronizationRules(Collection items)

Description copied from interface: SynchronizationService

Retrieves all matching synchronization rules (at first position - all accessible, at second position - all forbidden)

Specified by:

getAllSynchronizationRules in interface SynchronizationService

See Also:

SynchronizationService.getAllSynchronizationRules(java.util.Collection)

getSynchronizationStatuses

public List<String> getSynchronizationStatuses(List<SyncItemJobModel> rules,
                                               TypedObject sourceObject)

Description copied from interface: SynchronizationService

Retrieves synchronization statuses for given item

Specified by:

getSynchronizationStatuses in interface SynchronizationService

Parameters:

rules - - accessible synch rules

sourceObject - - current checked object

Returns:

list of primary keys

getSynchronizationStatusesSimple

public List<String> getSynchronizationStatusesSimple(List<SyncItemJobModel> rules,
                                                     TypedObject sourceObject)

performCatalogVersionSynchronization

public void performCatalogVersionSynchronization(Collection<CatalogVersionModel> data,
                                                 List<String> syncRulePkList,
                                                 CatalogVersionModel targetCatalogVersion,
                                                 String qualifier)

Responsible for catalog version synchronization //TODO should be refactor

Specified by:

performCatalogVersionSynchronization in interface SynchronizationService

hasMultipleRules

public boolean hasMultipleRules(Collection items)

Description copied from interface: SynchronizationService

Check whether some of passed items has ambigous synchronization rule

Specified by:

hasMultipleRules in interface SynchronizationService

Parameters:

items - - passed items

See Also:

SynchronizationService.hasMultipleRules(java.util.Collection)

getSyncContext

public SynchronizationService.SyncContext getSyncContext(TypedObject product)

Specified by:

getSyncContext in interface SynchronizationService

getSyncContext

public SynchronizationService.SyncContext getSyncContext(TypedObject product,
                                                         boolean pullSync)

Specified by:

getSyncContext in interface SynchronizationService

setSynchronizationServiceDao

public void setSynchronizationServiceDao(SynchronizationServiceDao synchronizationServiceDao)

Sets the synchronization service DAO.

Parameters:

synchronizationServiceDao - the synchronizationServiceDao to set

getRelatedReferences

protected List<TypedObject> getRelatedReferences(TypedObject typedObject)

Retrieves all related references according to current configuration.

Note:
This method retrieves all related references that take a part into synch status computation.

Parameters:

typedObject - given object

Returns:

related references

getConfiguredReferenceTypes

protected List<String> getConfiguredReferenceTypes(TypedObject typedObject)

Returns configured reference types.

Parameters:

typedObject - given object

Returns:

configured reference types

setSearchRestrictionsDisabled

public void setSearchRestrictionsDisabled(boolean disabled)

setItemSyncTimestampDao

public void setItemSyncTimestampDao(ItemSyncTimestampDao itemSyncTimestampDao)

getSystemService

public SystemService getSystemService()

setSystemService

public void setSystemService(SystemService systemService)

setValueHandlerRegistry

public void setValueHandlerRegistry(ObjectValueHandlerRegistry valueHandlerRegistry)