wt.queue
Interface QueueService

All Known Implementing Classes:

QueueServiceFwd, StandardQueueService

public interface QueueService

Interface containing the methods supported by the queue service implementations. Methods allow the creation, starting, stopping, deleting and customizing queue execution.

Supported API: true

Extendable: false

Method Summary

ProcessingQueue	createQueue(String queue_name) Creates a new queue given its name.
ProcessingQueue	createQueue(String queue_name, String host) Creates a new queue given its name.
ScheduleQueue	createScheduleQueue(String queue_name) Supported API: false
ScheduleQueue	createScheduleQueue(String queue_name, String host) Supported API: false
void	deleteEntries(ProcessingQueue queue) Deletes all entries of a specified tree.
void	deleteEntries(ProcessingQueue queue, String status_code) Deletes all entries that have the status code specified.
void	deleteEntries(ScheduleQueue queue) Supported API: false
void	deleteEntries(ScheduleQueue queue, String status_code) Supported API: false
void	deleteEntry(QueueInfo qi, QueueEntryInfo qei) Supported API: false
ProcessingQueue	deleteQueue(ProcessingQueue queue) Deletes the queue given its name.
ScheduleQueue	deleteQueue(ScheduleQueue queue) Supported API: false
void	enableQueue(ProcessingQueue queue, boolean desired) Supported API: false
void	enableQueue(ScheduleQueue queue, boolean desired) Supported API: false
void	executeEntry(QueueEntry entry) Execute the entry passed as argument.
long	getInterval(ProcessingQueue queue) Retrieves the waiting/sleeping interval of the queue passed as argument.
ProcessingQueue	getQueue(String queue_name) Supported API: false
WtQueue	getQueue(String queue_name, Class queue_type) Supported API: false
boolean	isActive(ProcessingQueue queue) Retuns 'true' if queue has been started (and not stoppped).
boolean	isActive(ScheduleQueue queue) Supported API: false
Enumeration	queueEntries(ProcessingQueue queue) Returns all queue entries as an enumeration.
Enumeration	queueEntries(ProcessingQueue queue, String status_code) Returns all existing queue entries that are in the state passed as argument.
Enumeration	queueEntries(ProcessingQueue queue, Vector status_codes) Supported API: false
Enumeration	queueEntries(ScheduleQueue queue) Supported API: false
Enumeration	queueEntries(ScheduleQueue queue, String status_code) Supported API: false
Enumeration	queues() Returns all existing queues (active or not).
Enumeration	queues(Class queue_type) Supported API: false
void	resetQueueEntry(ProcessingQueue queue, String entry_num) Supported API: false
void	resetQueueEntry(ScheduleQueue queue) Supported API: false
void	setExceptionRetries(WtQueue queue, String retries) Supported API: false
void	setFailureNotificationEmail(WtQueue queue, String email) Supported API: false
void	setInterval(ProcessingQueue queue, long interval) Establishes the wait/sleep interval for a specific queue.
void	setPollingInterval(WtQueue queue, String interval) Supported API: false
void	setQueueExecutionHost(ProcessingQueue queue, String host) Supported API: false
void	setQueueExecutionHost(ScheduleQueue queue, String host) Supported API: false
void	setSuspendDuration(WtQueue queue, String duration) Supported API: false
void	startAllQueues() Starts all existing queues.
void	startProcessing(ProcessingQueue queue) Starts immediate processing for a specified queue.
void	startProcessing(ScheduleQueue queue) Supported API: false
void	startQueue(ProcessingQueue queue) Starts a specific queue.
void	startQueue(ScheduleQueue queue) Supported API: true
void	startQueueProcessing(String queueName) Supported API: false
void	stopAllQueues() Stops all existing queues.
void	stopQueue(ProcessingQueue queue) Stops a specific queue.
void	stopQueue(ScheduleQueue queue) Supported API: true
void	updateQueueEntry(WtQueue queue, UpdateEntry entryInfo) Supported API: false

Method Detail

queues

public Enumeration queues()
                   throws WTException

Returns all existing queues (active or not).

Supported API: true

Returns:

Enumeration

Throws:

WTException

queues

public Enumeration queues(Class queue_type)
                   throws WTException

Supported API: false

Parameters:

queue_type -

Returns:

Enumeration

Throws:

WTException

getQueue

public ProcessingQueue getQueue(String queue_name)
                         throws WTException

Supported API: false

Parameters:

queue_name -

Returns:

ProcessingQueue

Throws:

WTException

getQueue

public WtQueue getQueue(String queue_name,
                        Class queue_type)
                 throws WTException

Supported API: false

Parameters:

queue_name -

queue_type -

Returns:

WtQueue

Throws:

WTException

startAllQueues

public void startAllQueues()
                    throws WTException

Starts all existing queues.

Supported API: true

Throws:

WTException

stopAllQueues

public void stopAllQueues()
                   throws WTException

Stops all existing queues.

Supported API: true

Throws:

WTException

enableQueue

public void enableQueue(ProcessingQueue queue,
                        boolean desired)
                 throws WTException

Supported API: false

Parameters:

queue -

desired -

Throws:

WTException

enableQueue

public void enableQueue(ScheduleQueue queue,
                        boolean desired)
                 throws WTException

Supported API: false

Parameters:

queue -

desired -

Throws:

WTException

createQueue

public ProcessingQueue createQueue(String queue_name)
                            throws WTException

Creates a new queue given its name.

Supported API: false

Parameters:

queue_name -

Returns:

ProcessingQueue

Throws:

WTException

createScheduleQueue

public ScheduleQueue createScheduleQueue(String queue_name)
                                  throws WTException

Supported API: false

Parameters:

queue_name -

Returns:

ScheduleQueue

Throws:

WTException

deleteQueue

public ProcessingQueue deleteQueue(ProcessingQueue queue)
                            throws WTException

Deletes the queue given its name.

Supported API: false

Parameters:

queue -

Returns:

ProcessingQueue

Throws:

WTException

deleteQueue

public ScheduleQueue deleteQueue(ScheduleQueue queue)
                          throws WTException

Supported API: false

Parameters:

queue -

Returns:

ScheduleQueue

Throws:

WTException

isActive

public boolean isActive(ProcessingQueue queue)
                 throws WTException

Retuns 'true' if queue has been started (and not stoppped).

Supported API: false

Parameters:

queue -

Returns:

boolean

Throws:

WTException

isActive

public boolean isActive(ScheduleQueue queue)
                 throws WTException

Supported API: false

Parameters:

queue -

Returns:

boolean

Throws:

WTException

getInterval

public long getInterval(ProcessingQueue queue)
                 throws WTException

Retrieves the waiting/sleeping interval of the queue passed as argument. The interval is given in seconds.

Supported API: false

Parameters:

queue -

Returns:

long

Throws:

WTException

startQueue

public void startQueue(ProcessingQueue queue)
                throws WTException

Starts a specific queue.

Supported API: true

Parameters:

queue -

Throws:

WTException

startQueue

public void startQueue(ScheduleQueue queue)
                throws WTException

Supported API: true

Parameters:

queue -

Throws:

WTException

stopQueue

public void stopQueue(ProcessingQueue queue)
               throws WTException

Stops a specific queue.

Supported API: true

Parameters:

queue -

Throws:

WTException

stopQueue

public void stopQueue(ScheduleQueue queue)
               throws WTException

Supported API: true

Parameters:

queue -

Throws:

WTException

setInterval

public void setInterval(ProcessingQueue queue,
                        long interval)
                 throws WTException

Establishes the wait/sleep interval for a specific queue. The interval is given in seconds and it overwrites the default interval set through wt.properties file.

Supported API: false

Parameters:

queue -

interval -

Throws:

WTException

deleteEntries

public void deleteEntries(ProcessingQueue queue)
                   throws WTException

Deletes all entries of a specified tree.

Supported API: false

Parameters:

queue -

Throws:

WTException

deleteEntries

public void deleteEntries(ScheduleQueue queue)
                   throws WTException

Supported API: false

Parameters:

queue -

Throws:

WTException

deleteEntries

public void deleteEntries(ProcessingQueue queue,
                          String status_code)
                   throws WTException

Deletes all entries that have the status code specified.

Supported API: false

Parameters:

queue -

status_code -

Throws:

WTException

deleteEntries

public void deleteEntries(ScheduleQueue queue,
                          String status_code)
                   throws WTException

Supported API: false

Parameters:

queue -

status_code -

Throws:

WTException

queueEntries

public Enumeration queueEntries(ProcessingQueue queue)
                         throws WTException

Returns all queue entries as an enumeration.

Supported API: false

Parameters:

queue -

Returns:

Enumeration

Throws:

WTException

queueEntries

public Enumeration queueEntries(ScheduleQueue queue)
                         throws WTException

Supported API: false

Parameters:

queue -

Returns:

Enumeration

Throws:

WTException

queueEntries

public Enumeration queueEntries(ProcessingQueue queue,
                                String status_code)
                         throws WTException

Returns all existing queue entries that are in the state passed as argument.

Supported API: false

Parameters:

queue -

status_code -

Returns:

Enumeration

Throws:

WTException

queueEntries

public Enumeration queueEntries(ProcessingQueue queue,
                                Vector status_codes)
                         throws WTException

Supported API: false

Parameters:

queue -

status_codes -

Returns:

Enumeration

Throws:

WTException

queueEntries

public Enumeration queueEntries(ScheduleQueue queue,
                                String status_code)
                         throws WTException

Supported API: false

Parameters:

queue -

status_code -

Returns:

Enumeration

Throws:

WTException

startProcessing

public void startProcessing(ProcessingQueue queue)
                     throws WTException

Starts immediate processing for a specified queue.

Supported API: false

Parameters:

queue -

Throws:

WTException

startProcessing

public void startProcessing(ScheduleQueue queue)
                     throws WTException

Supported API: false

Parameters:

queue -

Throws:

WTException

executeEntry

public void executeEntry(QueueEntry entry)
                  throws WTException

Execute the entry passed as argument.

Supported API: true

Parameters:

entry -

Throws:

WTException

setQueueExecutionHost

public void setQueueExecutionHost(ProcessingQueue queue,
                                  String host)
                           throws WTException

Supported API: false

Parameters:

queue -

host -

Throws:

WTException

setQueueExecutionHost

public void setQueueExecutionHost(ScheduleQueue queue,
                                  String host)
                           throws WTException

Supported API: false

Parameters:

queue -

host -

Throws:

WTException

createQueue

public ProcessingQueue createQueue(String queue_name,
                                   String host)
                            throws WTException

Creates a new queue given its name.

Supported API: false

Parameters:

queue_name -

host -

Returns:

ProcessingQueue

Throws:

WTException

createScheduleQueue

public ScheduleQueue createScheduleQueue(String queue_name,
                                         String host)
                                  throws WTException

Supported API: false

Parameters:

queue_name -

host -

Returns:

ScheduleQueue

Throws:

WTException

resetQueueEntry

public void resetQueueEntry(ProcessingQueue queue,
                            String entry_num)
                     throws WTException

Supported API: false

Parameters:

queue -

entry_num -

Throws:

WTException

resetQueueEntry

public void resetQueueEntry(ScheduleQueue queue)
                     throws WTException

Supported API: false

Parameters:

queue -

Throws:

WTException

deleteEntry

public void deleteEntry(QueueInfo qi,
                        QueueEntryInfo qei)
                 throws WTException

Supported API: false

Parameters:

qi -

qei -

Throws:

WTException

updateQueueEntry

public void updateQueueEntry(WtQueue queue,
                             UpdateEntry entryInfo)
                      throws WTException

Supported API: false

Parameters:

queue -

entryInfo -

Throws:

WTException

setPollingInterval

public void setPollingInterval(WtQueue queue,
                               String interval)
                        throws WTException

Supported API: false

Parameters:

queue -

interval -

Throws:

WTException

setSuspendDuration

public void setSuspendDuration(WtQueue queue,
                               String duration)
                        throws WTException

Supported API: false

Parameters:

queue -

duration -

Throws:

WTException

setExceptionRetries

public void setExceptionRetries(WtQueue queue,
                                String retries)
                         throws WTException

Supported API: false

Parameters:

queue -

retries -

Throws:

WTException

setFailureNotificationEmail

public void setFailureNotificationEmail(WtQueue queue,
                                        String email)
                                 throws WTException

Supported API: false

Parameters:

queue -

email -

Throws:

WTException

startQueueProcessing

public void startQueueProcessing(String queueName)
                          throws WTException

Supported API: false

Parameters:

queueName -

Throws:

WTException