Package wt.queue

Class QueueEntry

java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.fc._Item
wt.fc.Item
wt.queue._WtQueueEntry
wt.queue.WtQueueEntry
wt.queue._QueueEntry
wt.queue.QueueEntry
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, wt.locks._Lockable, Lockable
@GenAsPersistable(superClass=WtQueueEntry.class, interfaces=Lockable.class, versions=1130870142956337703L, properties=@GeneratedProperty(name="args",type=java.io.Serializable.class,accessors=@PropertyAccessors(getAccess=PRIVATE),columnProperties=@ColumnProperties(columnType=INLINE_BLOB,oracleTableSize=HUGE)), tableProperties=@TableProperties(compositeIndex1="queueRef.key.id+statusInfo.code+entryNumber",oracleTableSize=LARGE)) public class QueueEntry extends wt.queue._QueueEntry
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:

  • Method Details

    • 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

    • 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