Package wt.queue

Class ProcessingQueue

java.lang.Object

wt.fc._WTObject

wt.fc.WTObject

wt.fc._Item

wt.fc.Item

wt.queue._WtQueue

wt.queue.WtQueue

wt.queue._ProcessingQueue

wt.queue.ProcessingQueue

All Implemented Interfaces:

Externalizable, Serializable, wt.access._AccessControlled, wt.access._PolicyAccessControlled, wt.access._SecurityLabeled, AccessControlled, wt.access.PolicyAccessControlled, SecurityLabeled, wt.admin._DomainAdministered, DomainAdministered, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, wt.fc.adminlock._AdministrativelyLockable, AdministrativelyLockable, NetFactor, ObjectMappable, Persistable, DisplayIdentification

@GenAsPersistable(superClass=WtQueue.class,
                  versions=-1079448543413087890L,
                  properties=@GeneratedProperty(name="interval",type=long.class,accessors=@PropertyAccessors(setExceptions={})))
public class ProcessingQueue
extends wt.queue._ProcessingQueue

The ProcessingQueue represents a specific (named) processing queue. Queues can be started and stopped independently (through the queue service). The ProcessingQueue class also supports the creation and execution of queue entries. this method is no longer supported

Use the newProcessingQueue static factory method(s), not the ProcessingQueue 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

Method Summary

Modifier and Type	Method	Description
QueueEntry	addEntry(WTPrincipal princ, String t_method, String t_class, Class[] arg_types, Object[] args)	Creates a new QueueEntry object corresponding to a processing request.
void	addMultiEntry(WTPrincipal princ, String t_method, String t_class, Class[] arg_types, Collection collection)	Create and commit multiple Queue entires from a Collection.
boolean	contains(QueueEntry entry)	Returns whether or not an entry belongs to the queue.
protected void	initialize(String name)	Supports initialization, following construction of an instance.
protected void	initialize(String name, String host)	Supports initialization, following construction of an instance.
static ProcessingQueue	newProcessingQueue(String name)	Constructs a queue given its name.
static ProcessingQueue	newProcessingQueue(String name, String host)	Constructs a queue given its name.
String	toString()	Returns a string representaion of the queue.

Methods inherited from class wt.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

newProcessingQueue

public static ProcessingQueue newProcessingQueue(String name)
                                          throws WTException

Constructs a queue given its name.

Supported API: true

Parameters:

name -

Returns:

ProcessingQueue

Throws:

WTException

initialize

protected void initialize(String name)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

name -

Throws:

WTException

addEntry

public QueueEntry addEntry(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

Parameters:

princ -

t_method -

t_class -

arg_types -

args -

Returns:

QueueEntry

Throws:

WTException

contains

public boolean contains(QueueEntry entry)
                 throws WTException

Returns whether or not an entry belongs to the queue.

Supported API: true

Parameters:

entry -

Returns:

boolean

Throws:

WTException

toString

public String toString()

Returns a string representaion of the queue.

Supported API: true

Overrides:

toString in class WtQueue

Returns:

String

newProcessingQueue

public static ProcessingQueue newProcessingQueue(String name,
 String host)
                                          throws WTException

Constructs a queue given its name.

Supported API: true

Parameters:

name -

host -

Returns:

ProcessingQueue

Throws:

WTException

initialize

protected void initialize(String name,
 String host)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

name -

host -

Throws:

WTException

addMultiEntry

public void addMultiEntry(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

Parameters:

princ -

t_method -

t_class -

arg_types -

collection -

Throws:

WTException