com.spikeify.taskqueue.service

Interface TaskQueueManager

All Known Implementing Classes:

DefaultTaskQueueManager

public interface TaskQueueManager

Method Summary

Modifier and Type	Method and Description
void	check(String... queueNames) Should be called on regular basis from each machine running queues takes care that if one instance has started/stopped a queue it is also started/stopped on other machines
QueueInfo	disable(String queueName) Disables queue - stops queue if running
QueueInfo	enable(String queueName) Enables queue
TaskExecutorService	getExecutor(String queueName) Returns instance of task executor service to be used when executing jobs
QueueInfo	info(String queueName) Returns single queue info with statistics
boolean	isRunning(String queueName)
List<QueueInfo>	list(Boolean active) Lists queues registered
QueueInfo	register(String queueName, boolean autoStart) Registers queue to be monitored
QueueInfo	register(String queueName, QueueSettings settings, boolean autoStart)
void	resetStatistics(String queueName, boolean force) Will reset all statistics data and counts
void	set(String queue, QueueSettings settings) Sets queue settings
void	start(String... queueNames) Starts queues ...
void	stop(String... queueNames) Stops queues - stops all running tasks/threads (on given JVM)
void	unregister(String queueName) Removes queue from monitoring

Method Detail

register

QueueInfo register(String queueName,
                   boolean autoStart)

Registers queue to be monitored

Parameters:

queueName - name of queue

autoStart - true will put queue into started mode (once check is called queue will be started), false queue must be put into started mode manually

Returns:

registered queue info

register

QueueInfo register(String queueName,
                   QueueSettings settings,
                   boolean autoStart)

info

QueueInfo info(String queueName)

Returns single queue info with statistics

Parameters:

queueName - name of queue

Returns:

queue info

resetStatistics

void resetStatistics(String queueName,
                     boolean force)

Will reset all statistics data and counts

Parameters:

queueName - name of queue

force - true will reset also running task counters (running, queued ... etc) might result in negative counters!

list

List<QueueInfo> list(Boolean active)

Lists queues registered

Parameters:

active - - true list active queues, false - list disabled queues, null - list all

Returns:

list of registered queues

unregister

void unregister(String queueName)

Removes queue from monitoring

Parameters:

queueName - to be removed

start

void start(String... queueNames)
    throws InterruptedException

Starts queues ... (on given JVM) should be called only once per thread, if called multiple times then threads are terminated and restated (acts as restart)

Parameters:

queueNames - names to be started or empty to start all enabled queues

Throws:

InterruptedException - when interrupted

getExecutor

TaskExecutorService getExecutor(String queueName)

Returns instance of task executor service to be used when executing jobs

Parameters:

queueName - name of queue

Returns:

executor service

stop

void stop(String... queueNames)
   throws InterruptedException

Stops queues - stops all running tasks/threads (on given JVM)

Parameters:

queueNames - to be stopped or empty to stop all enabled queues

Throws:

InterruptedException - when interrupted

isRunning

boolean isRunning(String queueName)

Parameters:

queueName - name of queue

Returns:

true if queue is started and active (running), false if not

enable

QueueInfo enable(String queueName)

Enables queue

Parameters:

queueName - - enables queue to be run

Returns:

enabled queue info

disable

QueueInfo disable(String queueName)

Disables queue - stops queue if running

Parameters:

queueName - - disables queue from running

Returns:

disabled queue info

check

void check(String... queueNames)
    throws InterruptedException

Should be called on regular basis from each machine running queues takes care that if one instance has started/stopped a queue it is also started/stopped on other machines

Best invoked from a cron job or similar

Parameters:

queueNames - list of queues to check / null or empty to check them all

Throws:

InterruptedException - when interrupted

set

void set(String queue,
         QueueSettings settings)

Sets queue settings

Parameters:

queue - queue name

settings - to be stored