Package de.hybris.platform.ruleengineservices.jobs.impl

Class AbstractRuleEngineJob

java.lang.Object

de.hybris.platform.servicelayer.cronjob.AbstractJobPerformable<RuleEngineCronJobModel>

de.hybris.platform.ruleengineservices.jobs.impl.AbstractRuleEngineJob

All Implemented Interfaces:

RuleEngineJobPerformable<RuleEngineCronJobModel>, JobPerformable<RuleEngineCronJobModel>

Direct Known Subclasses:

RuleEngineAllModulesInitJobPerformable, RuleEngineArchiveJobPerformable, RuleEngineCompilePublishJobPerformable, RuleEngineModuleInitJobPerformable, RuleEngineModuleSyncJobPerformable, RuleEngineUndeployJobPerformable

public abstract class AbstractRuleEngineJob
extends AbstractJobPerformable<RuleEngineCronJobModel>
implements RuleEngineJobPerformable<RuleEngineCronJobModel>

Abstract implementation of JobPerformable for rule engine tasks

Field Summary

Fields

Modifier and Type	Field	Description
protected static PerformResult	ABORTED_RESULT
protected static PerformResult	FAILURE_RESULT
protected static PerformResult	SUCCESS_RESULT

Fields inherited from class de.hybris.platform.servicelayer.cronjob.AbstractJobPerformable

flexibleSearchService, modelService, sessionService

Constructor Summary

Constructors

Constructor	Description
AbstractRuleEngineJob()

Method Summary

Modifier and Type	Method	Description
protected CronJobProgressTracker	createCronJobProgressTracker(RuleEngineCronJobModel cronJob)
protected abstract java.lang.String	getJobName()
protected ModelService	getModelService()
protected PerformResult	getPerformResult(RuleEngineCronJobModel cronJob, RuleCompilerPublisherResult result)
protected RuleEngineJobExecutionSynchronizer	getRuleEngineJobExecutionSynchronizer()
protected RuleMaintenanceService	getRuleMaintenanceService()
protected boolean	hasErrors(RuleCompilerPublisherResult result)
protected boolean	hasPublisherErrors(RuleCompilerPublisherResult result)
boolean	isAbortable()	Checks whether the execution is implemented abortable.
boolean	isPerformable(RuleEngineCronJobModel cronJob)	Identifies whether provided cron job can be performed
protected void	logCompilerErrorMessages(RuleEngineCronJobModel cronJob, RuleCompilerPublisherResult ruleResults)
protected void	logOnFailedJobFinish()
protected void	logOnJobStart()
protected void	logOnSuccessfulJobFinish()
protected void	logPublisherErrorMessages(RuleEngineCronJobModel cronJob, RuleCompilerPublisherResult ruleResults)
protected void	logToDatabase(RuleEngineCronJobModel cronJob, java.lang.String error)
protected void	onError(RuleEngineCronJobModel cronJob, RuleCompilerPublisherResult ruleResults)
PerformResult	perform(RuleEngineCronJobModel cronJob)	The execution body for a ServicelayerJob.
protected abstract java.util.Optional<RuleCompilerPublisherResult>	performInternal(RuleEngineCronJobModel cronJob, CronJobProgressTracker tracker)
void	setRuleEngineJobExecutionSynchronizer(RuleEngineJobExecutionSynchronizer ruleEngineJobExecutionSynchronizer)
void	setRuleMaintenanceService(RuleMaintenanceService ruleMaintenanceService)
protected void	setTrackerProgress(CronJobProgressTracker tracker, double progress)

Methods inherited from class de.hybris.platform.servicelayer.cronjob.AbstractJobPerformable

clearAbortRequestedIfNeeded, isPerformable, setFlexibleSearchService, setModelService, setSessionService

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.servicelayer.cronjob.JobPerformable

isPerformable

Field Detail

SUCCESS_RESULT

protected static final PerformResult SUCCESS_RESULT

FAILURE_RESULT

protected static final PerformResult FAILURE_RESULT

ABORTED_RESULT

protected static final PerformResult ABORTED_RESULT

Constructor Detail

AbstractRuleEngineJob

public AbstractRuleEngineJob()

Method Detail

perform

public PerformResult perform(RuleEngineCronJobModel cronJob)

Description copied from interface: JobPerformable

The execution body for a ServicelayerJob. Implement here your execution logic. It can be called synchronous or asynchronous. So be aware of thread-safety. Method will return a result object saying if the execution has reached end and if it was successful.

Specified by:

perform in interface JobPerformable<RuleEngineCronJobModel>

Specified by:

perform in class AbstractJobPerformable<RuleEngineCronJobModel>

Parameters:

cronJob - the related CronJob in whose context the execution will be performed.

Returns:

a PerformResult that indicates whether the execution was successfully executed or not and has finished or not.

isAbortable

public boolean isAbortable()

Description copied from interface: JobPerformable

Checks whether the execution is implemented abortable.

Specified by:

isAbortable in interface JobPerformable<RuleEngineCronJobModel>

Overrides:

isAbortable in class AbstractJobPerformable<RuleEngineCronJobModel>

Returns:

true if the execution can be aborted

isPerformable

public boolean isPerformable(RuleEngineCronJobModel cronJob)

Description copied from interface: RuleEngineJobPerformable

Identifies whether provided cron job can be performed

Specified by:

isPerformable in interface RuleEngineJobPerformable<RuleEngineCronJobModel>

Parameters:

cronJob - - cron job instance

Returns:

true in case cron job can be performed, false - otherwise

performInternal

protected abstract java.util.Optional<RuleCompilerPublisherResult> performInternal(RuleEngineCronJobModel cronJob,
                                                                                   CronJobProgressTracker tracker)

createCronJobProgressTracker

protected CronJobProgressTracker createCronJobProgressTracker(RuleEngineCronJobModel cronJob)

getJobName

protected abstract java.lang.String getJobName()

getPerformResult

protected PerformResult getPerformResult(RuleEngineCronJobModel cronJob,
                                         RuleCompilerPublisherResult result)

hasErrors

protected boolean hasErrors(RuleCompilerPublisherResult result)

hasPublisherErrors

protected boolean hasPublisherErrors(RuleCompilerPublisherResult result)

onError

protected void onError(RuleEngineCronJobModel cronJob,
                       RuleCompilerPublisherResult ruleResults)

logCompilerErrorMessages

protected void logCompilerErrorMessages(RuleEngineCronJobModel cronJob,
                                        RuleCompilerPublisherResult ruleResults)

logPublisherErrorMessages

protected void logPublisherErrorMessages(RuleEngineCronJobModel cronJob,
                                         RuleCompilerPublisherResult ruleResults)

logToDatabase

protected void logToDatabase(RuleEngineCronJobModel cronJob,
                             java.lang.String error)

logOnJobStart

protected void logOnJobStart()

logOnSuccessfulJobFinish

protected void logOnSuccessfulJobFinish()

logOnFailedJobFinish

protected void logOnFailedJobFinish()

setTrackerProgress

protected void setTrackerProgress(CronJobProgressTracker tracker,
                                  double progress)

getRuleMaintenanceService

protected RuleMaintenanceService getRuleMaintenanceService()

setRuleMaintenanceService

public void setRuleMaintenanceService(RuleMaintenanceService ruleMaintenanceService)

getRuleEngineJobExecutionSynchronizer

protected RuleEngineJobExecutionSynchronizer getRuleEngineJobExecutionSynchronizer()

setRuleEngineJobExecutionSynchronizer

public void setRuleEngineJobExecutionSynchronizer(RuleEngineJobExecutionSynchronizer ruleEngineJobExecutionSynchronizer)

getModelService

protected ModelService getModelService()