com.redhat.rhn.taskomatic.task.threaded

Interface QueueDriver

All Known Implementing Classes:

ChannelRepodataDriver, ErrataCacheDriver, ErrataQueueDriver

public interface QueueDriver

"Driver" for a work queue of worker threads

Method Summary

Modifier and Type	Method and Description
boolean	canContinue() Logic to tell the queue when to stop running Queues will always stop when there is no more work to do.
java.util.List	getCandidates() List of work items to "prime" the queue
org.apache.log4j.Logger	getLogger() The logger to use for all logging operations
int	getMaxWorkers() Maximum number of worker threads to run
void	initialize() Actions that has to be executed, when queue is created
QueueWorker	makeWorker(java.lang.Object workItem) Create a worker instance to work on a particular work item
void	setLogger(org.apache.log4j.Logger loggerIn) Set the logger to use for all logging operations

Method Detail

setLogger

void setLogger(org.apache.log4j.Logger loggerIn)

Set the logger to use for all logging operations

Parameters:

loggerIn - logger to be set

getLogger

org.apache.log4j.Logger getLogger()

The logger to use for all logging operations

Returns:

log4j Logger

getCandidates

java.util.List getCandidates()

List of work items to "prime" the queue

Returns:

list of work items

getMaxWorkers

int getMaxWorkers()

Maximum number of worker threads to run

Returns:

number of worker threads

makeWorker

QueueWorker makeWorker(java.lang.Object workItem)

Create a worker instance to work on a particular work item

Parameters:

workItem - object contained in the list returned from getCandidates()

Returns:

worker instance

canContinue

boolean canContinue()

Logic to tell the queue when to stop running Queues will always stop when there is no more work to do. This method can return false to cause the queue to stop early.

Returns:

true if processing can continue, otherwise false

initialize

void initialize()

Actions that has to be executed, when queue is created