com.spikeify.taskqueue.service

Interface TaskQueueService

All Known Implementing Classes:

DefaultTaskQueueService

public interface TaskQueueService

Adds and retrieves tasks from queue

Method Summary

Modifier and Type	Method and Description
QueueTask	add(Job job, String queueName) Adds job to queue
List<QueueTask>	list(TaskState state, String queueName) Lists all tasks from queue in given state
QueueTask	next(String queueName) Gets next job to be executed (put in running state)
TaskStatistics	purge(TaskState state, int taskAge, String queueName) Removes tasks from queue
QueueTask	transition(QueueTask task, TaskState state) Transitions job from current state to new state This is done in transaction so only one thread can change the state (this is then the worker thread for this job)

Method Detail

add

QueueTask add(Job job,
              String queueName)

Adds job to queue

Parameters:

job - to be executed

queueName - name of queue

Returns:

added job

next

QueueTask next(String queueName)

Gets next job to be executed (put in running state)

Parameters:

queueName - name of queue

Returns:

job to be executed or null if no job found

list

List<QueueTask> list(TaskState state,
                     String queueName)

Lists all tasks from queue in given state

Parameters:

state - job is in

queueName - name of queue

Returns:

list of tasks in state from queue

transition

QueueTask transition(QueueTask task,
                     TaskState state)

Transitions job from current state to new state This is done in transaction so only one thread can change the state (this is then the worker thread for this job)

Parameters:

task - to transition state

state - to transition to

Returns:

updated task if transition successed, false if job could not be transitioned

purge

TaskStatistics purge(TaskState state,
                     int taskAge,
                     String queueName)

Removes tasks from queue

Parameters:

state - of tasks to be removed

taskAge - age in minutes to allow action, 0 == now or never

queueName - name of queue

Returns:

task statistics of removed tasks