Package de.hybris.platform.searchservices.indexer.service.impl

Class AbstractSnIndexerJob<T extends AbstractSnIndexerCronJobModel>

java.lang.Object

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

de.hybris.platform.searchservices.indexer.service.impl.AbstractSnIndexerJob<T>

All Implemented Interfaces:

JobPerformable<T>

Direct Known Subclasses:

FullSnIndexerJob, IncrementalSnIndexerJob

public abstract class AbstractSnIndexerJob<T extends AbstractSnIndexerCronJobModel>
extends AbstractJobPerformable<T>

Implementation of JobPerformable for running indexer operations.

Field Summary

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

flexibleSearchService, modelService, sessionService

Constructor Summary

Constructors

Constructor	Description
AbstractSnIndexerJob()

Method Summary

Modifier and Type	Method	Description
protected abstract SnIndexerRequest	createIndexerRequest(T cronJob, SnProgressTracker progressTracker)
protected java.util.Optional<java.util.Date>	getLastSuccessfulStartTime(T cronJob)	Retrieve the lastSuccessfulStartTime from the cronjob.
SnCronJobProgressTrackerFactory	getSnCronJobProgressTrackerFactory()
SnIndexerCronJobDao	getSnIndexerCronJobDao()
SnIndexerService	getSnIndexerService()
boolean	isAbortable()	Checks whether the execution is implemented abortable.
boolean	isPerformable()	Checks whether the execution can be performed at the moment.
PerformResult	perform(T cronJob)	The execution body for a ServicelayerJob.
protected void	saveLastSuccessfulStartTime(T cronJob)	Persist the start time of the cronjob as last successful start time.
void	setSnCronJobProgressTrackerFactory(SnCronJobProgressTrackerFactory snCronJobProgressTrackerFactory)
void	setSnIndexerCronJobDao(SnIndexerCronJobDao snIndexerCronJobDao)
void	setSnIndexerService(SnIndexerService snIndexerService)

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

clearAbortRequestedIfNeeded, setFlexibleSearchService, setModelService, setSessionService

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSnIndexerJob

public AbstractSnIndexerJob()

Method Detail

isAbortable

public boolean isAbortable()

Description copied from interface: JobPerformable

Checks whether the execution is implemented abortable.

Specified by:

isAbortable in interface JobPerformable<T extends AbstractSnIndexerCronJobModel>

Overrides:

isAbortable in class AbstractJobPerformable<T extends AbstractSnIndexerCronJobModel>

Returns:

true if the execution can be aborted

isPerformable

public boolean isPerformable()

Description copied from interface: JobPerformable

Checks whether the execution can be performed at the moment.

Specified by:

isPerformable in interface JobPerformable<T extends AbstractSnIndexerCronJobModel>

Overrides:

isPerformable in class AbstractJobPerformable<T extends AbstractSnIndexerCronJobModel>

Returns:

true if the execution is ready

perform

public PerformResult perform(T 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<T extends AbstractSnIndexerCronJobModel>

Specified by:

perform in class AbstractJobPerformable<T extends AbstractSnIndexerCronJobModel>

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.

createIndexerRequest

protected abstract SnIndexerRequest createIndexerRequest(T cronJob,
                                                         SnProgressTracker progressTracker)
                                                  throws SnIndexerException

Throws:

SnIndexerException

getLastSuccessfulStartTime

protected java.util.Optional<java.util.Date> getLastSuccessfulStartTime(T cronJob)

Retrieve the lastSuccessfulStartTime from the cronjob. If the cronjob didn't finish successfully before, retrieve the maximum of the lastSuccessfulStartTime from the full indexing cronjobs for the same SnIndexTypeModel. If both are not available, return an empty result.

Parameters:

cronJob - the cronjob

Returns:

the last successful start time, or empty

saveLastSuccessfulStartTime

protected void saveLastSuccessfulStartTime(T cronJob)

Persist the start time of the cronjob as last successful start time.

Parameters:

cronJob - the cronjob

getSnIndexerService

public SnIndexerService getSnIndexerService()

setSnIndexerService

public void setSnIndexerService(SnIndexerService snIndexerService)

getSnIndexerCronJobDao

public SnIndexerCronJobDao getSnIndexerCronJobDao()

setSnIndexerCronJobDao

public void setSnIndexerCronJobDao(SnIndexerCronJobDao snIndexerCronJobDao)

getSnCronJobProgressTrackerFactory

public SnCronJobProgressTrackerFactory getSnCronJobProgressTrackerFactory()

setSnCronJobProgressTrackerFactory

public void setSnCronJobProgressTrackerFactory(SnCronJobProgressTrackerFactory snCronJobProgressTrackerFactory)