Package wt.queue

Class StandardQueueService

java.lang.Object

wt.services.StandardManager

wt.queue.StandardQueueService

All Implemented Interfaces:

Serializable, wt.fc._NetFactor, NetFactor, QueueService, wt.services.Manager

public class StandardQueueService
extends StandardManager
implements QueueService, Serializable

Standard implementation of the QueueService interface.

Use the newStandardQueueService static factory method(s), not the StandardQueueService constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: false

See Also:

• Serialized Form

Field Summary

Fields inherited from interface wt.services.Manager

MANAGER_SERVICE, STARTUP_AUTOMATIC, STARTUP_MANUAL, STATUS_EMERGENCY_SHUTDOWN, STATUS_EMERGENCY_SHUTTING_DOWN, STATUS_SHUTDOWN, STATUS_SHUTDOWN_ERRORS, STATUS_SHUTDOWN_FAILURE, STATUS_SHUTTING_DOWN, STATUS_STARTED, STATUS_STARTED_ERRORS, STATUS_STARTING_UP, STATUS_STARTUP_FAILURE

Method Summary

Modifier and Type	Method	Description
QueueEntry	addEntry(ProcessingQueue queue, WTPrincipal princ, String t_method, String t_class, Class[] arg_types, Object[] args)	Creates a new QueueEntry object corresponding to a processing request.
ScheduleQueueEntry	addEntry(ScheduleQueue queue, WTPrincipal princ, String t_method, String t_class, Class[] arg_types, Object[] args, Timestamp sched_time)	Creates a new QueueEntry object corresponding to a processing request.
ScheduleQueueEntry	addEntry(ScheduleQueue queue, WTPrincipal princ, String t_method, String t_class, Class[] arg_types, Object[] args, Timestamp sched_time, StatusInfo statusInfo)	Add a schedule entry specifying its status info Supported API: true
void	addMultiEntry(ProcessingQueue queue, WTPrincipal princ, String t_method, String t_class, Class[] arg_types, Collection collection)	Create and commit multiple Queue entires from a Collection.
void	addMultiEntry(ScheduleQueue queue, WTPrincipal princ, String t_method, String t_class, Class[] arg_types, Collection collection, Timestamp[] sched_time)	Create and commit multiple Queue entires from a Collection.
ScheduleQueueEntry	addUniqueEntry(ScheduleQueue queue, WTPrincipal princ, String t_method, String t_class, Class[] arg_types, Object[] args, Timestamp sched_time)	Deprecated.
boolean	contains(ProcessingQueue queue, QueueEntry entry)	Returns whether or not an entry belongs to the queue.
boolean	contains(ScheduleQueue queue, ScheduleQueueEntry entry)	Returns whether or not an entry belongs to the queue.
void	deleteEntries(List<? extends Persistable> entries)	Deletes a List of persistable queue entries QUEUE_ENTRY_DELETE is emmited.
void	deleteEntries(ProcessingQueue queue)	Deletes all entries for the given queue Supported API: true
void	deleteEntries(ProcessingQueue queue, String status_code)	Deletes all entries that have the status code specified.
void	deleteEntries(ScheduleQueue queue)	Deletes all entries for the given queue QUEUE_ENTRY_DELETE event is emmited Supported API: true
void	deleteEntries(ScheduleQueue queue, String status_code)	Deletes all entries that have the status code specified.
void	deleteEntry(WtQueue queue, WtQueueEntry queueEntry)	Delete a queue entry Supported API: true
void	execEntries(ProcessingQueue queue)	Execute all queue entries in the 'READY' state, in the increasing order of their 'entryNumbers'.
void	execEntries(ScheduleQueue queue)	Execute all queue entries in the 'READY' state, in the increasing order of their 'entryNumbers'.
WtQueueEntry	execEntry(ProcessingQueue queue, WtQueueEntry entry)	Executes a the queue entry passed as argument.
WtQueueEntry	execEntry(ScheduleQueue queue, WtQueueEntry entry)	Executes a the queue entry passed as argument.
ProcessingQueue	getQueue(String queue_name)	Return a queue with the given name Supported API: true
WtQueue	getQueue(String queue_name, Class queue_type)	Return a queue with the given name and type Supported API: true
boolean	hasItems(ProcessingQueue queue, String[] statuses)	The method checks if there exist at least one queue entry with one of the specified statuses.
Enumeration	queueEntries(ProcessingQueue queue)	Returns all queue entries as an enumeration for the given queue Supported API: true
Enumeration	queueEntries(ProcessingQueue queue, String status_code)	Returns all queue entries that with the given state for the specified queue Supported API: true
Enumeration	queueEntries(ProcessingQueue queue, Vector status_codes)	Returns all queue entries that with the given state for the specified queue Supported API: true
Enumeration	queueEntries(ScheduleQueue queue)	Returns all queue entries as an enumeration for the given queue Supported API: true
Enumeration	queueEntries(ScheduleQueue queue, String status_code)	Returns all queue entries that with the given state for the specified queue Supported API: true
void	resetQueueEntry(ProcessingQueue queue, String entry_num)	Resets the specified queue entry to the ready state Supported API: true
void	resetQueueEntry(ScheduleQueue queue, String entry_num)	Resets the specified queue entry to the ready state Supported API: true
WtQueueEntry	updateQueueEntry(WtQueue queue, wt.queue.UpdateEntry entryInfo)	Update a queue entries status (only) Supported API: true
WtQueueEntry	updateQueueEntry(WtQueue queue, WtQueueEntry newEntryState)	Update a queue entry Supports updating the status and scheduled execution time (for schedule queues) Supported API: true

Methods inherited from class wt.services.StandardManager

emergencyShutdown, emergencyShutdownComplete, emergencyShuttingDown, getClassInfo, getManagerService, getManagerStatus, getName, getStartupType, init, initialize, initialize, isStarted, newStandardManager, newStandardManager, performEmergencyShutdownProcess, registerEvents, setManagerService, shutdown, shutdownFailure, shutdownSuccess, shuttingDown, started, startedErrors, startingUp, startup, startupFailure, toString

Methods inherited from class java.lang.Object

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

Method Details

getQueue

public ProcessingQueue getQueue(String queue_name)
                         throws WTException

Return a queue with the given name

Supported API: true

Specified by:

getQueue in interface QueueService

Parameters:

queue_name -

Returns:

ProcessingQueue

Throws:

WTException

getQueue

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

Return a queue with the given name and type

Supported API: true

Specified by:

getQueue in interface QueueService

Parameters:

queue_name -

queue_type -

Returns:

WtQueue

Throws:

WTException

deleteEntries

public void deleteEntries(ProcessingQueue queue)
                   throws WTException

Deletes all entries for the given queue

Supported API: true

Specified by:

deleteEntries in interface QueueService

Parameters:

queue -

Throws:

WTException

deleteEntries

public void deleteEntries(ScheduleQueue queue)
                   throws WTException

Deletes all entries for the given queue QUEUE_ENTRY_DELETE event is emmited

Supported API: true

Specified by:

deleteEntries in interface QueueService

Parameters:

queue -

Throws:

WTException

deleteEntries

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

Deletes all entries that have the status code specified. for the given queue

Supported API: true

Specified by:

deleteEntries in interface QueueService

Parameters:

queue -

status_code -

Throws:

WTException

deleteEntries

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

Deletes all entries that have the status code specified. for the given queue QUEUE_ENTRY_DELETE event is emitted. ImmutableQueueException is thrown if attempt made to delete entry from Immutable queue.

Supported API: true

Specified by:

deleteEntries in interface QueueService

Parameters:

queue -

status_code -

Throws:

WTException

queueEntries

public Enumeration queueEntries(ProcessingQueue queue)
                         throws WTException

Returns all queue entries as an enumeration for the given queue

Supported API: true

Specified by:

queueEntries in interface QueueService

Parameters:

queue -

Returns:

Enumeration

Throws:

WTException

queueEntries

public Enumeration queueEntries(ScheduleQueue queue)
                         throws WTException

Returns all queue entries as an enumeration for the given queue

Supported API: true

Specified by:

queueEntries in interface QueueService

Parameters:

queue -

Returns:

Enumeration

Throws:

WTException

queueEntries

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

Returns all queue entries that with the given state for the specified queue

Supported API: true

Specified by:

queueEntries in interface QueueService

Parameters:

queue -

status_code -

Returns:

Enumeration

Throws:

WTException

queueEntries

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

Returns all queue entries that with the given state for the specified queue

Supported API: true

Specified by:

queueEntries in interface QueueService

Parameters:

queue -

status_codes -

Returns:

Enumeration

Throws:

WTException

queueEntries

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

Returns all queue entries that with the given state for the specified queue

Supported API: true

Specified by:

queueEntries in interface QueueService

Parameters:

queue -

status_code -

Returns:

Enumeration

Throws:

WTException

resetQueueEntry

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

Resets the specified queue entry to the ready state

Supported API: true

Specified by:

resetQueueEntry in interface QueueService

Parameters:

queue -

entry_num -

Throws:

WTException

resetQueueEntry

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

Resets the specified queue entry to the ready state

Supported API: true

Specified by:

resetQueueEntry in interface QueueService

Parameters:

queue -

entry_num -

Throws:

WTException

deleteEntry

public void deleteEntry(WtQueue queue,
 WtQueueEntry queueEntry)
                 throws WTException

Delete a queue entry

Supported API: true

Specified by:

deleteEntry in interface QueueService

Parameters:

queue -

queueEntry -

Throws:

WTException

updateQueueEntry

public WtQueueEntry updateQueueEntry(WtQueue queue,
 wt.queue.UpdateEntry entryInfo)
                              throws WTException

Update a queue entries status (only)

Supported API: true

Specified by:

updateQueueEntry in interface QueueService

Parameters:

queue -

entryInfo -

Returns:

WtQueueEntry

Throws:

WTException

updateQueueEntry

public WtQueueEntry updateQueueEntry(WtQueue queue,
 WtQueueEntry newEntryState)
                              throws WTException

Update a queue entry Supports updating the status and scheduled execution time (for schedule queues)

Supported API: true

Specified by:

updateQueueEntry in interface QueueService

Parameters:

queue -

entryInfo -

Returns:

WtQueueEntry

Throws:

WTException

addEntry

public QueueEntry addEntry(ProcessingQueue queue,
 WTPrincipal princ,
 String t_method,
 String t_class,
 Class[] arg_types,
 Object[] args)
                    throws WTException

Creates a new QueueEntry object corresponding to a processing request.

Supported API: true

Specified by:

addEntry in interface QueueService

Parameters:

queue -

princ -

t_method -

t_class -

arg_types -

args -

Returns:

QueueEntry

Throws:

WTException

execEntry

public WtQueueEntry execEntry(ProcessingQueue queue,
 WtQueueEntry entry)
                       throws WTException

Executes a the queue entry passed as argument.

Supported API: true

Specified by:

execEntry in interface QueueService

Parameters:

entry -

Returns:

WtQueueEntry

Throws:

WTException

execEntry

public WtQueueEntry execEntry(ScheduleQueue queue,
 WtQueueEntry entry)
                       throws WTException

Executes a the queue entry passed as argument.

Supported API: true

Specified by:

execEntry in interface QueueService

Parameters:

entry -

Returns:

WtQueueEntry

Throws:

WTException

addMultiEntry

public void addMultiEntry(ProcessingQueue queue,
 WTPrincipal princ,
 String t_method,
 String t_class,
 Class[] arg_types,
 Collection collection)
                   throws WTException

Create and commit multiple Queue entires from a Collection. All entries are batch commited. The arg_types is used to define the type of arguments and number of entries to be created from the Collection. The collection itself will contain one or more sets of these arguments. This method will iterate through the collection creating multiple queue entires each containing the number and type of arguments specified in arg_types. If the number of values in the collection is not evenly divisiable by the number of types (in arg_types) a WTException will be thrown.

Supported API: true

Specified by:

addMultiEntry in interface QueueService

Parameters:

queue -

princ -

t_method -

t_class -

arg_types -

collection -

Throws:

WTException

addUniqueEntry

@Deprecated
public ScheduleQueueEntry addUniqueEntry(ScheduleQueue queue,
 WTPrincipal princ,
 String t_method,
 String t_class,
 Class[] arg_types,
 Object[] args,
 Timestamp sched_time)
                                  throws WTException

Deprecated.

Add a Queue entry with the given method invalid input: '&' class signature if one does not exist. Note this method doesn't tell us anything about whether more than one entry exists with the specified method invalid input: '&' class signature

Supported API: true

Specified by:

addUniqueEntry in interface QueueService

Parameters:

queue -

princ -

t_method -

t_class -

arg_types -

args -

sched_time -

Returns:

Throws:

WTException

addEntry

public ScheduleQueueEntry addEntry(ScheduleQueue queue,
 WTPrincipal princ,
 String t_method,
 String t_class,
 Class[] arg_types,
 Object[] args,
 Timestamp sched_time)
                            throws WTException

Creates a new QueueEntry object corresponding to a processing request.

Supported API: true

Specified by:

addEntry in interface QueueService

Parameters:

queue -

princ -

t_method -

t_class -

arg_types -

args -

sched_time -

Returns:

ScheduleQueueEntry

Throws:

WTException

addEntry

public ScheduleQueueEntry addEntry(ScheduleQueue queue,
 WTPrincipal princ,
 String t_method,
 String t_class,
 Class[] arg_types,
 Object[] args,
 Timestamp sched_time,
 StatusInfo statusInfo)
                            throws WTException

Add a schedule entry specifying its status info

Supported API: true

Specified by:

addEntry in interface QueueService

Parameters:

princ -

t_method -

t_class -

arg_types -

args -

sched_time -

statusInfo -

Returns:

Throws:

WTException

addMultiEntry

public void addMultiEntry(ScheduleQueue queue,
 WTPrincipal princ,
 String t_method,
 String t_class,
 Class[] arg_types,
 Collection collection,
 Timestamp[] sched_time)
                   throws WTException

Create and commit multiple Queue entires from a Collection. All entries are batch commited. The arg_types is used to define the type of arguments and number of entries to be created from the Collection. The collection itself will contain one or more sets of these arguments. This method will iterate through the collection creating multiple queue entires each containing the number and type of arguments specified in arg_types. If the number of values in the collection is not evenly divisiable by the number of types (in arg_types) a WTException will be thrown. An array of Timestamp(s) is provides such that each entry may be scheduled at a different time

Supported API: true

Specified by:

addMultiEntry in interface QueueService

Parameters:

queue -

princ -

t_method -

t_class -

arg_types -

collection -

sched_time -

Throws:

WTException

execEntries

public void execEntries(ProcessingQueue queue)
                 throws WTException

Execute all queue entries in the 'READY' state, in the increasing order of their 'entryNumbers'.

Supported API: true

Specified by:

execEntries in interface QueueService

Throws:

WTException

execEntries

public void execEntries(ScheduleQueue queue)
                 throws WTException

Execute all queue entries in the 'READY' state, in the increasing order of their 'entryNumbers'.

Supported API: true

Specified by:

execEntries in interface QueueService

Throws:

WTException

hasItems

public boolean hasItems(ProcessingQueue queue,
 String[] statuses)
                 throws WTException

The method checks if there exist at least one queue entry with one of the specified statuses.

Supported API: true

Specified by:

hasItems in interface QueueService

Parameters:

statuses - List of statuses to consider. Constants from StatusInfo class.

Returns:

boolean

Throws:

WTException

contains

public boolean contains(ScheduleQueue queue,
 ScheduleQueueEntry entry)
                 throws WTException

Returns whether or not an entry belongs to the queue.

Supported API: true

Parameters:

entry -

Returns:

boolean

Throws:

WTException

contains

public boolean contains(ProcessingQueue queue,
 QueueEntry entry)
                 throws WTException

Returns whether or not an entry belongs to the queue.

Supported API: true

Parameters:

entry -

Returns:

boolean

Throws:

WTException

deleteEntries

public void deleteEntries(List<? extends Persistable> entries)
                   throws WTException

Deletes a List of persistable queue entries QUEUE_ENTRY_DELETE is emmited. ImmutableQueueException will occur if attempt made to delete entries from Immutable queue.

Supported API: true

Specified by:

deleteEntries in interface QueueService

Parameters:

queue -

Throws:

WTException