com.spikeify.taskqueue.service

Class DefaultTaskQueueService

java.lang.Object

com.spikeify.taskqueue.service.DefaultTaskQueueService

All Implemented Interfaces:

TaskQueueService

public class DefaultTaskQueueService
extends Object
implements TaskQueueService

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_QUEUE_NAME default queue name if no queue name was given

Constructor Summary

Constructors

Constructor and Description
DefaultTaskQueueService(com.spikeify.Spikeify spikeify)

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) Returns next open and put's it into running state ...
TaskStatistics	purge(TaskState state, int taskAge, String queueName) Removes tasks from queue
protected boolean	remove(QueueTask task) Removes job from queue
QueueTask	transition(QueueTask task, TaskState newState) 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)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_QUEUE_NAME

public static final String DEFAULT_QUEUE_NAME

default queue name if no queue name was given

See Also:

Constant Field Values

Constructor Detail

DefaultTaskQueueService

public DefaultTaskQueueService(com.spikeify.Spikeify spikeify)

Method Detail

add

public QueueTask add(Job job,
                     String queueName)

Description copied from interface: TaskQueueService

Adds job to queue

Specified by:

add in interface TaskQueueService

Parameters:

job - to be executed

queueName - name of queue

Returns:

added job

next

public QueueTask next(String queueName)

Returns next open and put's it into running state ... might be that in the mean time some other thread will try lock this job ... so multiple calls to this method are possible

Specified by:

next in interface TaskQueueService

Parameters:

queueName - name of queue

Returns:

found job or null if none found

list

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

Description copied from interface: TaskQueueService

Lists all tasks from queue in given state

Specified by:

list in interface TaskQueueService

Parameters:

state - job is in

queueName - name of queue

Returns:

list of tasks in state from queue

transition

public QueueTask transition(QueueTask task,
                            TaskState newState)

Description copied from interface: TaskQueueService

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)

Specified by:

transition in interface TaskQueueService

Parameters:

task - to transition state

newState - to transition to

Returns:

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

remove

protected boolean remove(QueueTask task)

Removes job from queue

Parameters:

task - to be removed

Returns:

true if task was successfully deleted, false otherwise

purge

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

Description copied from interface: TaskQueueService

Removes tasks from queue

Specified by:

purge in interface TaskQueueService

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