de.hybris.platform.cronjob.jalo

Class BatchJob

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.cronjob.jalo.GeneratedBatchJob

de.hybris.platform.cronjob.jalo.BatchJob

All Implemented Interfaces:

Serializable, Comparable

Direct Known Subclasses:

GeneratedBMECatImportBatchJob

public class BatchJob
extends GeneratedBatchJob

A BatchJob is a subclass of Job, which divides the task which should be performed into several Steps. Thus a complex task (for example a BMECat import) can be divided into several small steps (for example article, media and price import) which are assigned to one BatchJob.

The performCronJob(CronJob) implementation of the BatchJob iterates over all pending steps and executes each Step.

See Also:

Serialized Form

Nested Class Summary

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 inherited from class de.hybris.platform.cronjob.jalo.GeneratedBatchJob

DEFAULT_INITIAL_ATTRIBUTES, STEPS

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, PRIORITY, REMOVEONEXIT, REQUESTABORT, REQUESTABORTSTEP, RESTRICTIONS, RESTRICTIONSHANDLER, RETRY, SENDEMAIL, SESSIONCONTEXTVALUES, SESSIONCURRENCY, SESSIONLANGUAGE, SESSIONUSER, SINGLEEXECUTABLE, TRIGGERS, TRIGGERSHANDLER

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, 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 and Description
BatchJob()

Method Summary

Modifier and Type	Method and Description
protected Step	addStep()
Step	addStep(ComposedType stepType) Adds a Step of the specified type to the BatchJob and returns it.
Step	addStep(ComposedType stepType, Map additionalAttributes) Adds a Step of the specified type to the BatchJob and returns it.
protected boolean	canUndo(CronJob cronJob) Returns true, if the BatchJob can be undone using the specified CronJob.
Collection<Step>	getAllPreviousSteps(SessionContext ctx, Step step) Returns a Collection of all predecessor Steps of the specified Step.
Collection<Step>	getAllPreviousSteps(Step step) Returns a Collection of all predecessor Steps of the specified Step.
protected static Step	getCurrentlyExecutingStep()
Step	getFirstStep() Returns the first Step.
Step	getFirstStep(SessionContext ctx) Returns the first Step.
Step	getLastStep() Returns the last Step.
Step	getLastStep(SessionContext ctx) Returns the last Step.
protected Integer	getNextSequenceNumber() Returns the next sequence number.
protected Integer	getNextSequenceNumber(SessionContext ctx) Returns the next sequence number.
List<Step>	getSteps() Returns a List of all Steps of the BatchJob.
List<Step>	getSteps(int start, int count) Returns a List containing the specified range of Steps of the BatchJob.
List<Step>	getSteps(SessionContext ctx) Returns a List of all Steps of the BatchJob.
List<Step>	getSteps(SessionContext ctx, int start, int count) Returns a List containing the specified range of Steps of the BatchJob.
protected static boolean	hasCurrentlyExecutingStep()
boolean	isAbortable(CronJob cronJob) Is abortable if the current step supports abort (see Step.isAbortable().
protected CronJob.CronJobResult	performCronJob(CronJob cronJob) Performs the BatchJob using the specified CronJob.
void	remove(SessionContext ctx) First all assigned CronJobs were removed, than the Job itself.
protected static void	setCurrentlyExecutingStep(Step step)
void	setSteps(SessionContext ctx, List<Step> steps) Sets the Steps of the BatchJob and deletes all Steps which were assigned before and which are not part of the specified Collection.
protected CronJob.CronJobResult	undoCronJob(CronJob cronJob) Starts the undo-process of the BatchJob for the specified CronJob.
protected static void	unsetCurrentlyExecutingStep()

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

getDefaultAttributeModes, setSteps

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

canPerform, checkRemovable, configureCronjob, createItem, 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, 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, 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, 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, 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

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

getInitialProperties

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, 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, readResolve, refreshRemote, 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, toString, useTA, writeReplace

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

getImplementation, setTenant

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchJob

public BatchJob()

Method Detail

remove

public void remove(SessionContext ctx)
            throws ConsistencyCheckException

Description copied from class: Job

First all assigned CronJobs were removed, than the Job itself.

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)

setCurrentlyExecutingStep

protected static final void setCurrentlyExecutingStep(Step step)

unsetCurrentlyExecutingStep

protected static final void unsetCurrentlyExecutingStep()

getCurrentlyExecutingStep

protected static final Step getCurrentlyExecutingStep()

hasCurrentlyExecutingStep

protected static final boolean hasCurrentlyExecutingStep()

isAbortable

public boolean isAbortable(CronJob cronJob)

Is abortable if the current step supports abort (see Step.isAbortable().

Overrides:

isAbortable in class Job

Parameters:

cronJob - the current execution of this job.

Returns:

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

See Also:

Job.isAbortable(de.hybris.platform.cronjob.jalo.CronJob)

setSteps

public void setSteps(SessionContext ctx,
                     List<Step> steps)

Sets the Steps of the BatchJob and deletes all Steps which were assigned before and which are not part of the specified Collection.

Specified by:

setSteps in class GeneratedBatchJob

Parameters:

ctx - 123

steps - the List of the new Steps

getSteps

public List<Step> getSteps()

Returns a List of all Steps of the BatchJob.

Overrides:

getSteps in class GeneratedBatchJob

Returns:

a List of all Steps of the BatchJob

getSteps

public List<Step> getSteps(SessionContext ctx)

Returns a List of all Steps of the BatchJob.

Specified by:

getSteps in class GeneratedBatchJob

Parameters:

ctx - 123

Returns:

a List of all Steps of the BatchJob

getSteps

public List<Step> getSteps(int start,
                           int count)

Returns a List containing the specified range of Steps of the BatchJob. (Range: start -> (start + count))

Parameters:

start - the start index of the range

count - the number of steps in the range

Returns:

a List containing the specified range of Steps of the BatchJob

getSteps

public List<Step> getSteps(SessionContext ctx,
                           int start,
                           int count)

Returns a List containing the specified range of Steps of the BatchJob. (Range: start -> (start + count))

Parameters:

ctx - 123

start - the start index of the range

count - the number of steps in the range

Returns:

a List containing the specified range of Steps of the BatchJob

getFirstStep

public Step getFirstStep()

Returns the first Step.

Returns:

the first Step

getFirstStep

public Step getFirstStep(SessionContext ctx)

Returns the first Step.

Parameters:

ctx -

Returns:

the first Step

getLastStep

public Step getLastStep()

Returns the last Step.

Returns:

the last Step

getLastStep

public Step getLastStep(SessionContext ctx)

Returns the last Step.

Parameters:

ctx -

Returns:

the last Step

getAllPreviousSteps

public Collection<Step> getAllPreviousSteps(Step step)

Returns a Collection of all predecessor Steps of the specified Step.

Parameters:

step - the Step whose predecessor Steps should be returned

Returns:

a Collection of all predecessor Steps of the specified Step

getAllPreviousSteps

public Collection<Step> getAllPreviousSteps(SessionContext ctx,
                                            Step step)

Returns a Collection of all predecessor Steps of the specified Step.

Parameters:

ctx - 123

step - the Step whose predecessor Steps should be returned

Returns:

a Collection of all predecessor Steps of the specified Step

getNextSequenceNumber

protected Integer getNextSequenceNumber()

Returns the next sequence number.

Returns:

the next sequence number

getNextSequenceNumber

protected Integer getNextSequenceNumber(SessionContext ctx)

Returns the next sequence number.

Parameters:

ctx - 123

Returns:

the next sequence number

addStep

protected Step addStep()

addStep

public Step addStep(ComposedType stepType)

Adds a Step of the specified type to the BatchJob and returns it.

Parameters:

stepType - the ComposedType of the Step, which will be added

Returns:

the new Step which have been added to the BatchJob

addStep

public Step addStep(ComposedType stepType,
                    Map additionalAttributes)

Adds a Step of the specified type to the BatchJob and returns it.

Parameters:

stepType - the ComposedType of the Step, which will be added

additionalAttributes - additionalAttributes, which will be used to the create the specified Step type

Returns:

the new Step which have been added to the BatchJob

undoCronJob

protected CronJob.CronJobResult undoCronJob(CronJob cronJob)

Starts the undo-process of the BatchJob for the specified CronJob.

Overrides:

undoCronJob in class Job

Parameters:

cronJob - the CronJob, which is used for the undo-process

Returns:

CronJob.CronJobResult the result of the undo-process

performCronJob

protected CronJob.CronJobResult performCronJob(CronJob cronJob)

Performs the BatchJob using the specified CronJob. The BatchJob will execute all pending Steps in the given order. If one Step cannot be performed, the execution of the BatchJob is paused.

Specified by:

performCronJob in class Job

Parameters:

cronJob - the CronJob, which should used for execution

Returns:

CronJob.CronJobResult the result of the execution

See Also:

CronJob.getFinishedResult(boolean), CronJob.getAbortResult()

canUndo

protected boolean canUndo(CronJob cronJob)

Returns true, if the BatchJob can be undone using the specified CronJob.

Overrides:

canUndo in class Job

Parameters:

cronJob - the CronJob to undo changes for

Returns:

true, if the BatchJob can be undone using the specified CronJob

See Also:

Job.canUndo(de.hybris.platform.cronjob.jalo.CronJob)