de.hybris.platform.cronjob.jalo

Class CronJob

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.GeneratedCronJob

de.hybris.platform.cronjob.jalo.CronJob

All Implemented Interfaces:

Serializable, Comparable

Direct Known Subclasses:

GeneratedAbstractMediaCronJob, GeneratedBTGResultCleaningCronJob, GeneratedCartRemovalCronJob, GeneratedCartToOrderCronJob, GeneratedCisFraudReportCronJob, GeneratedCleanUpCronJob, GeneratedCleanupDynamicProcessDefinitionsCronJob, GeneratedCompareCatalogVersionsCronJob, GeneratedCompositeCronJob, GeneratedCxPersonalizationProcessCleanupCronJob, GeneratedDataLoaderCronJob, GeneratedDataLoaderStopCronJob, GeneratedDataSupplierCronJob, GeneratedDeleteDocumentFileCronJob, GeneratedExportDataCronJob, GeneratedFractusSyncCronJob, GeneratedGeocodeAddressesCronJob, GeneratedImpExExportCronJob, GeneratedImpExImportCronJob, GeneratedMediaFolderStructureMigrationCronJob, GeneratedMediaProcessCronJob, GeneratedMobileSendMessageCronJob, GeneratedMoveMediaCronJob, GeneratedOldCartRemovalCronJob, GeneratedOldPaymentSubscriptionResultRemovalCronJob, GeneratedOrderScheduleCronJob, GeneratedOrderStatusUpdateCleanerCronJob, GeneratedOrderTemplateToOrderCronJob, GeneratedOrganizationOrdersReportingCronJob, GeneratedProductExpressUpdateCleanerCronJob, GeneratedRemoveCatalogVersionCronJob, GeneratedRemoveItemsCronJob, GeneratedRemoveOrphanedFilesCronJob, GeneratedSessionEventsRemovalCronJob, GeneratedSiteMapMediaCronJob, GeneratedSolrIndexerCronJob, GeneratedSolrIndexOptimizationCronJob, GeneratedSolrQueryStatisticsCollectorCronJob, GeneratedSolrUpdateStopWordsCronJob, GeneratedSolrUpdateSynonymsCronJob, GeneratedSyncItemCronJob, GeneratedUncollectedOrdersCronJob, GeneratedWorkflow, GeneratedY2YSyncCronJob

public class CronJob
extends GeneratedCronJob

The CronJob stores runtime informations, which are used by the Job/BatchJob during execution (normal & undo). For example the JaloSession which will be used during the execution of a Job/BatchJob used the values of the attributes SessionUser, SessionLanguage and SessionCurrency as presets for the SessionContext.

Furthermore all informations (JobLogs,ChangeDescriptors & CronJobResult), related to an execution of a Job are assigned to the CronJob, which was used during their execution.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CronJob.CronJobResult Deprecated. use CronJobResult
static class	CronJob.CronJobThreadSettings

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	CFG_FILTERED_CTX_ATTRIBUTES

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

ACTIVE, ALTERNATIVEDATASOURCEID, CHANGERECORDINGENABLED, CHANGES, CODE, CRONJOBPENDINGSTEPSRELATION_MARKMODIFIED, CRONJOBPENDINGSTEPSRELATION_SRC_ORDERED, CRONJOBPENDINGSTEPSRELATION_TGT_ORDERED, CRONJOBPROCESSEDSTEPSRELATION_MARKMODIFIED, CRONJOBPROCESSEDSTEPSRELATION_SRC_ORDERED, CRONJOBPROCESSEDSTEPSRELATION_TGT_ORDERED, CURRENTSTEP, DEFAULT_INITIAL_ATTRIBUTES, EMAILADDRESS, EMAILNOTIFICATIONTEMPLATE, ENDTIME, ERRORMODE, FILESCOUNT, FILESDAYSOLD, FILESOPERATOR, JOB, JOBHANDLER, LOGFILES, LOGLEVELDATABASE, LOGLEVELFILE, LOGS, LOGSCOUNT, LOGSDAYSOLD, LOGSHANDLER, LOGSOPERATOR, LOGTEXT, LOGTODATABASE, LOGTOFILE, NODEGROUP, NODEID, PENDINGSTEPS, PRIORITY, PROCESSEDSTEPS, REMOVEONEXIT, REQUESTABORT, REQUESTABORTSTEP, RESULT, RETRY, RUNNINGONCLUSTERNODE, SENDEMAIL, SESSIONCONTEXTVALUES, SESSIONCURRENCY, SESSIONLANGUAGE, SESSIONUSER, SINGLEEXECUTABLE, STARTTIME, STATUS, 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
CronJob()

Method Summary

Modifier and Type	Method and Description
static void	activateCronJobThreadSettings(CronJob.CronJobThreadSettings settings) Activates cronjob thread settings for the current thread.Use this to copy thread settings to another thread in case your cronjob starts multiple threads.
ChangeDescriptor	addChangeDescriptor(ComposedType changeDescriptorType, Step forStep, String changeType, Item item, String description) Deprecated. not supported in future
ChangeDescriptor	addChangeDescriptor(ComposedType changeDescriptorType, Step forStep, String changeType, Item item, String description, Map additionalAttributes) Deprecated. not supported in future
ChangeDescriptor	addChangeDescriptor(ComposedType changeDescriptorType, Step forStep, String changeType, PK item, String description, Map additionalAttributes) Deprecated. not supported in future
protected ChangeDescriptor	addChangeDescriptor(Step forStep, String changeType, Item item, String description) Deprecated. not supported in future
void	addChangeListener(String topic, ChangeListener listener) Registers the specified ChangeListener for the specified topic.
JobLog	addLog(String message) Adds a loggin message to this CronJob.
JobLog	addLog(String message, EnumerationValue level) Adds a loggin message with a given error level to this CronJob.
JobLog	addLog(String message, Step forStep) Deprecated. since 4.3
JobLog	addLog(String message, Step forStep, EnumerationValue level) Deprecated. since 4.3
protected JobLog	addLog(String message, Step forStep, EnumerationValue level, boolean appendToLogFile)
int	addToCounter(int add) Increases the current counter of this cronjob.
void	addToPendingSteps(SessionContext ctx, Step step) Deprecated. since 4.3
void	addToPendingSteps(Step step) Deprecated. since 4.3
void	addToProcessedSteps(SessionContext ctx, Step step) Deprecated. since 4.3
void	addToProcessedSteps(Step step) Deprecated. since 4.3
protected void	adjustAttributes(SessionContext ctx, Item.ItemAttributeMap attributes)
boolean	checkLogLevel(EnumerationValue configuredLevel, String configProperty, String defaultLevel)
Level	convertEnumToLogLevel(EnumerationValue enumvalue)
EnumerationValue	convertLogLevelToEnum(Level level)
protected Item	createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) Has to be implemented for each concrete subtype of item.
LogFile	createNewLogFile(String fileName) Deprecated. use plain LogFileModel creation, refer to wiki documentation
void	createRunOnceTrigger(Date date) Deprecated. please refer to CronJobManager.createTrigger(CronJob, Date)
protected JaloSession	createSessionForCronJob(JaloSession jaloSession) Sets the User, Language and Currency of the specified JaloSession to the values defined in GeneratedCronJob.getSessionUser(), GeneratedCronJob.getSessionLanguage(), GeneratedCronJob.getSessionCurrency().
protected void	currentStepDone(boolean undo) If undo is false the current Step is added to the list of processed Steps and the current step of the CronJob is set to null.
protected Map<String,Object>	filterSessionContextValuesFromCronJob(Map<String,Object> sessionContextValues) Session context values stored inside this cronjob are filtered for potentially harmful ones, since we cannot rule out that they're manually changed!
EnumerationValue	getAbortedStatus() Deprecated. use CronJobStatus.ABORTED instead
CronJob.CronJobResult	getAbortResult() Deprecated. use CronJobStatus.ABORTED instead
Collection<ChangeDescriptor>	getChanges(int start, int count) Deprecated. not supported in future
Collection<ChangeDescriptor>	getChanges(SessionContext ctx) Deprecated. not supported in future
Collection<ChangeDescriptor>	getChanges(SessionContext ctx, int start, int count) Deprecated. not supported in future
Collection<ChangeDescriptor>	getChanges(SessionContext ctx, Step step) Deprecated. not supported in future
Collection<ChangeDescriptor>	getChanges(SessionContext ctx, Step step, int start, int count) Deprecated. not supported in future
Collection<ChangeDescriptor>	getChanges(SessionContext ctx, Step step, String changeType) Deprecated. not supported in future
Collection<ChangeDescriptor>	getChanges(SessionContext ctx, Step step, String changeType, int start, int count) Deprecated. not supported in future
Collection<ChangeDescriptor>	getChanges(SessionContext ctx, Step step, String changeType, int start, int count, boolean ascending) Deprecated. not supported in future
Collection<ChangeDescriptor>	getChanges(SessionContext ctx, String changeType) Deprecated. not supported in future
Collection<ChangeDescriptor>	getChanges(SessionContext ctx, String changeType, int start, int count) Deprecated. not supported in future
Collection<ChangeDescriptor>	getChanges(Step step) Deprecated. not supported in future
Collection<ChangeDescriptor>	getChanges(Step step, int start, int count) Deprecated. not supported in future
Collection<ChangeDescriptor>	getChanges(Step step, String changeType) Deprecated. not supported in future
Collection<ChangeDescriptor>	getChanges(Step step, String changeType, int start, int count) Deprecated. not supported in future
Collection<ChangeDescriptor>	getChanges(Step step, String changeType, int start, int count, boolean ascending) Deprecated. not supported in future
Collection<ChangeDescriptor>	getChanges(String changeType) Deprecated. not supported in future
Collection<ChangeDescriptor>	getChanges(String changeType, int start, int count) Deprecated. not supported in future
int	getCounter() Provides the current counter value of this cronjob.
static CronJob.CronJobThreadSettings	getCronJobThreadSettings() Returns thread settings for currently executing cronjob.
protected static CronJob	getCurrentlyExecutingCronJob()
protected static CronJob	getCurrentlyExecutingCronJobFailSave()
EnumerationValue	getDebugLogLevel() Deprecated. use JobLogLevel.DEBUG instead
EnumerationValue	getErrorLogLevel() Deprecated. use JobLogLevel.ERROR instead
EnumerationValue	getErrorResult() Deprecated. use CronJobResult.ERROR instead
EnumerationValue	getFailureResult() Deprecated. use CronJobResult.FAILURE instead
EnumerationValue	getFatalLogLevel() Deprecated. use JobLogLevel.FATAL instead
protected String	getFinishedEmailBody(CronJob.CronJobResult cronJobResult)
CronJob.CronJobResult	getFinishedResult(boolean success) Deprecated. use CronJobResult instead
EnumerationValue	getFinishedStatus() Deprecated. use CronJobStatus.FINISHED instead
EnumerationValue	getInfoLogLevel() Deprecated. use JobLogLevel.INFO instead
Collection<LogFile>	getLogFiles(SessionContext ctx) Generated method - Getter of the CronJob.logFiles attribute.
EnumerationValue	getLogLevelDatabase(SessionContext ctx) Generated method - Getter of the CronJob.logLevelDatabase attribute.
EnumerationValue	getLogLevelFile(SessionContext ctx) Generated method - Getter of the CronJob.logLevelFile attribute.
List<JobLog>	getLogs(SessionContext ctx, int start, int count) Deprecated. use CronJobModel.getLogs() instead, however a strict access is available also via JobLogDao.findJobLogs(de.hybris.platform.cronjob.model.CronJobModel, int, boolean)
String	getLogText(SessionContext ctx) Deprecated. use CronJobService.getLogsAsText(de.hybris.platform.cronjob.model.CronJobModel) instead
ChangeDescriptor	getMostRecentChange(Step step, String changeType) Deprecated. not supported in future
protected Integer	getNextChangeNumber(ComposedType changeDescriptorType) Deprecated. not supported in future
CronJob.CronJobResult	getPausedResult() Deprecated. use CronJobStatus.PAUSED instead
EnumerationValue	getPausedStatus() Deprecated. use CronJobStatus.PAUSED instead
protected CronJobNotificationTemplateContext	getRendererNotificationContext() Gets filled context object used by velocity to access CronJob's significant data.
EnumerationValue	getRunningRestartStatus() Deprecated. use CronJobStatus.RUNNINGRESTART instead
EnumerationValue	getRunningStatus() Deprecated. use CronJobStatus.RUNNING instead
EnumerationValue	getSuccessResult() Deprecated. use CronJobResult.SUCCESS instead
String	getTimeTable() Deprecated.
String	getTimeTable(SessionContext ctx) Deprecated. use CronJobModel.getTimeTable() instead.
CronJob.CronJobResult	getUndoFinishedResult(boolean success) Deprecated. no counterpart since 4.3
EnumerationValue	getUnknownLogLevel() Deprecated. use JobLogLevel.UNKNOWN instead
EnumerationValue	getUnknownResult() Deprecated. use CronJobResult.UNKNOWN instead
EnumerationValue	getUnknownStatus() Deprecated. use CronJobStatus.UNKNOWN instead
EnumerationValue	getWarnLogLevel() Deprecated. use JobLogLevel.WARNING instead
protected static boolean	hasCurrentlyExecutingCronJob()
boolean	isAbortable() Deprecated. use CronJobService.isAbortable(de.hybris.platform.cronjob.model.CronJobModel)
boolean	isEnabledFor(Level level) Checks if the CronJob is enabled for logging with given log level.
boolean	isFinished() Deprecated. use CronJobService.isFinished(de.hybris.platform.cronjob.model.CronJobModel)
boolean	isPaused() Deprecated. use CronJobService.isPaused(de.hybris.platform.cronjob.model.CronJobModel)
boolean	isRunning() Deprecated. use CronJobService.isRunning(de.hybris.platform.cronjob.model.CronJobModel)
boolean	isRunningRestart() Deprecated. use CronJobService.isRunning(de.hybris.platform.cronjob.model.CronJobModel)
boolean	mustRunOnOtherNode() Tells whether or not this cronjob must be run on another node.
protected void	notifyChangeListeners(ChangeEvent event) Notifies all ChangeListeners, which are registered for the topic of the specified event.
void	remove(SessionContext ctx) Removes this item.
void	removeAllChangeListener() Removes all registered ChangeListeners.
void	removeChangeListener(String topic, ChangeListener listener) Removes the registration of specified ChangeListener for the specified topic.
void	resetCounter() Resets the transient counter of this cronjob.
protected void	resetFinishedCronJob() Reset the CronJob.
void	sendEmail(CronJob.CronJobResult cronJobResult) Sends a CronJobResult per email.
protected void	setAborted() Deprecated. use CronJobService.requestAbortCronJob(de.hybris.platform.cronjob.model.CronJobModel) instead
void	setCronJobResult(CronJob.CronJobResult res) Deprecated. no counterpart since 4.3
protected static void	setCurrentlyExecutingCronJob(CronJob cronjob)
protected void	setCurrentStep(Step step, boolean undo) Sets the current
void	setEndTime(Date end) Sets the end time.
void	setIsEnabledForCheckDifference(long diff) Sets the difference between the point of times where the cache of the isEnabledFor(Level) will be reseted.
protected void	setJob(SessionContext ctx, Job job) Generated method - Setter of the CronJob.job attribute.
void	setLogFiles(SessionContext ctx, Collection<LogFile> param) Generated method - Setter of the CronJob.logFiles attribute.
void	setNodeGroup(SessionContext ctx, String value) Generated method - Setter of the CronJob.nodeGroup attribute.
void	setNodeID(SessionContext ctx, Integer value) Generated method - Setter of the CronJob.nodeID attribute.
void	setPaused() Deprecated. there is no counterpart in service layer
void	setRequestAbort(SessionContext ctx, Boolean abortRequested) Sets the abort flag to the specified value.
void	setResult(EnumerationValue result) Sets the result.
protected void	setRunning() Deprecated. there is no strict counterpart in servicelayer however you can use CronJobService.performCronJob(de.hybris.platform.cronjob.model.CronJobModel, boolean) instead to set status for given cronJob to RUNNING
protected void	setRunningRestart() Deprecated. there is no counterpart in service layer
void	setStartTime(Date start) Sets the end time.
void	setStatus(EnumerationValue status) Sets the status.
String	toString() Returns the String representation of this item.
void	tryToStop(long maxWait) Deprecated. use CronJobService.requestAbortCronJob(de.hybris.platform.cronjob.model.CronJobModel) instead
static void	unsetCronJobThreadSettings(CronJob.CronJobThreadSettings settings) Deactivates cronjob thread settings for the current thread.
protected static void	unsetCurrentlyExecutingCronJob()

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

addToTriggers, addToTriggers, getAlternativeDataSourceID, getAlternativeDataSourceID, getChanges, getCode, getCode, getCurrentStep, getCurrentStep, getDefaultAttributeModes, getEmailAddress, getEmailAddress, getEmailNotificationTemplate, getEmailNotificationTemplate, getEndTime, getEndTime, getErrorMode, getErrorMode, getFilesCount, getFilesCount, getFilesCountAsPrimitive, getFilesCountAsPrimitive, getFilesDaysOld, getFilesDaysOld, getFilesDaysOldAsPrimitive, getFilesDaysOldAsPrimitive, getFilesOperator, getFilesOperator, getJob, getJob, getLogFiles, getLogLevelDatabase, getLogLevelFile, getLogs, getLogs, getLogsCount, getLogsCount, getLogsCountAsPrimitive, getLogsCountAsPrimitive, getLogsDaysOld, getLogsDaysOld, getLogsDaysOldAsPrimitive, getLogsDaysOldAsPrimitive, getLogsOperator, getLogsOperator, getLogText, getNodeGroup, getNodeGroup, getNodeID, getNodeID, getNodeIDAsPrimitive, getNodeIDAsPrimitive, getPendingSteps, getPendingSteps, getPendingStepsCount, getPendingStepsCount, getPriority, getPriority, getPriorityAsPrimitive, getPriorityAsPrimitive, getProcessedSteps, getProcessedSteps, getProcessedStepsCount, getProcessedStepsCount, getResult, getResult, getRunningOnClusterNode, getRunningOnClusterNode, getRunningOnClusterNodeAsPrimitive, getRunningOnClusterNodeAsPrimitive, getSessionCurrency, getSessionCurrency, getSessionLanguage, getSessionLanguage, getSessionUser, getSessionUser, getStartTime, getStartTime, getStatus, getStatus, 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, removeFromPendingSteps, removeFromPendingSteps, removeFromProcessedSteps, removeFromProcessedSteps, removeFromTriggers, removeFromTriggers, setActive, setActive, setActive, setActive, setAlternativeDataSourceID, setAlternativeDataSourceID, setChangeRecordingEnabled, setChangeRecordingEnabled, setChangeRecordingEnabled, setChangeRecordingEnabled, setCode, setCode, setEmailAddress, setEmailAddress, setEmailNotificationTemplate, setEmailNotificationTemplate, setEndTime, setErrorMode, setErrorMode, setFilesCount, setFilesCount, setFilesCount, setFilesCount, setFilesDaysOld, setFilesDaysOld, setFilesDaysOld, setFilesDaysOld, setFilesOperator, setFilesOperator, setJob, setLogFiles, setLogLevelDatabase, setLogLevelDatabase, setLogLevelFile, setLogLevelFile, setLogsCount, setLogsCount, setLogsCount, setLogsCount, setLogsDaysOld, setLogsDaysOld, setLogsDaysOld, setLogsDaysOld, setLogsOperator, setLogsOperator, setLogToDatabase, setLogToDatabase, setLogToDatabase, setLogToDatabase, setLogToFile, setLogToFile, setLogToFile, setLogToFile, setNodeGroup, setNodeID, setNodeID, setNodeID, setPendingSteps, setPendingSteps, setPriority, setPriority, setPriority, setPriority, setProcessedSteps, setProcessedSteps, setRemoveOnExit, setRemoveOnExit, setRemoveOnExit, setRemoveOnExit, setRequestAbort, setRequestAbort, setRequestAbort, setRequestAbortStep, setRequestAbortStep, setRequestAbortStep, setRequestAbortStep, setResult, setRetry, setRetry, setRetry, setRetry, setRunningOnClusterNode, setRunningOnClusterNode, setRunningOnClusterNode, setRunningOnClusterNode, setSendEmail, setSendEmail, setSendEmail, setSendEmail, setSessionCurrency, setSessionCurrency, setSessionLanguage, setSessionLanguage, setSessionUser, setSessionUser, setSingleExecutable, setSingleExecutable, setSingleExecutable, setSingleExecutable, setStartTime, setStatus, setTriggers, setTriggers

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

getInitialProperties, getNonInitialAttributes

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, checkRemovable, 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, setNonInitialAttributes, setOwner, setPermissionsByMap, setTransientObject, setUseTA, 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

CFG_FILTERED_CTX_ATTRIBUTES

public static final String CFG_FILTERED_CTX_ATTRIBUTES

See Also:

Constant Field Values

Constructor Detail

CronJob

public CronJob()

Method Detail

setCurrentlyExecutingCronJob

protected static final void setCurrentlyExecutingCronJob(CronJob cronjob)

unsetCurrentlyExecutingCronJob

protected static final void unsetCurrentlyExecutingCronJob()

getCurrentlyExecutingCronJob

protected static final CronJob getCurrentlyExecutingCronJob()

getCurrentlyExecutingCronJobFailSave

protected static final CronJob getCurrentlyExecutingCronJobFailSave()

hasCurrentlyExecutingCronJob

protected static boolean hasCurrentlyExecutingCronJob()

Since:

2.20

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 GeneratedCronJob

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

adjustAttributes

protected void adjustAttributes(SessionContext ctx,
                                Item.ItemAttributeMap attributes)

setJob

protected void setJob(SessionContext ctx,
                      Job job)

Description copied from class: GeneratedCronJob

Generated method - Setter of the CronJob.job attribute.

Overrides:

setJob in class GeneratedCronJob

job - the job - References to the Job assigned to the CronJob

remove

public void remove(SessionContext ctx)
            throws ConsistencyCheckException

Description copied from class: Item

Removes this item.

This method is using the following attributes of the given SessionContext:

CacheUsage		Language		StagingMethod
n/a (this is a setter method)		no, language doesn't matter for removal		yes if called on a StageableItem, no otherwise

Overrides:

remove in class Item

Parameters:

ctx - A SessionContext object

Throws:

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

resetCounter

public void resetCounter()

Resets the transient counter of this cronjob.

See Also:

getCounter(), addToCounter(int)

getCounter

public int getCounter()

Provides the current counter value of this cronjob.

See Also:

addToCounter(int), resetCounter()

addToCounter

public int addToCounter(int add)

Increases the current counter of this cronjob.

Parameters:

add - the amount to add

Returns:

the new counter value

See Also:

getCounter(), resetCounter()

addLog

public JobLog addLog(String message)

Adds a loggin message to this CronJob.

Parameters:

message - The logging message

Returns:

The JobLog object.

addLog

@Deprecated
public JobLog addLog(String message,
                                 Step forStep)

Deprecated. since 4.3

Adds a loggin message for the given Step to this CronJob.

Parameters:

message - The logging message

forStep - The Step this message belongs to

Returns:

The JobLog object.

addLog

public JobLog addLog(String message,
                     EnumerationValue level)

Adds a loggin message with a given error level to this CronJob.

Parameters:

message - The logging message

level - The error level

Returns:

The JobLog object.

addLog

@Deprecated
public JobLog addLog(String message,
                                 Step forStep,
                                 EnumerationValue level)

Deprecated. since 4.3

Adds a loggin message and error level for the given Step to this CronJob.

Parameters:

message - The logging message

forStep - The Step this message belongs to

level - The error level

Returns:

The JobLog object.

convertLogLevelToEnum

public EnumerationValue convertLogLevelToEnum(Level level)

convertEnumToLogLevel

public Level convertEnumToLogLevel(EnumerationValue enumvalue)

addLog

protected JobLog addLog(String message,
                        Step forStep,
                        EnumerationValue level,
                        boolean appendToLogFile)

getLogLevelDatabase

public EnumerationValue getLogLevelDatabase(SessionContext ctx)

Description copied from class: GeneratedCronJob

Generated method - Getter of the CronJob.logLevelDatabase attribute.

Overrides:

getLogLevelDatabase in class GeneratedCronJob

Returns:

the logLevelDatabase - Specifies the log level for logging to the database

getLogLevelFile

public EnumerationValue getLogLevelFile(SessionContext ctx)

Description copied from class: GeneratedCronJob

Generated method - Getter of the CronJob.logLevelFile attribute.

Overrides:

getLogLevelFile in class GeneratedCronJob

Returns:

the logLevelFile - Specifies the log level for logging to the file

checkLogLevel

public boolean checkLogLevel(EnumerationValue configuredLevel,
                             String configProperty,
                             String defaultLevel)

setIsEnabledForCheckDifference

public void setIsEnabledForCheckDifference(long diff)

Sets the difference between the point of times where the cache of the isEnabledFor(Level) will be reseted.

Parameters:

diff - the time difference in ms

isEnabledFor

public final boolean isEnabledFor(Level level)

Checks if the CronJob is enabled for logging with given log level. Will check log to database and to file configuration. The call of this method will be cached for a specific time, adjustable by setIsEnabledForCheckDifference(long).

Parameters:

level - log level to check

Returns:

cronjob is enabled for given level

getLogText

@Deprecated
public String getLogText(SessionContext ctx)

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

Returns a String representation of the last 500 JobLogs of the CronJob.

Specified by:

getLogText in class GeneratedCronJob

Parameters:

ctx - the SessionContext, which will be used

Returns:

a String representation of the last 500 JobLogs of the CronJob

getLogs

@Deprecated
public List<JobLog> getLogs(SessionContext ctx,
                                        int start,
                                        int count)

Deprecated. use CronJobModel.getLogs() instead, however a strict access is available also via JobLogDao.findJobLogs(de.hybris.platform.cronjob.model.CronJobModel, int, boolean)

Returns the specified range (from start -> (start + count)) of JobLogs as a Collection . The JobLogs are ordered by their creation time.

Parameters:

ctx - the SessionContext, which will be used

start - start index of the range

count - number of elements in the range

Returns:

the specified range (from start -> (start + count)) of JobLogs as a Collection

getChanges

@Deprecated
public Collection<ChangeDescriptor> getChanges(SessionContext ctx)

Deprecated. not supported in future

Returns a Collection of all ChangeDescriptors which are assigned to the CronJob. If the number of ChangeDescriptors is very high, consider using getChanges(SessionContext, int, int) method.

Specified by:

getChanges in class GeneratedCronJob

Parameters:

ctx - the SessionContext, which will be used

Returns:

a Collection of all ChangeDescriptors which are assigned to the CronJob

getChanges

@Deprecated
public Collection<ChangeDescriptor> getChanges(SessionContext ctx,
                                                           Step step)

Deprecated. not supported in future

Returns a Collection of all ChangeDescriptors which are assigned to the CronJob and the specified Step. If the number of ChangeDescriptors is very high, consider using getChanges(SessionContext, Step, int, int) method.

Parameters:

ctx - the SessionContext, which will be used

step - the Step, whose ChangeDescriptors should be returned

Returns:

a Collection of all ChangeDescriptors which are assigned to the CronJob and the specified Step

getChanges

@Deprecated
public Collection<ChangeDescriptor> getChanges(Step step)

Deprecated. not supported in future

Returns a Collection of all ChangeDescriptors which are assigned to the CronJob and the specified Step. If the number of ChangeDescriptors is very high, consider using getChanges(SessionContext, Step, int, int) method.

Parameters:

step - the Step, whose ChangeDescriptors should be returned

Returns:

a Collection of all ChangeDescriptors which are assigned to the CronJob and the specified Step

getChanges

@Deprecated
public Collection<ChangeDescriptor> getChanges(String changeType)

Deprecated. not supported in future

Returns a Collection of all ChangeDescriptors with the specified changeType and which are assigned to the CronJob. If the number of ChangeDescriptors is very high, consider using getChanges(String, int, int).

Parameters:

changeType - the changeType

Returns:

a Collection of all ChangeDescriptors with the specified changeType and which are assigned to the CronJob. If the number of ChangeDescriptors is very high, consider using getChanges(String, int, int)

getChanges

@Deprecated
public Collection<ChangeDescriptor> getChanges(SessionContext ctx,
                                                           String changeType)

Deprecated. not supported in future

Returns a Collection of all ChangeDescriptors with the specified changeType and which are assigned to the CronJob. If the number of ChangeDescriptors is very high, consider using getChanges(String, int, int).

Parameters:

ctx - the SessionContext, which will be used

changeType - the changeType

Returns:

a Collection of all ChangeDescriptors with the specified changeType and which are assigned to the CronJob. If the number of ChangeDescriptors is very high, consider using getChanges(String, int, int)

getChanges

@Deprecated
public Collection<ChangeDescriptor> getChanges(Step step,
                                                           String changeType)

Deprecated. not supported in future

Returns a Collection of all ChangeDescriptors with the specified changeType and which are assigned to the CronJob and the specified Step.

Parameters:

step - the Step, whose ChangeDescriptors should be returned

changeType - the changeType

Returns:

a Collection of all ChangeDescriptors which are assigned to the CronJob and the specified Step

getChanges

@Deprecated
public Collection<ChangeDescriptor> getChanges(SessionContext ctx,
                                                           Step step,
                                                           String changeType)

Deprecated. not supported in future

Returns a Collection of all ChangeDescriptors with the specified changeType and which are assigned to the CronJob and the specified Step.

Parameters:

ctx - the SessionContext, which will be used

step - the Step, whose ChangeDescriptors should be returned

changeType - the changeType

Returns:

a Collection of all ChangeDescriptors which are assigned to the CronJob and the specified Step

getChanges

@Deprecated
public Collection<ChangeDescriptor> getChanges(int start,
                                                           int count)

Deprecated. not supported in future

Returns the specified range (from start -> (start + count)) of ChangeDescriptors as a Collection. The ChangeDescriptors are ordered by their creation time.

Parameters:

start - start index of the range

count - number of elements in the range

Returns:

the specified range (from start -> (start + count)) of ChangeDescriptors as a Collection

getChanges

@Deprecated
public Collection<ChangeDescriptor> getChanges(SessionContext ctx,
                                                           int start,
                                                           int count)

Deprecated. not supported in future

Returns the specified range (from start -> (start + count)) of ChangeDescriptors as a Collection. The ChangeDescriptors are ordered by their creation time.

Parameters:

ctx - the SessionContext, which will be used

start - start index of the range

count - number of elements in the range

Returns:

the specified range (from start -> (start + count)) of ChangeDescriptors as a Collection

getChanges

@Deprecated
public Collection<ChangeDescriptor> getChanges(Step step,
                                                           int start,
                                                           int count)

Deprecated. not supported in future

Returns the specified range (from start -> (start + count)) of ChangeDescriptors as a Collection which are assigned to the specified Step. The ChangeDescriptors are ordered by their creation time.

Parameters:

step - the Step, whose ChangeDescriptors should be returned

start - start index of the range

count - number of elements in the range

Returns:

the specified range (from start -> (start + count)) of ChangeDescriptors as a Collection

getChanges

@Deprecated
public Collection<ChangeDescriptor> getChanges(SessionContext ctx,
                                                           Step step,
                                                           int start,
                                                           int count)

Deprecated. not supported in future

Returns the specified range (from start -> (start + count)) of ChangeDescriptors as a Collection which are assigned to the specified Step. The ChangeDescriptors are ordered by their creation time.

Parameters:

ctx - the SessionContext, which will be used

step - the Step, whose ChangeDescriptors should be returned

start - start index of the range

count - number of elements in the range

Returns:

the specified range (from start -> (start + count)) of ChangeDescriptors as a Collection

getChanges

@Deprecated
public Collection<ChangeDescriptor> getChanges(String changeType,
                                                           int start,
                                                           int count)

Deprecated. not supported in future

Returns the specified range (from start -> (start + count)) of ChangeDescriptors as a Collection which have the specified changeType. The ChangeDescriptors are ordered by their creation time.

Parameters:

changeType - the changeType

start - start index of the range

count - number of elements in the range

Returns:

the specified range (from start -> (start + count)) of ChangeDescriptors as a Collection

getChanges

@Deprecated
public Collection<ChangeDescriptor> getChanges(SessionContext ctx,
                                                           String changeType,
                                                           int start,
                                                           int count)

Deprecated. not supported in future

Returns the specified range (from start -> (start + count)) of ChangeDescriptors as a Collection which have the specified changeType. The ChangeDescriptors are ordered by their creation time.

Parameters:

ctx - the SessionContext, which will be used

changeType - the changeType

start - start index of the range

count - number of elements in the range

Returns:

the specified range (from start -> (start + count)) of ChangeDescriptors as a Collection

getChanges

@Deprecated
public Collection<ChangeDescriptor> getChanges(Step step,
                                                           String changeType,
                                                           int start,
                                                           int count)

Deprecated. not supported in future

Returns the specified range (from start -> (start + count)) of ChangeDescriptors as a Collection which have the specified changeType and are assigned to the specified Step. The ChangeDescriptors are ordered by their creation time.

Parameters:

step - the Step, whose ChangeDescriptors should be returned

changeType - the changeType

start - start index of the range

count - number of elements in the range

Returns:

the specified range (from start -> (start + count)) of ChangeDescriptors as a Collection

getChanges

@Deprecated
public Collection<ChangeDescriptor> getChanges(SessionContext ctx,
                                                           Step step,
                                                           String changeType,
                                                           int start,
                                                           int count)

Deprecated. not supported in future

Returns the specified range (from start -> (start + count)) of ChangeDescriptors as a Collection which have the specified changeType and are assigned to the specified Step. The ChangeDescriptors are ordered by their creation time.

Parameters:

ctx - the SessionContext, which will be used

step - the Step, whose ChangeDescriptors should be returned

changeType - the changeType

start - start index of the range

count - number of elements in the range

Returns:

the specified range (from start -> (start + count)) of ChangeDescriptors as a Collection

getChanges

@Deprecated
public Collection<ChangeDescriptor> getChanges(Step step,
                                                           String changeType,
                                                           int start,
                                                           int count,
                                                           boolean ascending)

Deprecated. not supported in future

Returns the specified range (from start -> (start + count)) of ChangeDescriptors as a Collection which have the specified changeType and are assigned to the specified Step. The ChangeDescriptors are ordered by their creation time.

Parameters:

step - the Step, whose ChangeDescriptors should be returned

changeType - the changeType

start - start index of the range

count - number of elements in the range

ascending - order of elements by sequencenumber

Returns:

the specified range (from start -> (start + count)) of ChangeDescriptors as a Collection

getChanges

@Deprecated
public Collection<ChangeDescriptor> getChanges(SessionContext ctx,
                                                           Step step,
                                                           String changeType,
                                                           int start,
                                                           int count,
                                                           boolean ascending)

Deprecated. not supported in future

Returns the specified range (from start -> (start + count)) of ChangeDescriptors as a Collection which have the specified changeType and are assigned to the specified Step. The ChangeDescriptors are ordered by their creation time.

Parameters:

ctx - the SessionContext, which will be used

step - the Step, whose ChangeDescriptors should be returned

changeType - the changeType

start - start index of the range

count - number of elements in the range

ascending - order of elements by sequencenumber

Returns:

the specified range (from start -> (start + count)) of ChangeDescriptors as a Collection

getMostRecentChange

@Deprecated
public ChangeDescriptor getMostRecentChange(Step step,
                                                        String changeType)

Deprecated. not supported in future

Returns the most recent ChangeDescriptor of the CronJob which is assigned to the specified Step and has the specified changeType.

Parameters:

step - the Step, whose ChangeDescriptors should be returned

changeType - The change type

Returns:

the most recent ChangeDescriptor of the CronJob which is assigned to the specified Step and has the specified changeType

addChangeDescriptor

@Deprecated
protected ChangeDescriptor addChangeDescriptor(Step forStep,
                                                           String changeType,
                                                           Item item,
                                                           String description)

Deprecated. not supported in future

Creates a new ChangeDescriptor with the specified Step, changeType, Item and description.

Parameters:

forStep - the Step of the new ChangeDescriptor

changeType - the changeType of the new ChangeDescriptor

item - the Item of the new ChangeDescriptor

description - the description of the new ChangeDescriptor

Returns:

the new ChangeDescriptor

getNextChangeNumber

@Deprecated
protected Integer getNextChangeNumber(ComposedType changeDescriptorType)

Deprecated. not supported in future

Returns the next sequence number for the specified changeDescriptorType.

Parameters:

changeDescriptorType - the changeDescriptorType

Returns:

the next sequence number for the specified changeDescriptorType

addChangeDescriptor

@Deprecated
public ChangeDescriptor addChangeDescriptor(ComposedType changeDescriptorType,
                                                        Step forStep,
                                                        String changeType,
                                                        Item item,
                                                        String description)

Deprecated. not supported in future

Creates a new ChangeDescriptor with the specified Step, changeType, Item and description.

Parameters:

changeDescriptorType - the changeDescriptorType

forStep - the Step of the new ChangeDescriptor

changeType - the changeType of the new ChangeDescriptor

item - the Item of the new ChangeDescriptor

description - the description of the new ChangeDescriptor

Returns:

the new ChangeDescriptor

addChangeDescriptor

@Deprecated
public ChangeDescriptor addChangeDescriptor(ComposedType changeDescriptorType,
                                                        Step forStep,
                                                        String changeType,
                                                        Item item,
                                                        String description,
                                                        Map additionalAttributes)

Deprecated. not supported in future

Creates a new ChangeDescriptor with the specified Step, changeType, Item and description.

Parameters:

changeDescriptorType - the changeDescriptorType

forStep - the Step of the new ChangeDescriptor

changeType - the changeType of the new ChangeDescriptor

item - the Item of the new ChangeDescriptor

description - the description of the new ChangeDescriptor

additionalAttributes - the additional attribute values for the specified changeDescriptorType

Returns:

the new ChangeDescriptor

addChangeDescriptor

@Deprecated
public ChangeDescriptor addChangeDescriptor(ComposedType changeDescriptorType,
                                                        Step forStep,
                                                        String changeType,
                                                        PK item,
                                                        String description,
                                                        Map additionalAttributes)

Deprecated. not supported in future

Creates a new ChangeDescriptor with the specified Step, changeType, Item and description.

Parameters:

changeDescriptorType - the changeDescriptorType

forStep - the Step of the new ChangeDescriptor

changeType - the changeType of the new ChangeDescriptor

item - the Item PK of the new ChangeDescriptor

description - the description of the new ChangeDescriptor

additionalAttributes - the additional attribute values for the specified changeDescriptorType

Returns:

the new ChangeDescriptor

setStatus

public void setStatus(EnumerationValue status)

Sets the status.

This attribute is configured to be not writable (items.xml), because the value should only be set by Jalo itself and not by other clients (like the HMC), which are using the generic access methods.

Overrides:

setStatus in class GeneratedCronJob

Parameters:

status - the new status

setResult

public void setResult(EnumerationValue result)

Sets the result.

This attribute is configured to be not writable (items.xml), because the value should only be set by Jalo itself and not by other clients (like the HMC), which are using the generic access methods.

Overrides:

setResult in class GeneratedCronJob

Parameters:

result - the new result

setStartTime

public void setStartTime(Date start)

Sets the end time.

This attribute is configured to be not writable (items.xml), because the value should only be set by Jalo itself and not by other clients (like the HMC), which are using the generic access methods.

Overrides:

setStartTime in class GeneratedCronJob

Parameters:

start - the new start time

setEndTime

public void setEndTime(Date end)

Sets the end time.

This attribute is configured to be not writable (items.xml), because the value should only be set by Jalo itself and not by other clients (like the HMC), which are using the generic access methods.

Overrides:

setEndTime in class GeneratedCronJob

Parameters:

end - the new end time

setCurrentStep

protected void setCurrentStep(Step step,
                              boolean undo)

Sets the current

Parameters:

step -

undo -

currentStepDone

protected void currentStepDone(boolean undo)

If undo is false the current Step is added to the list of processed Steps and the current step of the CronJob is set to null. If undo is true, the current Step is added to the begining of the list of pending Steps and the current step of the CronJob is set to null.

Parameters:

undo - true if in undo mode, false if in normal mode.

toString

public String toString()

Description copied from class: Item

Returns the String representation of this item. This is by default the representation of the primary key of this item.

Overrides:

toString in class Item

Returns:

the String representation of this item.

getFatalLogLevel

@Deprecated
public EnumerationValue getFatalLogLevel()

Deprecated. use JobLogLevel.FATAL instead

Returns the EnumerationValue for log level FATAL.

Returns:

the EnumerationValue for log level FATAL

getErrorLogLevel

@Deprecated
public EnumerationValue getErrorLogLevel()

Deprecated. use JobLogLevel.ERROR instead

Returns the EnumerationValue for log level ERROR.

Returns:

the EnumerationValue for log level ERROR

getWarnLogLevel

@Deprecated
public EnumerationValue getWarnLogLevel()

Deprecated. use JobLogLevel.WARNING instead

Returns the EnumerationValue for log level WARNING.

Returns:

the EnumerationValue for log level WARNING

getInfoLogLevel

@Deprecated
public EnumerationValue getInfoLogLevel()

Deprecated. use JobLogLevel.INFO instead

Returns the EnumerationValue for log level INFO.

Returns:

the EnumerationValue for log level INFO

getDebugLogLevel

@Deprecated
public EnumerationValue getDebugLogLevel()

Deprecated. use JobLogLevel.DEBUG instead

Returns the EnumerationValue for log level DEBUG.

Returns:

the EnumerationValue for log level DEBUG

getUnknownLogLevel

@Deprecated
public EnumerationValue getUnknownLogLevel()

Deprecated. use JobLogLevel.UNKNOWN instead

Returns the EnumerationValue for log level UNKNOWN.

Returns:

the EnumerationValue for log level UNKNOWN

getFinishedStatus

@Deprecated
public EnumerationValue getFinishedStatus()

Deprecated. use CronJobStatus.FINISHED instead

Returns the EnumerationValue for CronJob status FINISHED.

Returns:

the EnumerationValue for CronJob status FINISHED

getRunningStatus

@Deprecated
public EnumerationValue getRunningStatus()

Deprecated. use CronJobStatus.RUNNING instead

Returns the EnumerationValue for CronJob status RUNNING.

Returns:

the EnumerationValue for CronJob status RUNNING

getRunningRestartStatus

@Deprecated
public EnumerationValue getRunningRestartStatus()

Deprecated. use CronJobStatus.RUNNINGRESTART instead

Returns the EnumerationValue for CronJob status RUNNINGRESTART.

Returns:

the EnumerationValue for CronJob status RUNNINGRESTART

getPausedStatus

@Deprecated
public EnumerationValue getPausedStatus()

Deprecated. use CronJobStatus.PAUSED instead

Returns the EnumerationValue for CronJob status PAUSED.

Returns:

the EnumerationValue for CronJob status PAUSED

getAbortedStatus

@Deprecated
public EnumerationValue getAbortedStatus()

Deprecated. use CronJobStatus.ABORTED instead

Returns the EnumerationValue for CronJob status ABORTED.

Returns:

the EnumerationValue for CronJob status ABORTED

getUnknownStatus

@Deprecated
public EnumerationValue getUnknownStatus()

Deprecated. use CronJobStatus.UNKNOWN instead

Returns the EnumerationValue for CronJob status UNKNOWN.

Returns:

the EnumerationValue for CronJob status UNKNOWN

getErrorResult

@Deprecated
public EnumerationValue getErrorResult()

Deprecated. use CronJobResult.ERROR instead

Returns the EnumerationValue for CronJob result ERROR.

Returns:

the EnumerationValue for CronJob result ERROR

getFailureResult

@Deprecated
public EnumerationValue getFailureResult()

Deprecated. use CronJobResult.FAILURE instead

Returns the EnumerationValue for CronJob result FAILURE.

Returns:

the EnumerationValue for CronJob result FAILURE

getSuccessResult

@Deprecated
public EnumerationValue getSuccessResult()

Deprecated. use CronJobResult.SUCCESS instead

Returns the EnumerationValue for CronJob result SUCCESS.

Returns:

the EnumerationValue for CronJob result SUCCESS

getUnknownResult

@Deprecated
public EnumerationValue getUnknownResult()

Deprecated. use CronJobResult.UNKNOWN instead

Returns the EnumerationValue for CronJob result UNKNOWN.

Returns:

the EnumerationValue for CronJob result UNKNOWN

tryToStop

@Deprecated
public void tryToStop(long maxWait)
                           throws JaloInvalidParameterException

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

Tries to stop a cronjob which is currently being executed.

Parameters:

maxWait - the maximum time to wait for the cronjob to abort

Throws:

JaloInvalidParameterException - if the assoziated job does not support abort

Since:

2.10

isRunning

@Deprecated
public boolean isRunning()

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

Returns true if the CronJob is currently running.

Returns:

true if the CronJob is currently running

isRunningRestart

@Deprecated
public boolean isRunningRestart()

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

Returns true if the CronJob has been restarted and is currently running.

Returns:

true if the CronJob has been restarted and is currently running

isPaused

@Deprecated
public boolean isPaused()

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

Returns true if the CronJob is currently paused.

Returns:

true if the CronJob is currently paused

isFinished

@Deprecated
public boolean isFinished()

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

Returns true if the CronJob has been finished.

Returns:

true if the CronJob has been finished

setRunning

@Deprecated
protected void setRunning()
                               throws IllegalStateException

Deprecated. there is no strict counterpart in servicelayer however you can use CronJobService.performCronJob(de.hybris.platform.cronjob.model.CronJobModel, boolean) instead to set status for given cronJob to RUNNING

Sets the status of the CronJob to RUNNING.

Throws:

IllegalStateException - if the status of the CronJob is already RUNNING

setRunningRestart

@Deprecated
protected void setRunningRestart()
                                      throws IllegalStateException

Deprecated. there is no counterpart in service layer

Sets the status of the CronJob to RUNNINGRESTART.

Throws:

IllegalStateException - if the status of the CronJob is already RUNNING or RUNNINGRESTART

setPaused

@Deprecated
public void setPaused()
                           throws IllegalStateException

Deprecated. there is no counterpart in service layer

Sets the status of the CronJob to PAUSED.

Throws:

IllegalStateException - if the status of the CronJob is not RUNNING or RUNNINGRESTART

setAborted

@Deprecated
protected void setAborted()

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

Sets the status of the CronJob to ABORTED.

Throws:

IllegalStateException - if the status of the CronJob is not RUNNING or RUNNINGRESTART

getFinishedResult

@Deprecated
public CronJob.CronJobResult getFinishedResult(boolean success)

Deprecated. use CronJobResult instead

Returns a new CronJobResult instance. Depending on the parameter success either a failure result or a success result is returned.

Parameters:

success - if true a success result will be returned

Returns:

a new CronJobResult instance

getUndoFinishedResult

@Deprecated
public CronJob.CronJobResult getUndoFinishedResult(boolean success)

Deprecated. no counterpart since 4.3

Returns a new CronJobResult instance. Depending on the parameter success either a failure result or a success result is returned.

Parameters:

success - if true a success result will be returned

Returns:

a new CronJobResult instance

getAbortResult

@Deprecated
public CronJob.CronJobResult getAbortResult()

Deprecated. use CronJobStatus.ABORTED instead

getPausedResult

@Deprecated
public CronJob.CronJobResult getPausedResult()

Deprecated. use CronJobStatus.PAUSED instead

setCronJobResult

@Deprecated
public void setCronJobResult(CronJob.CronJobResult res)

Deprecated. no counterpart since 4.3

createSessionForCronJob

protected JaloSession createSessionForCronJob(JaloSession jaloSession)

Sets the User, Language and Currency of the specified JaloSession to the values defined in GeneratedCronJob.getSessionUser(), GeneratedCronJob.getSessionLanguage(), GeneratedCronJob.getSessionCurrency().

Parameters:

jaloSession - the JaloSession, which should be modified

Returns:

the modified JaloSession

filterSessionContextValuesFromCronJob

protected Map<String,Object> filterSessionContextValuesFromCronJob(Map<String,Object> sessionContextValues)

Session context values stored inside this cronjob are filtered for potentially harmful ones, since we cannot rule out that they're manually changed!

resetFinishedCronJob

protected void resetFinishedCronJob()
                             throws IllegalStateException

Reset the CronJob. This includes:

• Setting the current Step to .
• Adding all processed Steps to the list of pending steps and clearing the list of processed steps.
• Setting the status to UNKNOWN.
• Setting start- and endtime to null.

Throws:

IllegalStateException - if the CronJob has not the status FINISHED

sendEmail

public void sendEmail(CronJob.CronJobResult cronJobResult)
               throws EmailException

Sends a CronJobResult per email. The following properties of your project|local.properties are used:

• mail.from: Sender address of the email
• mail.replyto: Replyto address of the email

The email will be send to the email address specified in GeneratedCronJob.getEmailAddress().

Parameters:

cronJobResult - the CronJobResult, which will be send per email

Throws:

EmailException - if the sending of the email was not successful.

getRendererNotificationContext

protected CronJobNotificationTemplateContext getRendererNotificationContext()

Gets filled context object used by velocity to access CronJob's significant data. If in any sub types any other fields are needed simple overwrite getRendererNotificationContext returning any others getters

Returns:

interface used by velocity to access CronJob's significant data

Since:

3.1-u7

getFinishedEmailBody

protected String getFinishedEmailBody(CronJob.CronJobResult cronJobResult)

Since:

2.10

addChangeListener

public void addChangeListener(String topic,
                              ChangeListener listener)

Registers the specified ChangeListener for the specified topic.

Parameters:

topic - the topic the ChangeListener will be regiersted for

listener - the ChangeListener which should be registered

removeChangeListener

public void removeChangeListener(String topic,
                                 ChangeListener listener)

Removes the registration of specified ChangeListener for the specified topic.

Parameters:

topic - the topic the ChangeListener should be deregiersted form

listener - the ChangeListener which should be deregistered

removeAllChangeListener

public void removeAllChangeListener()

Removes all registered ChangeListeners.

notifyChangeListeners

protected final void notifyChangeListeners(ChangeEvent event)

Notifies all ChangeListeners, which are registered for the topic of the specified event.

Parameters:

event - the ChangeEvent all registered ChangeListeners should be notfied from

getTimeTable

@Deprecated
public String getTimeTable(SessionContext ctx)

Deprecated. use CronJobModel.getTimeTable() instead.

Returns a localized text, representing the timetable(s) of the CronJobs trigger(s).

Parameters:

ctx - the SessionContext, which will be used

Returns:

the localized timeTable text

addToPendingSteps

@Deprecated
public void addToPendingSteps(SessionContext ctx,
                                          Step step)

Deprecated. since 4.3

Appends the specified Step to the list of pending steps. This method is only used, if the assigned Job (GeneratedCronJob.getJob()) is a BatchJob.

Overrides:

addToPendingSteps in class GeneratedCronJob

Parameters:

ctx - the SessionContext, which will be used

step - the Step, which will be appended

addToPendingSteps

@Deprecated
public void addToPendingSteps(Step step)

Deprecated. since 4.3

Appends the specified Step to the list of pending steps. This method is only used, if the assigned Job (GeneratedCronJob.getJob()) is a BatchJob.

Overrides:

addToPendingSteps in class GeneratedCronJob

Parameters:

step - the Step, which will be appended

addToProcessedSteps

@Deprecated
public void addToProcessedSteps(SessionContext ctx,
                                            Step step)

Deprecated. since 4.3

Appends the specified Step to the list of processed steps. This method is only used, if the assigned Job (GeneratedCronJob.getJob()) is a BatchJob.

Overrides:

addToProcessedSteps in class GeneratedCronJob

Parameters:

ctx - the SessionContext, which will be used

step - the Step, which will be appended

addToProcessedSteps

@Deprecated
public void addToProcessedSteps(Step step)

Deprecated. since 4.3

Appends the specified Step to the list of processed steps. This method is only used, if the assigned Job (GeneratedCronJob.getJob()) is a BatchJob.

Overrides:

addToProcessedSteps in class GeneratedCronJob

Parameters:

step - the Step, which will be appended

mustRunOnOtherNode

public boolean mustRunOnOtherNode()

Tells whether or not this cronjob must be run on another node. This may be the case when clustering is enabled and the current server instance is different from the one specified within the conjob (see { GeneratedCronJob.getNodeID()).

createRunOnceTrigger

@Deprecated
public void createRunOnceTrigger(Date date)

Deprecated. please refer to CronJobManager.createTrigger(CronJob, Date)

getTimeTable

@Deprecated
public String getTimeTable()

Deprecated.

Returns a localized text, representing the timetable(s) of the CronJobs trigger(s).

Returns:

the localized timeTable text

isAbortable

@Deprecated
public boolean isAbortable()

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

Tells whether this cronjob is abortable. This method simply delegates to Job.isAbortable(CronJob).

setRequestAbort

public void setRequestAbort(SessionContext ctx,
                            Boolean abortRequested)

Sets the abort flag to the specified value.

Overrides:

setRequestAbort in class GeneratedCronJob

Parameters:

ctx - the SessionContext, which will be used

abortRequested -

createNewLogFile

@Deprecated
public LogFile createNewLogFile(String fileName)

Deprecated. use plain LogFileModel creation, refer to wiki documentation

getLogFiles

public Collection<LogFile> getLogFiles(SessionContext ctx)

Description copied from class: GeneratedCronJob

Generated method - Getter of the CronJob.logFiles attribute.

Specified by:

getLogFiles in class GeneratedCronJob

Returns:

the logFiles - A list of log files related to the current CronJob

setLogFiles

public void setLogFiles(SessionContext ctx,
                        Collection<LogFile> param)

Description copied from class: GeneratedCronJob

Generated method - Setter of the CronJob.logFiles attribute.

Specified by:

setLogFiles in class GeneratedCronJob

param - the logFiles - A list of log files related to the current CronJob

setNodeID

public void setNodeID(SessionContext ctx,
                      Integer value)

Description copied from class: GeneratedCronJob

Generated method - Setter of the CronJob.nodeID attribute.

Overrides:

setNodeID in class GeneratedCronJob

value - the nodeID - The number of the cluster node on which the CronJob is to be run. This setting is relevant for clustered hybris Suite installations only.

setNodeGroup

public void setNodeGroup(SessionContext ctx,
                         String value)

Description copied from class: GeneratedCronJob

Generated method - Setter of the CronJob.nodeGroup attribute.

Overrides:

setNodeGroup in class GeneratedCronJob

value - the nodeGroup

getCronJobThreadSettings

public static CronJob.CronJobThreadSettings getCronJobThreadSettings()

Returns thread settings for currently executing cronjob. Use this to copy thread settings to another thread in case your cronjob starts multiple threads.

Since:

3.1-u7

See Also:

activateCronJobThreadSettings(CronJobThreadSettings), unsetCronJobThreadSettings(CronJobThreadSettings)

activateCronJobThreadSettings

public static void activateCronJobThreadSettings(CronJob.CronJobThreadSettings settings)

Activates cronjob thread settings for the current thread.Use this to copy thread settings to another thread in case your cronjob starts multiple threads.

Since:

3.1-u7

See Also:

getCronJobThreadSettings(), unsetCronJobThreadSettings(CronJobThreadSettings)

unsetCronJobThreadSettings

public static void unsetCronJobThreadSettings(CronJob.CronJobThreadSettings settings)

Deactivates cronjob thread settings for the current thread. Use this after copying thread settings to another thread in case your cronjob starts multiple threads.

Since:

3.1-u7

See Also:

getCronJobThreadSettings(), activateCronJobThreadSettings(CronJobThreadSettings)