de.hybris.platform.cronjob.jalo

Class Job

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

All Implemented Interfaces:

Serializable, Comparable

Direct Known Subclasses:

CustomAttributesTriggerableJob, GeneratedBatchJob, GeneratedBMECatExportJob, GeneratedBMECatImportWithCsvTransformJob, GeneratedCompareCatalogVersionsJob, GeneratedCompositeJob, GeneratedImpExExportJob, GeneratedImpExImportJob, GeneratedLDIFGroupImportJob, GeneratedLDIFImportJob, GeneratedMoveMediaJob, GeneratedRebuildIndexJob, GeneratedRemoveCatalogVersionJob, GeneratedRemoveItemsJob, GeneratedRemoveOrphanedFilesJob, GeneratedServicelayerJob, GeneratedSyncItemJob, GeneratedTypeSystemExportJob, GeneratedUpdateIndexJob, GeneratedWorkflowTemplate, SyncExcutionTestJob, TestJob, TriggerableTwoSecondJob

public abstract class Job
extends GeneratedJob

The Job implements tasks, whose execution can be scheduled and which can be executed both synchronous and asynchronous (by running in a separated Thread). The Job just implements all the logic of the task it implements, it stores no "runtime" information. The runtime information (for example session parameters (user, language, currency), import source file, or execution result) are stored in the CronJob instance, which is passed to the Job when it is started.

Apart from the normal execution of the task the Job implements, a Job can support the undo-mechanism, which allows to undo all changes, which have been performed by the previous execution of the Job and the specified CronJob.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Job.JobFileLogContainer
static class	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 and Description
static String	CTX_CURRENTCRONJOB Name of the SessionContext attribute which contains the CronJob instance.
static String	CTX_CURRENTJOB Name of the SessionContext attribute which contains the Job instance.

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

ACTIVE, ALTERNATIVEDATASOURCEID, CHANGERECORDINGENABLED, CODE, CRONJOBS, CRONJOBSHANDLER, DEFAULT_INITIAL_ATTRIBUTES, 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
Job()

Method Summary

Modifier and Type	Method and Description
protected boolean	canPerform(CronJob cronJob) Deprecated. no available counterpart in servicelayer
protected boolean	canUndo(CronJob cronJob) Deprecated. no counterpart in servicelayer available
protected void	checkRemovable(SessionContext ctx) Checks whether or not this it may be removed or not.
protected void	configureCronjob(CronJob cronjob) Deprecated. use CronJobFactory mechanism instead, refer to appropriate wiki document
protected Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) Has to be implemented for each concrete subtype of item.
protected CronJobLogListener.CronJobLogContext	createLogContext(CronJob cronjob)
void	debug(String message) Deprecated.
void	error(String message) Deprecated.
void	fatal(String message) Deprecated.
protected Map<String,String>	getConfigAttributes(CronJob cronjob) Deprecated. use CronJobFactory mechanism instead, refer to appropriate wiki document
Collection<CronJob>	getCronJobsByCode(SessionContext ctx, String code) Deprecated. use CronJobService.getCronJob(String) instead
Collection<CronJob>	getCronJobsByCode(String code) Deprecated. use CronJobService.getCronJob(String) instead
protected static Job.JobFileLogContainer	getCurrentLogContainer()
protected Level	getEffectiveLogLevel(CronJob cronjob)
protected Item.ItemAttributeMap	getNonInitialAttributes(SessionContext ctx, Item.ItemAttributeMap allAttributes) The default implementation of GenericItem.getNonInitialAttributes(SessionContext, Item.ItemAttributeMap ) assures that the 'registered initial' properties GenericItem.getInitialProperties(JaloSession, Item.ItemAttributeMap ) will be removed from the 'non initial map'.
void	info(String message) Deprecated.
boolean	isAbortable(CronJob conJob) Deprecated. use CronJobService.isAbortable(de.hybris.platform.cronjob.model.CronJobModel) instead
boolean	isDebugEnabled() Deprecated.
boolean	isEnabledFor(Level level) Deprecated.
boolean	isErrorEnabled() Deprecated.
boolean	isInfoEnabled() Deprecated.
boolean	isPerformable(CronJob cronJob) Deprecated. use CronJobService.isPerformable(de.hybris.platform.cronjob.model.CronJobModel) instead
boolean	isPerformable(CronJob cronJob, int clusternode) Deprecated. use CronJobService.isPerformable(de.hybris.platform.cronjob.model.CronJobModel) instead
boolean	isUndoable(CronJob cronJob) Deprecated. obsolete feature won't be supported in the future
boolean	isWarnEnabled() Deprecated.
protected static boolean	jobIsCurrentlyRunning()
void	log(String message, Level level)
protected void	logToFile(String message, Level level) Proxy method to write cronjob logs to file too.
void	perform(CronJob cronJob) Deprecated. use CronJobService.performCronJob(de.hybris.platform.cronjob.model.CronJobModel) instead
void	perform(CronJob cronJob, boolean synchronous) Deprecated. use CronJobService.performCronJob(de.hybris.platform.cronjob.model.CronJobModel, boolean) instead
void	perform(CronJob cronJob, Job.Synchronicity synchronousType) Deprecated. use CronJobService.performCronJob(de.hybris.platform.cronjob.model.CronJobModel, boolean) instead
protected abstract CronJob.CronJobResult	performCronJob(CronJob cronJob) Deprecated. use CronJobService.performCronJob(de.hybris.platform.cronjob.model.CronJobModel, boolean) instead
protected AfterCronJobFinishedEvent	prepareAfterFinishEvent(CronJob cj, boolean synchronous)
protected BeforeCronJobStartEvent	prepareBeforeStartEvent(CronJob cj, boolean synchronous)
void	remove(SessionContext ctx) First all assigned CronJobs were removed, than the Job itself.
protected static void	saveToLogFile(Job.JobFileLogContainer container, CronJob cronJob)
protected void	sendFinishedEvent(AfterCronJobFinishedEvent event, CronJob.CronJobResult result)
protected void	sendStartEvent(BeforeCronJobStartEvent event)
void	setCode(SessionContext ctx, String code) Generated method - Setter of the Job.code attribute.
void	setCronJobs(SessionContext ctx, Collection<CronJob> cronJobs) Deprecated. not supported anymore
protected static void	setCurrentLogContainer(Job.JobFileLogContainer logContainer)
void	setNonInitialAttributes(SessionContext ctx, Item item, Item.ItemAttributeMap nonInitialAttributes) Sets all attributes which could not be set during Item.createItem(SessionContext, ComposedType, ItemAttributeMap).
protected JaloSession	startOwnSession(CronJob cronJob) Activates a own session for executing the job.
protected void	stopOwnSession(JaloSession previousSession, CronJob cronJob) Deactivates the own session and re-activates the previous session if available.
protected void	switchDataSource(CronJob cronjob)
void	undo(CronJob cronJob) Deprecated. obsolete feature won't be supported in the future
void	undo(CronJob cronJob, boolean synchronous) Deprecated. obsolete feature won't be supported in the future
protected CronJob.CronJobResult	undoCronJob(CronJob cronJob) Deprecated. this feature is not available since 4.3
protected void	unsetAlternativeDataSource()
protected static void	unsetCurrentLogContainer()
void	warn(String message) Deprecated.

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

addToRestrictions, addToRestrictions, addToTriggers, addToTriggers, getAlternativeDataSourceID, getAlternativeDataSourceID, getCode, getCode, getCronJobs, getCronJobs, getDefaultAttributeModes, 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

Field Detail

CTX_CURRENTJOB

public static final String CTX_CURRENTJOB

Name of the SessionContext attribute which contains the Job instance.

See Also:

Constant Field Values

CTX_CURRENTCRONJOB

public static final String CTX_CURRENTCRONJOB

Name of the SessionContext attribute which contains the CronJob instance.

See Also:

Constant Field Values

Constructor Detail

Job

public Job()

Method Detail

createItem

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

Description copied from class: Item

Has to be implemented for each concrete subtype of item. This method is responsible for creating a new item instance ( by calling managers, ejb homes, etc. ) during ComposedType.newInstance(Map).

In case this method uses any of the attribute values during creation it is required to override Item.getNonInitialAttributes(SessionContext, ItemAttributeMap) too.
Sn example:

 public static final String MY_ATTRIBUTE = "someAttribute"; ... protected Item createItem(SessionContext
 ctx, ComposedType type, Map allAttributes ) throws JaloBusinessException { MyManager man = ... return
 man.createMyItem( (String)allAttributes.get(MY_ATTRIBUTE) );
 // here MY_ATTRIBUTE is used for creation, so it must not be set again } protected Map getNonInitialAttributes(
 SessionContext ctx, Map allAttributes ) { // let superclass remove its own initial attributes Map ret =
 super.getNonInitialAttributes( ctx, allAttributes );
 // remove MY_ATTRIBUTE from all attributes since if has already been set ret.remove(MY_ATTRIBUTE); return ret; }

 

Overrides:

createItem in class GenericItem

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

setNonInitialAttributes

public void setNonInitialAttributes(SessionContext ctx,
                                    Item item,
                                    Item.ItemAttributeMap nonInitialAttributes)
                             throws JaloBusinessException

Description copied from class: Item

Sets all attributes which could not be set during Item.createItem(SessionContext, ComposedType, ItemAttributeMap). as default this method just iterates over all attribute mappings and sets the value by invoking Item.setAttribute(SessionContext, String, Object).

Overrides:

setNonInitialAttributes in class Item

Parameters:

ctx - session context with language = NULL

item - the newly created item

nonInitialAttributes - the non-initial attributed obtained via Item.getNonInitialAttributes(SessionContext, ItemAttributeMap)

Throws:

JaloBusinessException

getNonInitialAttributes

protected Item.ItemAttributeMap getNonInitialAttributes(SessionContext ctx,
                                                        Item.ItemAttributeMap allAttributes)

Description copied from class: GenericItem

The default implementation of GenericItem.getNonInitialAttributes(SessionContext, Item.ItemAttributeMap ) assures that the 'registered initial' properties GenericItem.getInitialProperties(JaloSession, Item.ItemAttributeMap ) will be removed from the 'non initial map'.

Overrides:

getNonInitialAttributes in class GenericItem

Parameters:

ctx - session context with language = NULL

allAttributes - a ItemAttributeMap contaning attribute values.

Returns:

a ItemAttributeMap containing all attribute values, which belong to non-initial attributes.

remove

public void remove(SessionContext ctx)
            throws ConsistencyCheckException

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

Overrides:

remove in class Item

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)

checkRemovable

protected void checkRemovable(SessionContext ctx)
                       throws ConsistencyCheckException

Description copied from class: Item

Checks whether or not this it may be removed or not. Called before the actual removal process.

Overrides:

checkRemovable in class Item

Throws:

ConsistencyCheckException - to indicate that the item cannot be removed

setCronJobs

@Deprecated
public void setCronJobs(SessionContext ctx,
                                    Collection<CronJob> cronJobs)

Deprecated. not supported anymore

Assigns the specified Collection of CronJobs to this Job. All CronJobs, which where assigned to the Job before and which are not part of the specified Collection will be deleted.

Parameters:

ctx - The SessionContext, which will be used

cronJobs - the Collection of CronJobs, which will be assigned to the Job

getCronJobsByCode

@Deprecated
public Collection<CronJob> getCronJobsByCode(String code)

Deprecated. use CronJobService.getCronJob(String) instead

Returns all assigned CronJobs which match the specified code (The code of a Job is not necessarily unique!).

Parameters:

code - The code of the searched Cronjobs

Returns:

all assigned CronJobs which match the specified code

getCronJobsByCode

@Deprecated
public Collection<CronJob> getCronJobsByCode(SessionContext ctx,
                                                         String code)

Deprecated. use CronJobService.getCronJob(String) instead

Returns all assigned CronJobs which match the specified code (The code of a Job is not necessarily unique!).

Parameters:

ctx - The SessionContext, which will be used

code - The code of the searched Cronjobs

Returns:

all assigned CronJobs which match the specified code

canUndo

@Deprecated
protected boolean canUndo(CronJob cronJob)

Deprecated. no counterpart in servicelayer available

Returns true, if the specified CronJob can be undone. Overwrite this method of you want to undo your CronJob. Default value is false

Parameters:

cronJob - the CronJob to undo changes for

Returns:

true if this Job is undoable, false otherwise.

isAbortable

@Deprecated
public boolean isAbortable(CronJob conJob)

Deprecated. use CronJobService.isAbortable(de.hybris.platform.cronjob.model.CronJobModel) instead

Tells whether this currently executed job is abortable. As default this method returns false. Override to implement abortable jobs.

Parameters:

conJob - the current execution of this job.

Returns:

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

isUndoable

@Deprecated
public boolean isUndoable(CronJob cronJob)

Deprecated. obsolete feature won't be supported in the future

Tests whether the given CronJob instance can be undone.

Parameters:

cronJob - the CronJob to undo

Returns:

whether this CronJob is undoable or not

canPerform

@Deprecated
protected boolean canPerform(CronJob cronJob)

Deprecated. no available counterpart in servicelayer

This method is called before a Job is performed. If you override this method you can check the things that are necessary for the performing of your Job. Default value is true.

Parameters:

cronJob - the actual CronJob

Returns:

true if this Job is performable, false otherwise. de.hybris.platform.servicelayer.cronjob.CronJobService

isPerformable

@Deprecated
public boolean isPerformable(CronJob cronJob)

Deprecated. use CronJobService.isPerformable(de.hybris.platform.cronjob.model.CronJobModel) instead

Tests whether the given CronJob instance can be performed. Internal the methods canPerform( final CronJob cronJob ) and canPerformInternal( final CronJob cronJob ) are called. Only if both methods returning true, this method also return true Returns true, if this Job can be performed using the specified Cronjob. Otherwise false is returned.

Parameters:

cronJob - which should be performed

Returns:

true, if this Job can be performed using the specified Cronjob. Otherwise false is returned

isPerformable

@Deprecated
public boolean isPerformable(CronJob cronJob,
                                         int clusternode)

Deprecated. use CronJobService.isPerformable(de.hybris.platform.cronjob.model.CronJobModel) instead

perform

@Deprecated
public final void perform(CronJob cronJob)

Deprecated. use CronJobService.performCronJob(de.hybris.platform.cronjob.model.CronJobModel) instead

Performs this Job asynchronous in a separate Thread using the specified Cronjob.

Parameters:

cronJob - which is used to perform this Job

perform

@Deprecated
public final void perform(CronJob cronJob,
                                      boolean synchronous)

Deprecated. use CronJobService.performCronJob(de.hybris.platform.cronjob.model.CronJobModel, boolean) instead

Performs this Job using the specified Cronjob. If synchronous is true, the Job will be performed synchronous, which means that this method will return the control to its caller as recently as this Job is performed. Synchronous execution is especially useful for short Jobs or testing purpose (JUnit tests for example).
If synchronous is false, the Job will be performed asynchronous by executing the Job in a separate Thread.

Parameters:

cronJob - which will be used to perform this Job

synchronous - true if this Job should be performed synchronously, false if this Job should be performed asynchronously

perform

@Deprecated
public final void perform(CronJob cronJob,
                                      Job.Synchronicity synchronousType)

Deprecated. use CronJobService.performCronJob(de.hybris.platform.cronjob.model.CronJobModel, boolean) instead

prepareBeforeStartEvent

protected BeforeCronJobStartEvent prepareBeforeStartEvent(CronJob cj,
                                                          boolean synchronous)

sendStartEvent

protected void sendStartEvent(BeforeCronJobStartEvent event)

prepareAfterFinishEvent

protected AfterCronJobFinishedEvent prepareAfterFinishEvent(CronJob cj,
                                                            boolean synchronous)

sendFinishedEvent

protected void sendFinishedEvent(AfterCronJobFinishedEvent event,
                                 CronJob.CronJobResult result)

switchDataSource

protected void switchDataSource(CronJob cronjob)

unsetAlternativeDataSource

protected void unsetAlternativeDataSource()

setCurrentLogContainer

protected static final void setCurrentLogContainer(Job.JobFileLogContainer logContainer)

unsetCurrentLogContainer

protected static final void unsetCurrentLogContainer()

getCurrentLogContainer

protected static final Job.JobFileLogContainer getCurrentLogContainer()

jobIsCurrentlyRunning

protected static final boolean jobIsCurrentlyRunning()

saveToLogFile

protected static final void saveToLogFile(Job.JobFileLogContainer container,
                                          CronJob cronJob)

logToFile

protected void logToFile(String message,
                         Level level)

Proxy method to write cronjob logs to file too.

log

public void log(String message,
                Level level)

debug

@Deprecated
public void debug(String message)

Deprecated.

info

@Deprecated
public void info(String message)

Deprecated.

warn

@Deprecated
public void warn(String message)

Deprecated.

error

@Deprecated
public void error(String message)

Deprecated.

fatal

@Deprecated
public void fatal(String message)

Deprecated.

isEnabledFor

@Deprecated
public boolean isEnabledFor(Level level)

Deprecated.

isDebugEnabled

@Deprecated
public boolean isDebugEnabled()

Deprecated.

isInfoEnabled

@Deprecated
public boolean isInfoEnabled()

Deprecated.

isWarnEnabled

@Deprecated
public boolean isWarnEnabled()

Deprecated.

isErrorEnabled

@Deprecated
public boolean isErrorEnabled()

Deprecated.

undo

@Deprecated
public final void undo(CronJob cronJob)

Deprecated. obsolete feature won't be supported in the future

Undos this Job asynchronous in a separate Thread using the specified Cronjob.

Parameters:

cronJob - which is used to perform this Job

undo

@Deprecated
public final void undo(CronJob cronJob,
                                   boolean synchronous)

Deprecated. obsolete feature won't be supported in the future

Undos this Job using the specified Cronjob. If synchronous is true, the Job will be undone synchronous, which means that this method will return the control to its caller as recently as this Job is undone. Synchronous undo is especially useful for short Jobs or testing purpose (JUnit tests for example).
If synchronous is false, the Job will be undone asynchronous by executing it in a separate Thread.

Parameters:

cronJob - which will ne used to undo this Job

synchronous - true if this Job should be undone synchronously, false if this Job should be undone asynchronously

performCronJob

@Deprecated
protected abstract CronJob.CronJobResult performCronJob(CronJob cronJob)
                                                             throws AbortCronJobException

Deprecated. use CronJobService.performCronJob(de.hybris.platform.cronjob.model.CronJobModel, boolean) instead

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.

Parameters:

cronJob - the CronJob to execute

Returns:

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

Throws:

AbortCronJobException

See Also:

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

undoCronJob

@Deprecated
protected CronJob.CronJobResult undoCronJob(CronJob cronJob)

Deprecated. this feature is not available since 4.3

Overwrite this method to undo changes made in your job. This method is called, if you decide to undo your job.

Parameters:

cronJob - the CronJob to undo

Returns:

a CronJobResult that indicates whether the undo of your Job was successful or not

startOwnSession

protected JaloSession startOwnSession(CronJob cronJob)
                               throws ConsistencyCheckException

Activates a own session for executing the job. The current session is returned so it may be continued after execution.

Returns:

the current session or null if no current session is set

Throws:

ConsistencyCheckException

stopOwnSession

protected void stopOwnSession(JaloSession previousSession,
                              CronJob cronJob)

Deactivates the own session and re-activates the previous session if available.

Parameters:

previousSession -

cronJob -

setCode

public void setCode(SessionContext ctx,
                    String code)

Description copied from class: GeneratedJob

Generated method - Setter of the Job.code attribute.

Overrides:

setCode in class GeneratedJob

code - the code

Since:

2.10

configureCronjob

@Deprecated
protected void configureCronjob(CronJob cronjob)
                                     throws JaloInvalidParameterException,
                                            JaloBusinessException

Deprecated. use CronJobFactory mechanism instead, refer to appropriate wiki document

Throws:

JaloInvalidParameterException

JaloBusinessException

getConfigAttributes

@Deprecated
protected Map<String,String> getConfigAttributes(CronJob cronjob)

Deprecated. use CronJobFactory mechanism instead, refer to appropriate wiki document

createLogContext

protected CronJobLogListener.CronJobLogContext createLogContext(CronJob cronjob)

getEffectiveLogLevel

protected Level getEffectiveLogLevel(CronJob cronjob)