wt.queue
Class QueueEntry

java.lang.Object
  wt.fc.WTObject
      wt.fc.Item
          wt.queue.WtQueueEntry
              wt.queue.QueueEntry

All Implemented Interfaces:

Externalizable, Serializable, AccessControlled, wt.access.PolicyAccessControlled, wt.access.SecurityLabeled, wt.admin.DomainAdministered, NetFactor, ObjectMappable, Persistable, DisplayIdentification, Lockable

public class QueueEntry
extends WtQueueEntry
implements Lockable, Externalizable

The QueueEntry represents an individual processing request. Each queue entry is associated to a named processing queue and can be in one of the following states: READY, SUSPENDED, EXECUTING, COMPLETED and FAILED.

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

wt.queue.StatusInfo	execute() Executes the entry's processing request.
String	getDisplayString() Supported API: true
WTPrincipal	getPrincipal() Returns the principal that owns the entry's execution.
ProcessingQueue	getQueue() Returns the queue to which the entry belongs.
protected void	initialize(ProcessingQueue queue) Supports initialization, following construction of an instance.
static QueueEntry	newQueueEntry(ProcessingQueue queue) Constructs a new entry representing a processing queue request.
void	setStatus(String status_code) Sets the status code of the entry to passed as argument.
String	toString() Returns a string representation of the entry.

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 Detail

newQueueEntry

public static QueueEntry newQueueEntry(ProcessingQueue queue)
                                throws WTException

Constructs a new entry representing a processing queue request.

Supported API: true

Parameters:

queue -

Returns:

QueueEntry

Throws:

WTException

initialize

protected void initialize(ProcessingQueue queue)
                   throws WTException

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

Supported API: true

Parameters:

queue -

Throws:

WTException

execute

public wt.queue.StatusInfo execute()
                            throws WTException

Executes the entry's processing request. Assumes the identity of the entry's principal for the execution.

Supported API: true

Overrides:

execute in class WtQueueEntry

Returns:

StatusInfo

Throws:

WTException

toString

public String toString()

Returns a string representation of the entry.

Supported API: true

Overrides:

toString in class WtQueueEntry

Returns:

String

getPrincipal

public WTPrincipal getPrincipal()
                         throws WTException

Returns the principal that owns the entry's execution. The access control for execution will be enforced relative to this principal.

Supported API: true

Overrides:

getPrincipal in class WtQueueEntry

Returns:

WTPrincipal

Throws:

WTException

setStatus

public void setStatus(String status_code)
               throws WTException

Sets the status code of the entry to passed as argument. The only statuses allowed are READY and SUSPENDED. The message is set to "Status set by operator." (it is defined in the resource bundle of the package.

Supported API: true

Overrides:

setStatus in class WtQueueEntry

Parameters:

status_code -

Throws:

WTException

getQueue

public ProcessingQueue getQueue()
                         throws WTException

Returns the queue to which the entry belongs.

Supported API: true

Returns:

ProcessingQueue

Throws:

WTException

getDisplayString

public String getDisplayString()

Supported API: true

Overrides:

getDisplayString in class WtQueueEntry

Returns:

String