com.spikeify.taskqueue.service

Class DefaultTaskQueueManager

java.lang.Object

com.spikeify.taskqueue.service.DefaultTaskQueueManager

All Implemented Interfaces:

TaskQueueManager

public class DefaultTaskQueueManager
extends Object
implements TaskQueueManager

Should be used as a singleton ... one instance per JVM

Field Summary

Fields

Modifier and Type	Field and Description
static Logger	log

Constructor Summary

Constructors

Constructor and Description
DefaultTaskQueueManager(com.spikeify.Spikeify spikeify, TaskQueueService queueService)

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 queueName, 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)
protected void	stopRunningThreads(String queueName, QueueSettings settings)
void	unregister(String queueName) Removes queue from monitoring

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final Logger log

Constructor Detail

DefaultTaskQueueManager

public DefaultTaskQueueManager(com.spikeify.Spikeify spikeify,
                               TaskQueueService queueService)

Method Detail

register

public QueueInfo register(String queueName,
                          boolean autoStart)

Description copied from interface: TaskQueueManager

Registers queue to be monitored

Specified by:

register in interface TaskQueueManager

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

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

Specified by:

register in interface TaskQueueManager

info

public QueueInfo info(String queueName)

Description copied from interface: TaskQueueManager

Returns single queue info with statistics

Specified by:

info in interface TaskQueueManager

Parameters:

queueName - name of queue

Returns:

queue info

resetStatistics

public void resetStatistics(String queueName,
                            boolean force)

Description copied from interface: TaskQueueManager

Will reset all statistics data and counts

Specified by:

resetStatistics in interface TaskQueueManager

Parameters:

queueName - name of queue

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

list

public List<QueueInfo> list(Boolean active)

Description copied from interface: TaskQueueManager

Lists queues registered

Specified by:

list in interface TaskQueueManager

Parameters:

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

Returns:

list of registered queues

unregister

public void unregister(String queueName)

Description copied from interface: TaskQueueManager

Removes queue from monitoring

Specified by:

unregister in interface TaskQueueManager

Parameters:

queueName - to be removed

start

public void start(String... queueNames)
           throws InterruptedException

Description copied from interface: TaskQueueManager

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)

Specified by:

start in interface TaskQueueManager

Parameters:

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

Throws:

InterruptedException - when interrupted

getExecutor

public TaskExecutorService getExecutor(String queueName)

Description copied from interface: TaskQueueManager

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

Specified by:

getExecutor in interface TaskQueueManager

Parameters:

queueName - name of queue

Returns:

executor service

stop

public void stop(String... queueNames)
          throws InterruptedException

Description copied from interface: TaskQueueManager

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

Specified by:

stop in interface TaskQueueManager

Parameters:

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

Throws:

InterruptedException - when interrupted

isRunning

public boolean isRunning(String queueName)

Specified by:

isRunning in interface TaskQueueManager

Parameters:

queueName - name of queue

Returns:

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

enable

public QueueInfo enable(String queueName)

Description copied from interface: TaskQueueManager

Enables queue

Specified by:

enable in interface TaskQueueManager

Parameters:

queueName - - enables queue to be run

Returns:

enabled queue info

disable

public QueueInfo disable(String queueName)

Description copied from interface: TaskQueueManager

Disables queue - stops queue if running

Specified by:

disable in interface TaskQueueManager

Parameters:

queueName - - disables queue from running

Returns:

disabled queue info

check

public void check(String... queueNames)
           throws InterruptedException

Description copied from interface: TaskQueueManager

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

Specified by:

check in interface TaskQueueManager

Parameters:

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

Throws:

InterruptedException - when interrupted

set

public void set(String queueName,
                QueueSettings settings)

Description copied from interface: TaskQueueManager

Sets queue settings

Specified by:

set in interface TaskQueueManager

Parameters:

queueName - queue name

settings - to be stored

stopRunningThreads

protected void stopRunningThreads(String queueName,
                                  QueueSettings settings)
                           throws InterruptedException

Throws:

InterruptedException