de.hybris.platform.task.impl

Class DefaultTaskService

java.lang.Object

de.hybris.platform.task.impl.DefaultTaskService

All Implemented Interfaces:

TaskService

Direct Known Subclasses:

DefaultTaskServiceNodeGroupsIntegrationTest.TestTaskService

public class DefaultTaskService
extends java.lang.Object
implements TaskService

Default implementation of the TaskService interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultTaskService.PoolingQueueSizeGauge

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_POLLING_INTERVAL
static int	DEFAULT_SHUTDOWN_WAIT
static int	DEFAULT_WORKER_MAX
static java.lang.String	PROCESSING_HITS_METRIC
static java.lang.String	PROCESSING_MISSES_METRIC
static java.lang.String	PROCESSING_TIME_METRIC
static java.lang.String	QUEUE_SIZE_METRIC

Fields inherited from interface de.hybris.platform.task.TaskService

BEAN_ID

Constructor Summary

Constructors

Constructor and Description
DefaultTaskService()

Method Summary

Modifier and Type	Method and Description
protected boolean	checkSystemOK()
protected void	checkTask(TaskModel toBeScheduled)
protected void	checkTaskConditions(TaskModel toBeScheduled, TaskConditionModel cond)
void	destroy() Shut down this component
TaskEngine	getEngine()
protected TaskExecutionStrategy	getExecutionStrategy(TaskRunner<? extends TaskModel> runner)
protected TaskRunner	getRunner(java.lang.String runnerBean)
protected TaskRunner	getRunner(Task task)
protected TaskDAO	getTaskDao()
protected TaskEngineParameters	getTaskProviderParameters()
protected Tenant	getTenant()
void	init() Starts up this component
protected boolean	isAllowedToStart()
protected boolean	isAllowedToStart(int clusterId)
protected boolean	isEnabledInConfig() Read configuration setting for task engine from the configuration.
boolean	isRunning()
protected void	markTaskFailed(Task task)
protected void	poll()
protected void	process(TasksProvider.VersionPK versionPK)
protected void	processCondition(TaskCondition cond)
protected void	processInTenant(TasksProvider.VersionPK versionPK)
protected void	processTask(Task task, TasksProvider.VersionPK versionPK)
protected java.util.Set<java.lang.Integer>	readExcludedNodesFromConfig()
protected int	readMaxWorkersFromConfig()
protected int	readPollingIntervalFromConfig()
protected int	readShutdownWaitFromConfig()
protected int	readWorkersIdleFromConfig()
protected <T> void	refreshCurrentSessionWithRetry(java.util.function.Supplier<java.lang.Void> failingMethodSupplier)
void	repoll(java.lang.Integer nodeId, java.lang.String nodeGroupId)
protected void	scheduleRetry(Task task, java.util.Date nextExecution, int turn)
protected boolean	scheduleRetryIfAllowed(Task task, RetryLaterException e)
void	scheduleTask(TaskModel task) Schedule a task.
void	setEventService(EventService eventService)
void	setMetricRegistry(MetricRegistry metricRegistry)
void	setModelService(ModelService modelService)
void	setScheduleAndTriggerStrategy(ScheduleAndTriggerStrategy scheduleAndTriggerStrategy)
void	setTaskDao(TaskDAO dao)
void	setTaskEngineRetryTemplate(RetryTemplate taskEngineRetryTemplate)
void	setTaskExecutionStrategies(java.util.Collection<? extends TaskExecutionStrategy> taskExecutionStrategies)
void	setTasksProvider(TasksProvider tasksProvider)
void	triggerEvent(java.lang.String uniqueId) Trigger an event on task module.
void	triggerEvent(java.lang.String uniqueId, java.util.Date expirationDate) Trigger an event on task module.
boolean	triggerEvent(TaskEvent event) Trigger event on task module.
void	triggerRepoll(java.lang.Integer nodeId, java.lang.String nodeGroupId) Triggers re-poll at the specified cluster node.
protected void	triggerRepollAfterSchedule(java.util.Date scheduledDate, java.lang.Integer nodeId, java.lang.String nodeGroupId)
protected void	waitAndRunExclusiveAction(java.lang.String info, java.lang.Runnable action)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WORKER_MAX

public static final int DEFAULT_WORKER_MAX

See Also:

Constant Field Values

DEFAULT_POLLING_INTERVAL

public static final int DEFAULT_POLLING_INTERVAL

See Also:

Constant Field Values

DEFAULT_SHUTDOWN_WAIT

public static final int DEFAULT_SHUTDOWN_WAIT

See Also:

Constant Field Values

QUEUE_SIZE_METRIC

public static final java.lang.String QUEUE_SIZE_METRIC

PROCESSING_TIME_METRIC

public static final java.lang.String PROCESSING_TIME_METRIC

PROCESSING_HITS_METRIC

public static final java.lang.String PROCESSING_HITS_METRIC

PROCESSING_MISSES_METRIC

public static final java.lang.String PROCESSING_MISSES_METRIC

Constructor Detail

DefaultTaskService

public DefaultTaskService()

Method Detail

setModelService

public void setModelService(ModelService modelService)

setEventService

public void setEventService(EventService eventService)

setScheduleAndTriggerStrategy

public void setScheduleAndTriggerStrategy(ScheduleAndTriggerStrategy scheduleAndTriggerStrategy)

setMetricRegistry

public void setMetricRegistry(MetricRegistry metricRegistry)

setTasksProvider

public void setTasksProvider(TasksProvider tasksProvider)

setTaskEngineRetryTemplate

public void setTaskEngineRetryTemplate(RetryTemplate taskEngineRetryTemplate)

getEngine

public TaskEngine getEngine()

Specified by:

getEngine in interface TaskService

Returns:

the task engine.

isRunning

public boolean isRunning()

triggerRepoll

public void triggerRepoll(java.lang.Integer nodeId,
                          java.lang.String nodeGroupId)

Triggers re-poll at the specified cluster node.

Parameters:

nodeId - the cluster node id

triggerEvent

public void triggerEvent(java.lang.String uniqueId)

Description copied from interface: TaskService

Trigger an event on task module.

Specified by:

triggerEvent in interface TaskService

Parameters:

uniqueId - unique id of event

triggerEvent

public void triggerEvent(java.lang.String uniqueId,
                         java.util.Date expirationDate)

Description copied from interface: TaskService

Trigger an event on task module.

Specified by:

triggerEvent in interface TaskService

Parameters:

uniqueId - unique id of event

expirationDate - expiration date - when reached the task condition created after event send and before

triggerEvent

public boolean triggerEvent(TaskEvent event)

Description copied from interface: TaskService

Trigger event on task module.

Specified by:

triggerEvent in interface TaskService

Parameters:

event - event to be triggered

Returns:

true if operation succeeded or false if event has been already triggered

scheduleTask

public void scheduleTask(TaskModel task)

Description copied from interface: TaskService

Schedule a task.

Specified by:

scheduleTask in interface TaskService

Parameters:

task - task to schedule.

triggerRepollAfterSchedule

protected void triggerRepollAfterSchedule(java.util.Date scheduledDate,
                                          java.lang.Integer nodeId,
                                          java.lang.String nodeGroupId)

checkTask

protected void checkTask(TaskModel toBeScheduled)

checkTaskConditions

protected void checkTaskConditions(TaskModel toBeScheduled,
                                   TaskConditionModel cond)

repoll

public void repoll(java.lang.Integer nodeId,
                   java.lang.String nodeGroupId)

isAllowedToStart

protected boolean isAllowedToStart()

isAllowedToStart

protected boolean isAllowedToStart(int clusterId)

isEnabledInConfig

protected boolean isEnabledInConfig()

Read configuration setting for task engine from the configuration. This method considers both TaskConstants.Params.TASK_PROCESSING_ENABLED and TaskConstants.Params.TASK_PROCESSING_ENABLED_LEGACY. The following applies:

• If only the old parameter is set, it is used.
• If only the new parameter is set, it is used.
• If both the old and new parameters are set, the new parameter is used and a warning is written to the log.

checkSystemOK

protected boolean checkSystemOK()

refreshCurrentSessionWithRetry

protected <T> void refreshCurrentSessionWithRetry(java.util.function.Supplier<java.lang.Void> failingMethodSupplier)

init

public void init()

Starts up this component

getTaskDao

protected TaskDAO getTaskDao()

setTaskDao

public void setTaskDao(TaskDAO dao)

readPollingIntervalFromConfig

protected int readPollingIntervalFromConfig()

readMaxWorkersFromConfig

protected int readMaxWorkersFromConfig()

readWorkersIdleFromConfig

protected int readWorkersIdleFromConfig()

readExcludedNodesFromConfig

protected java.util.Set<java.lang.Integer> readExcludedNodesFromConfig()

readShutdownWaitFromConfig

protected int readShutdownWaitFromConfig()

destroy

public void destroy()

Shut down this component

waitAndRunExclusiveAction

protected void waitAndRunExclusiveAction(java.lang.String info,
                                         java.lang.Runnable action)

poll

protected void poll()

getTaskProviderParameters

protected TaskEngineParameters getTaskProviderParameters()

processInTenant

protected void processInTenant(TasksProvider.VersionPK versionPK)

process

protected void process(TasksProvider.VersionPK versionPK)

processCondition

protected void processCondition(TaskCondition cond)

processTask

protected void processTask(Task task,
                           TasksProvider.VersionPK versionPK)

scheduleRetryIfAllowed

protected boolean scheduleRetryIfAllowed(Task task,
                                         RetryLaterException e)

scheduleRetry

protected void scheduleRetry(Task task,
                             java.util.Date nextExecution,
                             int turn)

markTaskFailed

protected void markTaskFailed(Task task)

getRunner

protected TaskRunner getRunner(Task task)

getRunner

protected TaskRunner getRunner(java.lang.String runnerBean)
                        throws java.lang.IllegalStateException

Throws:

java.lang.IllegalStateException

getTenant

protected Tenant getTenant()

getExecutionStrategy

protected TaskExecutionStrategy getExecutionStrategy(TaskRunner<? extends TaskModel> runner)

setTaskExecutionStrategies

public void setTaskExecutionStrategies(java.util.Collection<? extends TaskExecutionStrategy> taskExecutionStrategies)