com.spikeify.taskqueue.service

Interface QueueService

All Known Implementing Classes:

QueueServiceImpl

public interface QueueService

Method Summary

Modifier and Type	Method and Description
QueueTask	addJob(Job newJob, String queueName) Adds new job to queue
void	check() Queue check (should be called on regular basis on each machine, JVM running the QueueService) makes sure queues are started, stopped on each machine
QueueInfo	info(String queueName) Latest queue info with statistics
List<QueueTask>	listJobs(TaskState state, String queueName) Lists jobs in certain state
QueueInfo	resetStatistics(String queueName) Resets queue statistics
void	restart(String queueName) Restars queue if running
void	settings(QueueSettings settings, String... queues) Changes queue settings and restarts running queue
void	start(String... queues) Starts given queues or all if none given
void	stop(String... queues) Stops given queues or all if none given

Method Detail

addJob

QueueTask addJob(Job newJob,
                 String queueName)

Adds new job to queue

Parameters:

newJob - to be added

queueName - name of queue

Returns:

task job has been assigned

listJobs

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

Lists jobs in certain state

Parameters:

state - job is in

queueName - name of queue

Returns:

found list of jobs or empty list if none found

settings

void settings(QueueSettings settings,
              String... queues)

Changes queue settings and restarts running queue

Parameters:

settings - to be used

queues - list of queues or empty for all

info

QueueInfo info(String queueName)

Latest queue info with statistics

Parameters:

queueName - name of queue

Returns:

info

resetStatistics

QueueInfo resetStatistics(String queueName)

Resets queue statistics

Parameters:

queueName - name of queue

Returns:

info

start

void start(String... queues)

Starts given queues or all if none given

Parameters:

queues - to be started

restart

void restart(String queueName)

Restars queue if running

Parameters:

queueName - name of queue

stop

void stop(String... queues)

Stops given queues or all if none given

Parameters:

queues - to be stopped

check

void check()

Queue check (should be called on regular basis on each machine, JVM running the QueueService) makes sure queues are started, stopped on each machine