Package de.hybris.platform.servicelayer.cronjob.impl

Class DefaultCronJobService

java.lang.Object

de.hybris.platform.servicelayer.internal.service.AbstractService

de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

de.hybris.platform.servicelayer.cronjob.impl.DefaultCronJobService

All Implemented Interfaces:

CronJobService, Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

public class DefaultCronJobService
extends AbstractBusinessService
implements CronJobService

Default implementation of the cronjob service.

Since:

4.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

AbstractService.SerializableDTO

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	DEFAULT_LOG_BUNCH	Default amount of JobLogModel entries.

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

modelService, sessionService, txManager

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

tenant

Constructor Summary

Constructors

Constructor	Description
DefaultCronJobService()

Method Summary

Modifier and Type	Method	Description
protected boolean	canRunOnThisNode(CronJobModel cronJob)
CronJobModel	getCronJob(String code)	Gets the cronjob identified unique by given code.
protected String	getCronJobExpression(CronJobModel cronJob)
<C extends CronJobModel, J extends JobModel> CronJobFactory<C,J>	getCronJobFactory(ServicelayerJobModel slayerJobModel)	Returns CronJobFactory bean instance for a ServicelayerJobModel see BeanFactory.getBean(String).
JobModel	getJob(String code)	Gets the job identified unique by given code.
protected Converter<List<JobLogModel>,String>	getJobLogConverter()
String	getLogsAsText(CronJobModel cronJobModel)	Returns text representation of top 500 CronJobModel.getLogs() entries for a given CronJobModel, as concatenated and decorated content of its JobLogModel.getMessage().
String	getLogsAsText(CronJobModel cronJobModel, int count)	Returns text representation of top given count CronJobModel.getLogs() entries for a given CronJobModel, as concatenated and decorated content of its JobLogModel.getMessage().
JobPerformable<? extends CronJobModel>	getPerformable(ServicelayerJobModel slayerJobModel)	Returns JobPerformable bean instance for a ServicelayerJobModel see BeanFactory.getBean(String).
List<CronJobModel>	getRunningOrRestartedCronJobs()	Returns list of CronJobModel instances running on the platform regardless the cluster node.
boolean	isAbortable(CronJobModel cronJob)	Checks if the cronjob model is abortable.
boolean	isError(CronJobModel cronJob)	Checks whether the cronjob was executed not successfully.
boolean	isFinished(CronJobModel cronJob)	Checks whether the cronjob has finished execution and is not running or paused anymore.
boolean	isPaused(CronJobModel cronJob)	Checks whether the cronjob is paused.
boolean	isPerformable(CronJobModel cronJob)	Checks if the cronjob model is performable.
boolean	isRunning(CronJobModel cronJob)	Checks whether the cronjob has not finished or paused execution yet and is still running regardless if has it been restarted or not.
boolean	isSuccessful(CronJobModel cronJob)	Checks whether the cronjob was executed successfully.
void	performCronJob(CronJobModel cronJob)	Performs given Cronjob by starting its Job on the cluster node.
void	performCronJob(CronJobModel cronJob, boolean synchronous)	Performs given Cronjob by starting its Job.
void	requestAbortCronJob(CronJobModel cronJob)	Sets the CronJobModel.REQUESTABORT to true for non running CronJobModel , abortable CronJobModel.
void	setClusterService(ClusterService clusterService)
void	setCronJobCodeGenerator(PersistentKeyGenerator cronJobCodeGenerator)
void	setCronJobDao(CronJobDao cronJobDao)
void	setJobDao(JobDao jobDao)
void	setJobLogConverter(Converter jobLogConverter)
void	setJobLogDao(JobLogDao jobLogDao)
void	setRunCronJobMessageBuilder(RunCronJobMessageCreatorAndSender runCronJobMessageBuilder)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.1.0
void	setTaskService(TaskService taskService)
void	setTenantService(TenantService tenantService)	Deprecated, for removal: This API element is subject to removal in a future version. since 6.1.0
protected void	startOnDifferentNodeViaTask(CronJobModel cronJob)

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

getModelService, getSessionService, getTxManager, setModelService, setSessionService, setTxManager

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

afterPropertiesSet, getCurrentTenant, setBeanName, setCurrentTenant, writeReplace

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_LOG_BUNCH

protected static final int DEFAULT_LOG_BUNCH

Default amount of JobLogModel entries.

See Also:

• Constant Field Values

Constructor Details

DefaultCronJobService

public DefaultCronJobService()

Method Details

performCronJob

public void performCronJob(CronJobModel cronJob,
 boolean synchronous)

Description copied from interface: CronJobService

Performs given Cronjob by starting its Job. 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. This method ignores a nodeId CronJobModel.getNodeID() and does not start a Job on the cluster node.

Specified by:

performCronJob in interface CronJobService

Parameters:

cronJob - which will be used

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

performCronJob

public void performCronJob(CronJobModel cronJob)

Description copied from interface: CronJobService

Performs given Cronjob by starting its Job on the cluster node. The node is given by JobModel.getNodeID(), the Job will be performed asynchronous, which means that this method will return the control to its caller as recently as this Job is performed. Call for a CronJobModel with nodeId CronJobModel.getNodeID() equal to current nodeId ClusterService.getClusterId() is the same as call CronJobService.performCronJob(CronJobModel, boolean) with synchronous equal false

Specified by:

performCronJob in interface CronJobService

Parameters:

cronJob - which will be used

canRunOnThisNode

protected boolean canRunOnThisNode(CronJobModel cronJob)

startOnDifferentNodeViaTask

protected void startOnDifferentNodeViaTask(CronJobModel cronJob)

getCronJobExpression

protected String getCronJobExpression(CronJobModel cronJob)

requestAbortCronJob

public void requestAbortCronJob(CronJobModel cronJob)

Sets the CronJobModel.REQUESTABORT to true for non running CronJobModel , abortable CronJobModel. Above action is performed if CronJobModel.getStatus() is in a CronJobStatus.RUNNING or CronJobStatus.RUNNINGRESTART.

Specified by:

requestAbortCronJob in interface CronJobService

Parameters:

cronJob - which will be used

Throws:

IllegalStateException - in case given CronJobModel is not an abortable.

getCronJob

public CronJobModel getCronJob(String code)

Description copied from interface: CronJobService

Gets the cronjob identified unique by given code.

Specified by:

getCronJob in interface CronJobService

Parameters:

code - code for which a cronjob is needed

Returns:

cronjob identified unique by given code

getJob

public JobModel getJob(String code)

Description copied from interface: CronJobService

Gets the job identified unique by given code.

Specified by:

getJob in interface CronJobService

Parameters:

code - code for which a job is needed

Returns:

job identified unique by given code

isFinished

public boolean isFinished(CronJobModel cronJob)

Description copied from interface: CronJobService

Checks whether the cronjob has finished execution and is not running or paused anymore.

Specified by:

isFinished in interface CronJobService

Parameters:

cronJob - cronjob to check for

Returns:

true if cronjob has finished execution

isPaused

public boolean isPaused(CronJobModel cronJob)

Description copied from interface: CronJobService

Checks whether the cronjob is paused.

Specified by:

isPaused in interface CronJobService

Parameters:

cronJob - cronjob to check for

Returns:

true if cronjob is paused

isRunning

public boolean isRunning(CronJobModel cronJob)

Description copied from interface: CronJobService

Checks whether the cronjob has not finished or paused execution yet and is still running regardless if has it been restarted or not.

Specified by:

isRunning in interface CronJobService

Parameters:

cronJob - cronjob to check for

Returns:

true if cronjob is still running

isSuccessful

public boolean isSuccessful(CronJobModel cronJob)

Description copied from interface: CronJobService

Checks whether the cronjob was executed successfully. Can only be used if cronjob has finished execution ( CronJobService.isFinished(CronJobModel) returns true).

Specified by:

isSuccessful in interface CronJobService

Parameters:

cronJob - cronjob to check for

Returns:

true if cronjob has finished successfully

isError

public boolean isError(CronJobModel cronJob)

Description copied from interface: CronJobService

Checks whether the cronjob was executed not successfully. Can only be used if cronjob has finished execution ( CronJobService.isFinished(CronJobModel) returns true).

Specified by:

isError in interface CronJobService

Parameters:

cronJob - cronjob to check for

Returns:

true if cronjob has finished not successfully

getRunningOrRestartedCronJobs

public List<CronJobModel> getRunningOrRestartedCronJobs()

Description copied from interface: CronJobService

Returns list of CronJobModel instances running on the platform regardless the cluster node.

Specified by:

getRunningOrRestartedCronJobs in interface CronJobService

isPerformable

public boolean isPerformable(CronJobModel cronJob)

Description copied from interface: CronJobService

Checks if the cronjob model is performable.

Specified by:

isPerformable in interface CronJobService

Parameters:

cronJob - which will be used

isAbortable

public boolean isAbortable(CronJobModel cronJob)

Description copied from interface: CronJobService

Checks if the cronjob model is abortable.

Specified by:

isAbortable in interface CronJobService

Parameters:

cronJob - which will be used

getPerformable

public JobPerformable<? extends CronJobModel> getPerformable(ServicelayerJobModel slayerJobModel)

Description copied from interface: CronJobService

Returns JobPerformable bean instance for a ServicelayerJobModel see BeanFactory.getBean(String).

Specified by:

getPerformable in interface CronJobService

getCronJobFactory

public <C extends CronJobModel,
J extends JobModel>
CronJobFactory<C,J> getCronJobFactory(ServicelayerJobModel slayerJobModel)

Description copied from interface: CronJobService

Returns CronJobFactory bean instance for a ServicelayerJobModel see BeanFactory.getBean(String).

Specified by:

getCronJobFactory in interface CronJobService

getLogsAsText

public String getLogsAsText(CronJobModel cronJobModel)

Description copied from interface: CronJobService

Returns text representation of top 500 CronJobModel.getLogs() entries for a given CronJobModel, as concatenated and decorated content of its JobLogModel.getMessage().

Specified by:

getLogsAsText in interface CronJobService

getLogsAsText

public String getLogsAsText(CronJobModel cronJobModel,
 int count)

Description copied from interface: CronJobService

Returns text representation of top given count CronJobModel.getLogs() entries for a given CronJobModel, as concatenated and decorated content of its JobLogModel.getMessage().

Specified by:

getLogsAsText in interface CronJobService

setRunCronJobMessageBuilder

@Deprecated(since="6.1.0",
            forRemoval=true)
public void setRunCronJobMessageBuilder(RunCronJobMessageCreatorAndSender runCronJobMessageBuilder)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.1.0

setTenantService

@Deprecated(since="6.1.0",
            forRemoval=true)
public void setTenantService(TenantService tenantService)

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.1.0

setClusterService

public void setClusterService(ClusterService clusterService)

setJobLogConverter

public void setJobLogConverter(Converter jobLogConverter)

getJobLogConverter

protected Converter<List<JobLogModel>,String> getJobLogConverter()

setCronJobDao

public void setCronJobDao(CronJobDao cronJobDao)

setJobDao

public void setJobDao(JobDao jobDao)

setJobLogDao

public void setJobLogDao(JobLogDao jobLogDao)

setCronJobCodeGenerator

public void setCronJobCodeGenerator(PersistentKeyGenerator cronJobCodeGenerator)

setTaskService

public void setTaskService(TaskService taskService)