Package de.hybris.platform.catalog.jalo

Class SyncItemJob

java.lang.Object

de.hybris.platform.util.BridgeAbstraction

de.hybris.platform.jalo.Item

de.hybris.platform.jalo.ExtensibleItem

de.hybris.platform.jalo.c2l.LocalizableItem

de.hybris.platform.jalo.GenericItem

de.hybris.platform.cronjob.jalo.GeneratedJob

de.hybris.platform.cronjob.jalo.Job

de.hybris.platform.catalog.jalo.GeneratedSyncItemJob

de.hybris.platform.catalog.jalo.SyncItemJob

All Implemented Interfaces:

TriggerableJob, Serializable, Comparable

Direct Known Subclasses:

GeneratedCatalogVersionSyncJob

@Deprecated(since="ages",
            forRemoval=false)
public class SyncItemJob
extends GeneratedSyncItemJob
implements TriggerableJob

Deprecated.

since ages - useCatalogVersionSyncJob instead

Superclass for job which synchronizes content of a catalog version to another catalog version.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SyncItemJob.CompletionInfo	Deprecated. CompletionInfo
static class	SyncItemJob.ModifiedItemsPair	Deprecated. ModifiedItemsPair
static class	SyncItemJob.SyncAttributeDescriptorConfigData	Deprecated.
class	SyncItemJob.SyncItemCopyContext	Deprecated. Own copy context from inside the job.

Nested classes/interfaces inherited from class de.hybris.platform.cronjob.jalo.Job

Job.JobFileLogContainer, Job.Synchronicity

Nested classes/interfaces inherited from class de.hybris.platform.jalo.GenericItem

GenericItem.GenericItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LocalizableItem.LocalizableItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.ExtensibleItem

ExtensibleItem.ExtensibleItemImpl

Nested classes/interfaces inherited from class de.hybris.platform.jalo.Item

Item.AttributeFilter, Item.AttributeMode, Item.CachedGetter, Item.CachedSetter, Item.ItemAttributeMap, Item.ItemConstraint, Item.ItemImpl, Item.JaloCachedComputationException

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<String>	HIDDEN_ATTRIBUTES	Deprecated.
protected static final String	START_TIME	Deprecated.

Fields inherited from class de.hybris.platform.catalog.jalo.GeneratedSyncItemJob

CREATENEWITEMS, DEFAULT_INITIAL_ATTRIBUTES, EFFECTIVESYNCLANGUAGES, EXCLUSIVEMODE, EXECUTIONS, EXPORTATTRIBUTEDESCRIPTORS, REMOVEMISSINGITEMS, ROOTTYPES, SOURCEVERSION, SOURCEVERSIONHANDLER, SYNCATTRIBUTECONFIGURATIONS, SYNCITEMJOB2PRINCIPAL_MARKMODIFIED, SYNCITEMJOB2PRINCIPAL_SRC_ORDERED, SYNCITEMJOB2PRINCIPAL_TGT_ORDERED, SYNCJOB2LANGREL_MARKMODIFIED, SYNCJOB2LANGREL_SRC_ORDERED, SYNCJOB2LANGREL_TGT_ORDERED, SYNCJOB2TYPEREL_MARKMODIFIED, SYNCJOB2TYPEREL_SRC_ORDERED, SYNCJOB2TYPEREL_TGT_ORDERED, SYNCLANGUAGES, SYNCORDER, SYNCPRINCIPALS, SYNCPRINCIPALSONLY, TARGETVERSION, TARGETVERSIONHANDLER

Fields inherited from class de.hybris.platform.cronjob.jalo.Job

CTX_CURRENTCRONJOB, CTX_CURRENTJOB

Fields inherited from class de.hybris.platform.cronjob.jalo.GeneratedJob

ACTIVE, ALTERNATIVEDATASOURCEID, CHANGERECORDINGENABLED, CODE, CRONJOBS, CRONJOBSHANDLER, EMAILADDRESS, EMAILNOTIFICATIONTEMPLATE, ERRORMODE, LOGLEVELDATABASE, LOGLEVELFILE, LOGTODATABASE, LOGTOFILE, NODEGROUP, NODEID, NUMBEROFRETRIES, PRIORITY, REMOVEONEXIT, REQUESTABORT, REQUESTABORTSTEP, RESTRICTIONS, RESTRICTIONSHANDLER, RETRY, SENDEMAIL, SESSIONCONTEXTVALUES, SESSIONCURRENCY, SESSIONLANGUAGE, SESSIONUSER, SINGLEEXECUTABLE, TRIGGERS, TRIGGERSHANDLER, USEREADONLYDATASOURCE

Fields inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LANGUAGE_FALLBACK_ENABLED

Fields inherited from class de.hybris.platform.jalo.Item

_CREATION_TIME_INTERNAL, _MODIFIED_TIME_INTERNAL, accessorLog, CREATION_TIME, DISABLE_ATTRIBUTE_CHECK, DISABLE_ITEMCHECK_BEFORE_REMOVABLE, EVEN, FEATURE_ACCESSMAP_QUALIFIER, HJMPTS, INITIAL_CREATION_FLAG, isJaloOnly, MODIFIED_TIME, NEGATIVE, NOT_FOUND, OWNER, PK, POSITIVE, SAVE_FROM_SERVICE_LAYER, staticTransientObjects, TYPE

Fields inherited from class de.hybris.platform.util.BridgeAbstraction

impl, tenant

Constructor Summary

Constructors

Constructor	Description
SyncItemJob()	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	addCatalogItemsToSync(SyncItemCronJob cronJob, Collection<? extends Item> items)	Deprecated. Added any catalog item except categories to a syncronization.
void	addCategoriesToSync(SyncItemCronJob cronJob, Collection<? extends Category> categories, boolean includeSubcategories, boolean includeProducts)	Deprecated.
protected List<ComposedType>	assureCatalogItemTypes(List<ComposedType> types)	Deprecated.
protected boolean	canSelectAttribute(AttributeDescriptor attributeDescriptor)	Deprecated.
protected boolean	canUndo(CronJob cronJob)	Deprecated. This job does not support undo!
protected boolean	checkCatalogVersionValidity(SyncItemCronJob cronJob, SyncItemJob.SyncItemCopyContext syncItemCopyContext)	Deprecated. Use this method to check if the given catalog version is valid for synchronization.
protected boolean	configAlreadyExists(AttributeDescriptor attributeDescriptor)	Deprecated. For SyncAttributeDescriptorConfig.createItem(SessionContext, ComposedType, de.hybris.platform.jalo.Item.ItemAttributeMap) .
protected void	configureFullSyncForItemType(SessionContext ctx, SyncItemCronJob cronJob, ComposedType type, String additionalQueryRestrictions, boolean removeMissing, boolean createNew, boolean forceUpdate, int range)	Deprecated. Configures a full synchronization of the items of a given type according to the specified sync cronjob settings.
void	configureFullVersionSync(SyncItemCronJob cronJob)	Deprecated. Collects all changes between the source and target version of this job.
protected void	copyItem(ItemCopyContext itemCopyContext, SyncItemCronJob cronJob, Item src, Item tgt)	Deprecated.
protected ItemCopyContext	createCopyContext(SyncItemCronJob cronJob, CatalogVersion srcV, CatalogVersion tgtV, Map<PK,PK> alreadyFinished)	Deprecated.
protected SyncAttributeDescriptorConfig	createDefaultConfigFor(SessionContext ctx, AttributeDescriptor attributeDescriptor)	Deprecated.
protected Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes)	Deprecated. Superclass method overridden to ensure initial attributes GeneratedSyncItemJob.SOURCEVERSION, and GeneratedSyncItemJob.TARGETVERSION.
protected SessionContext	createSyncSessionContext(SyncItemCronJob cronJob)	Deprecated. Returns a new SessionContext with the following settings. LANGUAGE: null DISABLE_RESTRICTIONS: false DISABLE_RESTRICTION_GROUP_INHERITANCE: false USE_FAST_ALGORITHMS: true DISABLE_ATTRIBUTE_CHECK: true DISABLE_SUBCATEGORY_REMOVALCHECK: true DISABLE_SETALLOWEDPRINCIPAL_RECURSIVELY: true LANGUAGE_FALLBACK_ENABLED: false TRANSACTION_4_ALLATTRIBUTES: false
protected CronJob.CronJobResult	doAbort(SyncItemCronJob cronJob)	Deprecated. This method is called if abort is requested by the user while still executing this job.
protected boolean	doSynchronization(SyncItemJob.SyncItemCopyContext syncItemCopyContext, SyncItemCronJob cronJob)	Deprecated. Executes actual synchronization.
protected String	getAdditionalQueryRestrictions(SessionContext ctx, ComposedType rootType, SyncItemCronJob cronJob)	Deprecated.
Map<AttributeDescriptor,Boolean>	getAllExportAttributeDescriptors(SessionContext ctx)	Deprecated. Getter for HMC editor - we pass a map { AttributeDescriptor -> Boolean }
protected List<List>	getAttributeAndConfigPairs()	Deprecated. Returns [AttributeDescriptor,SyncAttributeDescriptorConfig] pairs for all existing declared attribute descriptors and their sync config item if it exists for this job.
SyncItemJob.CompletionInfo	getCompletionInfo(SyncItemCronJob cronJob)	Deprecated.
SyncAttributeDescriptorConfig	getConfigFor(SessionContext ctx, AttributeDescriptor attributeDescriptor, boolean createOnDemand)	Deprecated. Returns the SyncAttributeDescriptorConfig instance which is responsible for all publication settings of the specified attribute descriptor.
SyncAttributeDescriptorConfig	getConfigFor(AttributeDescriptor attributeDescriptor, boolean createOnDemand)	Deprecated. Returns the SyncAttributeDescriptorConfig instance which is responsible for all publication settings of the specified attribute descriptor.
static List<ComposedType>	getDefaultRootTypes()	Deprecated. Provides the list of default root types.
protected int	getDuplicatedCatalogItemsCount(SessionContext ctx, CatalogVersion version, SyncItemCronJob cronJob, ComposedType type)	Deprecated.
Collection<Language>	getEffectiveSyncLanguages(SessionContext ctx)	Deprecated. Calculates current effective sync languages.
long	getElapsedMillis(SyncItemCronJob cronJob)	Deprecated.
Collection	getExecutions(SessionContext ctx)	Deprecated. Generated method - Getter of the SyncItemJob.executions attribute.
protected Set<Item>	getMissingTargetItems(Collection<? extends Item> sourceItems, Collection<? extends Item> targetItems, CatalogVersion sourceVersion)	Deprecated.
protected List<SyncItemJob.ModifiedItemsPair>	getModifiedCatalogItemPairs(SessionContext ctx, ComposedType type, int start, int range, boolean forceUpdate)	Deprecated.
protected List<SyncItemJob.ModifiedItemsPair>	getPossibleCatalogItemPairs(SessionContext ctx, ComposedType type, String additionalQueryRestrictions, int start, int range)	Deprecated.
List<ComposedType>	getRootTypes(SessionContext ctx)	Deprecated. Generated method - Getter of the SyncItemJob.rootTypes attribute.
protected List<PK>	getSingleVersionCatalogItems(SessionContext ctx, ComposedType type, String additionalQueryRestrictions, boolean fromSource, int start, int range)	Deprecated.
Collection<SyncAttributeDescriptorConfig>	getSyncAttributeConfigurations(SessionContext ctx)	Deprecated. Returns a collection containing a SyncAttributeDescriptorConfig instance for each declared attribute of any catalog item type.
protected void	initializeTimeCounter(SyncItemCronJob cronJob)	Deprecated.
boolean	isAbortable(CronJob conJob)	Deprecated. The SyncCatalogVersionJob supports aborting.
SyncItemCronJob	newExcecution()	Deprecated. since ages - please usenewExecution()
SyncItemCronJob	newExecution()	Deprecated. New execution.
protected CronJob.CronJobResult	performCronJob(CronJob cronJob)	Deprecated. You have to implement this method in your Job.
protected void	registerSynchronizedItem(SyncItemCronJob cronjob, Item source, Item copy, String message)	Deprecated. Registers a synchronized item pair permanently by creating a ChangeDescriptorfor them.
void	remove(SessionContext ctx)	Deprecated. Removes its ItemSyncTimestamp instances as well.
protected void	removeItem(ItemCopyContext itemCopyContext, SyncItemCronJob cronJob, Item removeItem)	Deprecated.
protected void	removeSyncTimestamps(SessionContext ctx)	Deprecated.
void	setAllExportAttributeDescriptors(SessionContext ctx, Map syncMap)	Deprecated. setter for HMC editor - we just set the 'includedInSync' attribute
void	setRootTypes(SessionContext ctx, List<ComposedType> value)	Deprecated. Overwritten to ensure that each root type is a catalog item type.
void	setSyncAttributeConfigurations(SessionContext ctx, Collection param)	Deprecated. Generated method - Setter of the SyncItemJob.syncAttributeConfigurations attribute.
protected List<PK[]>	toPendingItemsList(List<SyncItemJob.ModifiedItemsPair> itemPairs)	Deprecated.
protected List<PK[]>	toPendingItemsList(List<PK> itemPKs, boolean remove)	Deprecated.

Methods inherited from class de.hybris.platform.catalog.jalo.GeneratedSyncItemJob

addToRootTypes, addToRootTypes, addToSyncLanguages, addToSyncLanguages, addToSyncPrincipals, addToSyncPrincipals, getAllExportAttributeDescriptors, getDefaultAttributeModes, getEffectiveSyncLanguages, getExecutions, getRootTypes, getRootTypesCount, getRootTypesCount, getSourceVersion, getSourceVersion, getSyncAttributeConfigurations, getSyncLanguages, getSyncLanguages, getSyncLanguagesCount, getSyncLanguagesCount, getSyncOrder, getSyncOrder, getSyncOrderAsPrimitive, getSyncOrderAsPrimitive, getSyncPrincipals, getSyncPrincipals, getSyncPrincipalsCount, getSyncPrincipalsCount, getTargetVersion, getTargetVersion, isCreateNewItems, isCreateNewItems, isCreateNewItemsAsPrimitive, isCreateNewItemsAsPrimitive, isExclusiveMode, isExclusiveMode, isExclusiveModeAsPrimitive, isExclusiveModeAsPrimitive, isMarkModifiedDisabled, isRemoveMissingItems, isRemoveMissingItems, isRemoveMissingItemsAsPrimitive, isRemoveMissingItemsAsPrimitive, isSyncPrincipalsOnly, isSyncPrincipalsOnly, isSyncPrincipalsOnlyAsPrimitive, isSyncPrincipalsOnlyAsPrimitive, removeFromRootTypes, removeFromRootTypes, removeFromSyncLanguages, removeFromSyncLanguages, removeFromSyncPrincipals, removeFromSyncPrincipals, setAllExportAttributeDescriptors, setCreateNewItems, setCreateNewItems, setCreateNewItems, setCreateNewItems, setExclusiveMode, setExclusiveMode, setExclusiveMode, setExclusiveMode, setRemoveMissingItems, setRemoveMissingItems, setRemoveMissingItems, setRemoveMissingItems, setRootTypes, setSourceVersion, setSourceVersion, setSyncAttributeConfigurations, setSyncLanguages, setSyncLanguages, setSyncOrder, setSyncOrder, setSyncOrder, setSyncOrder, setSyncPrincipals, setSyncPrincipals, setSyncPrincipalsOnly, setSyncPrincipalsOnly, setSyncPrincipalsOnly, setSyncPrincipalsOnly, setTargetVersion, setTargetVersion

Methods inherited from class de.hybris.platform.cronjob.jalo.Job

canPerform, checkRemovable, configureCronjob, createLogContext, debug, error, fatal, getConfigAttributes, getCronJobsByCode, getCronJobsByCode, getCurrentLogContainer, getEffectiveLogLevel, getNonInitialAttributes, info, isDebugEnabled, isEnabledFor, isErrorEnabled, isInfoEnabled, isPerformable, isPerformable, isUndoable, isWarnEnabled, jobIsCurrentlyRunning, log, logToFile, perform, perform, perform, prepareAfterFinishEvent, prepareBeforeStartEvent, saveToLogFile, sendFinishedEvent, sendStartEvent, setCode, setCronJobs, setCurrentLogContainer, setNonInitialAttributes, startOwnSession, stopOwnSession, switchDataSource, undo, undo, undoCronJob, unsetAlternativeDataSource, unsetCurrentLogContainer, warn

Methods inherited from class de.hybris.platform.cronjob.jalo.GeneratedJob

addToRestrictions, addToRestrictions, addToTriggers, addToTriggers, getAlternativeDataSourceID, getAlternativeDataSourceID, getCode, getCode, getCronJobs, getCronJobs, getEmailAddress, getEmailAddress, getEmailNotificationTemplate, getEmailNotificationTemplate, getErrorMode, getErrorMode, getLogLevelDatabase, getLogLevelDatabase, getLogLevelFile, getLogLevelFile, getNodeGroup, getNodeGroup, getNodeID, getNodeID, getNodeIDAsPrimitive, getNodeIDAsPrimitive, getNumberOfRetries, getNumberOfRetries, getNumberOfRetriesAsPrimitive, getNumberOfRetriesAsPrimitive, getPriority, getPriority, getPriorityAsPrimitive, getPriorityAsPrimitive, getRestrictions, getRestrictions, getSessionCurrency, getSessionCurrency, getSessionLanguage, getSessionLanguage, getSessionUser, getSessionUser, getTriggers, getTriggers, isActive, isActive, isActiveAsPrimitive, isActiveAsPrimitive, isChangeRecordingEnabled, isChangeRecordingEnabled, isChangeRecordingEnabledAsPrimitive, isChangeRecordingEnabledAsPrimitive, isLogToDatabase, isLogToDatabase, isLogToDatabaseAsPrimitive, isLogToDatabaseAsPrimitive, isLogToFile, isLogToFile, isLogToFileAsPrimitive, isLogToFileAsPrimitive, isRemoveOnExit, isRemoveOnExit, isRemoveOnExitAsPrimitive, isRemoveOnExitAsPrimitive, isRequestAbort, isRequestAbort, isRequestAbortAsPrimitive, isRequestAbortAsPrimitive, isRequestAbortStep, isRequestAbortStep, isRequestAbortStepAsPrimitive, isRequestAbortStepAsPrimitive, isRetry, isRetry, isRetryAsPrimitive, isRetryAsPrimitive, isSendEmail, isSendEmail, isSendEmailAsPrimitive, isSendEmailAsPrimitive, isSingleExecutable, isSingleExecutable, isSingleExecutableAsPrimitive, isSingleExecutableAsPrimitive, isUseReadOnlyDatasource, isUseReadOnlyDatasource, isUseReadOnlyDatasourceAsPrimitive, isUseReadOnlyDatasourceAsPrimitive, removeFromRestrictions, removeFromRestrictions, removeFromTriggers, removeFromTriggers, setActive, setActive, setActive, setActive, setAlternativeDataSourceID, setAlternativeDataSourceID, setChangeRecordingEnabled, setChangeRecordingEnabled, setChangeRecordingEnabled, setChangeRecordingEnabled, setCode, setEmailAddress, setEmailAddress, setEmailNotificationTemplate, setEmailNotificationTemplate, setErrorMode, setErrorMode, setLogLevelDatabase, setLogLevelDatabase, setLogLevelFile, setLogLevelFile, setLogToDatabase, setLogToDatabase, setLogToDatabase, setLogToDatabase, setLogToFile, setLogToFile, setLogToFile, setLogToFile, setNodeGroup, setNodeGroup, setNodeID, setNodeID, setNodeID, setNodeID, setNumberOfRetries, setNumberOfRetries, setNumberOfRetries, setNumberOfRetries, setPriority, setPriority, setPriority, setPriority, setRemoveOnExit, setRemoveOnExit, setRemoveOnExit, setRemoveOnExit, setRequestAbort, setRequestAbort, setRequestAbort, setRequestAbort, setRequestAbortStep, setRequestAbortStep, setRequestAbortStep, setRequestAbortStep, setRestrictions, setRestrictions, setRetry, setRetry, setRetry, setRetry, setSendEmail, setSendEmail, setSendEmail, setSendEmail, setSessionCurrency, setSessionCurrency, setSessionLanguage, setSessionLanguage, setSessionUser, setSessionUser, setSingleExecutable, setSingleExecutable, setSingleExecutable, setSingleExecutable, setTriggers, setTriggers, setUseReadOnlyDatasource, setUseReadOnlyDatasource, setUseReadOnlyDatasource, setUseReadOnlyDatasource

Methods inherited from class de.hybris.platform.jalo.GenericItem

getImplementation, getInitialProperties, getRelatedItems, getRelatedItems, setRelatedItems

Methods inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllValuesSessionContext, getLocalizedProperty, getLocalizedProperty, getLocalizedPropertyInternal, getLocalizedPropertyNames, getLocalizedPropertyNames, hasLanguage, isEmptyValue, isFallbackEnabled, removeLocalizedProperty, removeLocalizedProperty, setAllLocalizedProperties, setAllLocalizedProperties, setLocalizedProperty, setLocalizedProperty

Methods inherited from class de.hybris.platform.jalo.ExtensibleItem

createNonClassAccessor, getAllProperties, getAllProperties, getProperty, getProperty, getPropertyNames, getPropertyNames, removeProperty, removeProperty, setAllProperties, setAllProperties, setProperty, setProperty

Methods inherited from class de.hybris.platform.jalo.Item

addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addNegativePermission, addPermission, addPositivePermission, assureExtensionsLoaded, changeTypeAfterCreation, checkConstraint, checkItemPermission, checkMandatoryAttribute, checkMandatoryAttribute, checkPermission, checkPermission, clearPermission, compareTo, ctx, doAfterRemove, doBeforeRemove, equals, getAccessorFor, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributesInternal, getAllLinkedItems, getAndCheckCacheBoundItem, getAttribute, getAttribute, getCacheBoundItem, getComposedType, getComposedTypePK, getCreationTime, getCurrentlyRemovingCount, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItemsCount, getLinkedItemsCount, getLinkedItemsCount, getModificationTime, getNegativePermissions, getOwner, getPartOfRemovedSessionMarker, getPermissionMap, getPermissions, getPersistenceVersion, getPK, getPositivePermissions, getRestrictedPrincipals, getSession, getSyncObject, getTenant, getTransientObject, getTransientObjectMap, hashCode, hasRegisteredClassAccessorFor, internal_registerClassAccessorFor, internal_registerNonClassAccessorFor, invalidateLocalCaches, isAlive, isCacheBound, isCurrentlyRemoving, isCurrentlyRemoving, isEmptyRelationValue, isInCreate, isInstanceOf, isItemCheckBeforeRemoveableDisabled, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, notifyManagerAboutItemRemoval, readResolve, registerAccessFor, registerAccessFor, registerJaloInvalidationListeners, remove, removeItemCollection, removeItemCollection, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinks, removePartOfItems, removePartOfItems, setAllAttributes, setAllAttributes, setAllAttributesInternal, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAttribute, setAttribute, setAttributeFromString, setAttributeFromString, setCacheBound, setComposedType, setCreationTime, setImplementation, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setModificationTime, setOwner, setPermissionsByMap, setTransientObject, setUseTA, suppressRelation, toString, useTA, writeReplace

Methods inherited from class de.hybris.platform.util.BridgeAbstraction

setTenant

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

START_TIME

protected static final String START_TIME

Deprecated.

See Also:

• Constant Field Values

HIDDEN_ATTRIBUTES

public static final Set<String> HIDDEN_ATTRIBUTES

Deprecated.

Constructor Details

SyncItemJob

public SyncItemJob()

Deprecated.

Method Details

createItem

protected Item createItem(SessionContext ctx,
 ComposedType type,
 Item.ItemAttributeMap allAttributes)
                   throws JaloBusinessException

Deprecated.

Superclass method overridden to ensure initial attributes GeneratedSyncItemJob.SOURCEVERSION, and GeneratedSyncItemJob.TARGETVERSION. Additionally it auto-fills GeneratedJob.CODEin case it is not provided.

Overrides:

createItem in class GeneratedSyncItemJob

Parameters:

ctx - the current session context which this item is created within

type - the actual item type ( since subtypes may not provide a own jalo class this may be different from the type which this method was implemented for )

Returns:

the new item instance

Throws:

JaloBusinessException - indicates an error during creation - any changes will be rollbacked

remove

public void remove(SessionContext ctx)
            throws ConsistencyCheckException

Deprecated.

Removes its ItemSyncTimestamp instances as well. Be careful, this may take a while!

Overrides:

remove in class Job

Parameters:

ctx - A SessionContext object

Throws:

ConsistencyCheckException - if this item could not be removed for some reason

See Also:

• Item.remove(de.hybris.platform.jalo.SessionContext)

removeSyncTimestamps

protected void removeSyncTimestamps(SessionContext ctx)

Deprecated.

getDefaultRootTypes

public static List<ComposedType> getDefaultRootTypes()

Deprecated.

Provides the list of default root types. By now these are

• Category
• Product
• Media
• Keyword
• PriceRow (global rows only)
• TaxRow (global rows only)
• DiscountRow (global rows only)
• MediaContainer

newExecution

public SyncItemCronJob newExecution()

Deprecated.

Description copied from interface: TriggerableJob

New execution.

Specified by:

newExecution in interface TriggerableJob

Returns:

the cron job

newExcecution

@Deprecated(since="ages",
            forRemoval=false)
public SyncItemCronJob newExcecution()

Deprecated.

since ages - please usenewExecution()

getExecutions

public Collection getExecutions(SessionContext ctx)

Deprecated.

Description copied from class: GeneratedSyncItemJob

Generated method - Getter of the SyncItemJob.executions attribute.

Specified by:

getExecutions in class GeneratedSyncItemJob

Returns:

the executions

isAbortable

public boolean isAbortable(CronJob conJob)

Deprecated.

The SyncCatalogVersionJob supports aborting.

Overrides:

isAbortable in class Job

Parameters:

conJob - the current execution of this job.

Returns:

true if the cronjob is running and the job supports aborting via GeneratedCronJob.setRequestAbort(boolean)

createSyncSessionContext

protected SessionContext createSyncSessionContext(SyncItemCronJob cronJob)

Deprecated.

Returns a new SessionContext with the following settings.

• LANGUAGE: null
• DISABLE_RESTRICTIONS: false
• DISABLE_RESTRICTION_GROUP_INHERITANCE: false
• USE_FAST_ALGORITHMS: true
• DISABLE_ATTRIBUTE_CHECK: true
• DISABLE_SUBCATEGORY_REMOVALCHECK: true
• DISABLE_SETALLOWEDPRINCIPAL_RECURSIVELY: true
• LANGUAGE_FALLBACK_ENABLED: false
• TRANSACTION_4_ALLATTRIBUTES: false

Parameters:

cronJob - the assigned SyncItemCronJob

Returns:

new SessionContext instance:

initializeTimeCounter

protected void initializeTimeCounter(SyncItemCronJob cronJob)

Deprecated.

getElapsedMillis

public long getElapsedMillis(SyncItemCronJob cronJob)

Deprecated.

canUndo

protected boolean canUndo(CronJob cronJob)

Deprecated.

This job does not support undo!

Overrides:

canUndo in class Job

Parameters:

cronJob - the CronJob to undo changes for

Returns:

true if this Job is undoable, false otherwise.

getDuplicatedCatalogItemsCount

protected int getDuplicatedCatalogItemsCount(SessionContext ctx,
 CatalogVersion version,
 SyncItemCronJob cronJob,
 ComposedType type)

Deprecated.

checkCatalogVersionValidity

protected boolean checkCatalogVersionValidity(SyncItemCronJob cronJob,
 SyncItemJob.SyncItemCopyContext syncItemCopyContext)

Deprecated.

Use this method to check if the given catalog version is valid for synchronization. As default this method will check whether or not duplicate product IDs exist or not. If so a error log is created.

Parameters:

cronJob -

syncItemCopyContext -

Returns:

true if the catalog version is valid (and synchronization may use it)

createCopyContext

protected ItemCopyContext createCopyContext(SyncItemCronJob cronJob,
 CatalogVersion srcV,
 CatalogVersion tgtV,
 Map<PK,PK> alreadyFinished)

Deprecated.

registerSynchronizedItem

protected void registerSynchronizedItem(SyncItemCronJob cronjob,
 Item source,
 Item copy,
 String message)

Deprecated.

Registers a synchronized item pair permanently by creating a ChangeDescriptorfor them. If the current cronjob is aborted or crashes these changes are loaded on restart so that no item is synchronized twice.

Please note that this feature is disabled if change recording is disabled dor the executed chronjob !

Parameters:

cronjob - the SyncItemCronJob

source - sourceitem

copy - copyitem

message - a message

getSingleVersionCatalogItems

protected List<PK> getSingleVersionCatalogItems(SessionContext ctx,
 ComposedType type,
 String additionalQueryRestrictions,
 boolean fromSource,
 int start,
 int range)

Deprecated.

copyItem

protected void copyItem(ItemCopyContext itemCopyContext,
 SyncItemCronJob cronJob,
 Item src,
 Item tgt)

Deprecated.

getModifiedCatalogItemPairs

protected List<SyncItemJob.ModifiedItemsPair> getModifiedCatalogItemPairs(SessionContext ctx,
 ComposedType type,
 int start,
 int range,
 boolean forceUpdate)

Deprecated.

Returns:

a list of SyncItemJob.ModifiedItemsPairs.

getPossibleCatalogItemPairs

protected List<SyncItemJob.ModifiedItemsPair> getPossibleCatalogItemPairs(SessionContext ctx,
 ComposedType type,
 String additionalQueryRestrictions,
 int start,
 int range)

Deprecated.

Returns:

a list of SyncItemJob.ModifiedItemsPairs.

removeItem

protected void removeItem(ItemCopyContext itemCopyContext,
 SyncItemCronJob cronJob,
 Item removeItem)

Deprecated.

getMissingTargetItems

protected Set<Item> getMissingTargetItems(Collection<? extends Item> sourceItems,
 Collection<? extends Item> targetItems,
 CatalogVersion sourceVersion)

Deprecated.

addCatalogItemsToSync

public void addCatalogItemsToSync(SyncItemCronJob cronJob,
 Collection<? extends Item> items)

Deprecated.

Added any catalog item except categories to a syncronization.

Parameters:

cronJob - the synchronization cronjob

items - the items to add

addCategoriesToSync

public void addCategoriesToSync(SyncItemCronJob cronJob,
 Collection<? extends Category> categories,
 boolean includeSubcategories,
 boolean includeProducts)

Deprecated.

configureFullVersionSync

public void configureFullVersionSync(SyncItemCronJob cronJob)

Deprecated.

Collects all changes between the source and target version of this job. Depending whether or not new item creation and missing item removal has been configured new (source version) items and missing (source version) items are scheduled too.

getAdditionalQueryRestrictions

protected String getAdditionalQueryRestrictions(SessionContext ctx,
 ComposedType rootType,
 SyncItemCronJob cronJob)

Deprecated.

toPendingItemsList

protected List<PK[]> toPendingItemsList(List<PK> itemPKs,
 boolean remove)

Deprecated.

toPendingItemsList

protected List<PK[]> toPendingItemsList(List<SyncItemJob.ModifiedItemsPair> itemPairs)

Deprecated.

configureFullSyncForItemType

protected void configureFullSyncForItemType(SessionContext ctx,
 SyncItemCronJob cronJob,
 ComposedType type,
 String additionalQueryRestrictions,
 boolean removeMissing,
 boolean createNew,
 boolean forceUpdate,
 int range)

Deprecated.

Configures a full synchronization of the items of a given type according to the specified sync cronjob settings.

Parameters:

ctx - the enclosing session context

cronJob - the sync cronjob (among others) holding source and target version

type - the item type specifying which items should be synchronized

additionalQueryRestrictions - flexible search WHERE parameters to be considered when querying new, removed or possible item pairs when scheduling synchronization

removeMissing - if true all items are removed which still exist in target version but do not exist in source version

createNew - if true new items are created with the target version if the exist in source version

forceUpdate - if true the process will include even item pairs which are considered up to date

range - if > 0 this parameter enables paging logic while collecting items via flexible search; otherwise all matches are processed at once ( read as PK so no actual item is loaded into memory! )

getCompletionInfo

public SyncItemJob.CompletionInfo getCompletionInfo(SyncItemCronJob cronJob)

Deprecated.

performCronJob

protected CronJob.CronJobResult performCronJob(CronJob cronJob)

Deprecated.

Description copied from class: Job

You have to implement this method in your Job. Here you can execute the job. You have to return a CronJobResult that indicates whether the Job was successfully executed or not.

Specified by:

performCronJob in class Job

Parameters:

cronJob - the CronJob to execute

Returns:

a CronJobResult that indicates whether the Job was successfully executed or not.

See Also:

• CronJob.getFinishedResult(boolean)
• CronJob.getAbortResult()

doSynchronization

protected boolean doSynchronization(SyncItemJob.SyncItemCopyContext syncItemCopyContext,
 SyncItemCronJob cronJob)
                             throws AbortCronJobException

Deprecated.

Executes actual synchronization.

Parameters:

syncItemCopyContext - the copy context

cronJob - the cronjob

Returns:

true if no (ignored) errors occured, false otherwise

Throws:

AbortCronJobException - if the cronjob has been set to be aborted during execution

doAbort

protected CronJob.CronJobResult doAbort(SyncItemCronJob cronJob)

Deprecated.

This method is called if abort is requested by the user while still executing this job.

Parameters:

cronJob - the currently executing cronjob

Returns:

the abort cronjob result

canSelectAttribute

protected boolean canSelectAttribute(AttributeDescriptor attributeDescriptor)

Deprecated.

getAllExportAttributeDescriptors

public Map<AttributeDescriptor,Boolean> getAllExportAttributeDescriptors(SessionContext ctx)

Deprecated.

Getter for HMC editor - we pass a map { AttributeDescriptor -> Boolean }

Specified by:

getAllExportAttributeDescriptors in class GeneratedSyncItemJob

Returns:

the exportAttributeDescriptors

setAllExportAttributeDescriptors

public void setAllExportAttributeDescriptors(SessionContext ctx,
 Map syncMap)

Deprecated.

setter for HMC editor - we just set the 'includedInSync' attribute

Specified by:

setAllExportAttributeDescriptors in class GeneratedSyncItemJob

Parameters:

syncMap - Map<AttributeDescriptor,Boolean>

configAlreadyExists

protected boolean configAlreadyExists(AttributeDescriptor attributeDescriptor)

Deprecated.

For SyncAttributeDescriptorConfig.createItem(SessionContext, ComposedType, de.hybris.platform.jalo.Item.ItemAttributeMap) .

getConfigFor

public SyncAttributeDescriptorConfig getConfigFor(AttributeDescriptor attributeDescriptor,
 boolean createOnDemand)

Deprecated.

Returns the SyncAttributeDescriptorConfig instance which is responsible for all publication settings of the specified attribute descriptor.

Please note that the attribute descriptor cannot be a inherited one because publication settings are generally stored for declared attributes only!

Parameters:

attributeDescriptor - the attribute descriptor to get settings item for

createOnDemand - if true and no settings item exists create one

getConfigFor

public SyncAttributeDescriptorConfig getConfigFor(SessionContext ctx,
 AttributeDescriptor attributeDescriptor,
 boolean createOnDemand)

Deprecated.

Returns the SyncAttributeDescriptorConfig instance which is responsible for all publication settings of the specified attribute descriptor.

Please note that the attribute descriptor cannot be a inherited one because publication settings are generally stored for declared attributes only!

Parameters:

ctx - the enclosing session context

attributeDescriptor - the attribute descriptor to get settings item for

createOnDemand - if true and no settings item exists create one

getAttributeAndConfigPairs

protected List<List> getAttributeAndConfigPairs()

Deprecated.

Returns [AttributeDescriptor,SyncAttributeDescriptorConfig] pairs for all existing declared attribute descriptors and their sync config item if it exists for this job. Otherwise the second entry is null.

createDefaultConfigFor

protected SyncAttributeDescriptorConfig createDefaultConfigFor(SessionContext ctx,
 AttributeDescriptor attributeDescriptor)

Deprecated.

getSyncAttributeConfigurations

public Collection<SyncAttributeDescriptorConfig> getSyncAttributeConfigurations(SessionContext ctx)

Deprecated.

Returns a collection containing a SyncAttributeDescriptorConfig instance for each declared attribute of any catalog item type.

There is no need to create them explicitly since this method creates them on demand.

Specified by:

getSyncAttributeConfigurations in class GeneratedSyncItemJob

Returns:

the syncAttributeConfigurations

setSyncAttributeConfigurations

public void setSyncAttributeConfigurations(SessionContext ctx,
 Collection param)

Deprecated.

Description copied from class: GeneratedSyncItemJob

Generated method - Setter of the SyncItemJob.syncAttributeConfigurations attribute.

Specified by:

setSyncAttributeConfigurations in class GeneratedSyncItemJob

param - the syncAttributeConfigurations

getRootTypes

public List<ComposedType> getRootTypes(SessionContext ctx)

Deprecated.

Description copied from class: GeneratedSyncItemJob

Generated method - Getter of the SyncItemJob.rootTypes attribute.

Overrides:

getRootTypes in class GeneratedSyncItemJob

Returns:

the rootTypes

assureCatalogItemTypes

protected List<ComposedType> assureCatalogItemTypes(List<ComposedType> types)

Deprecated.

setRootTypes

public void setRootTypes(SessionContext ctx,
 List<ComposedType> value)

Deprecated.

Overwritten to ensure that each root type is a catalog item type.

Overrides:

setRootTypes in class GeneratedSyncItemJob

value - the rootTypes

See Also:

• GeneratedSyncItemJob.setRootTypes(de.hybris.platform.jalo.SessionContext, java.util.List)

getEffectiveSyncLanguages

public Collection<Language> getEffectiveSyncLanguages(SessionContext ctx)

Deprecated.

Calculates current effective sync languages. This is either the collection from GeneratedSyncItemJob.getSyncLanguages() or, if empty, the intersection of source version languages and target version languages.

Specified by:

getEffectiveSyncLanguages in class GeneratedSyncItemJob

Returns:

the effectiveSyncLanguages