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:

  • Field Summary

    Fields inherited from class wt.queue._QueueEntry

    ARGS, EXTERNALIZATION_VERSION_UID

    Fields inherited from class wt.queue._WtQueueEntry

    END_EXEC, ENTRY_NUMBER, ENTRY_OWNER, FAILURE_COUNT, QUEUE_REF, START_EXEC, STATUS_INFO, TARGET_CLASS, TARGET_METHOD

    Fields inherited from class wt.fc.Item

    SIMPLE_X10_UID, VERSION_40_UID, VERSION_51_UID

    Fields inherited from class wt.fc._WTObject

    CREATE_TIMESTAMP, MODIFY_TIMESTAMP

    Fields inherited from interface wt.fc.adminlock._AdministrativelyLockable

    ADMINISTRATIVE_LOCK

    Fields inherited from interface wt.admin._DomainAdministered

    DOMAIN_REF, INHERITED_DOMAIN

    Fields inherited from interface wt.locks._Lockable

    LOCK, LOCK_DATE, LOCK_NOTE, LOCKED, LOCKER, LOCKER_EMAIL, LOCKER_FULL_NAME, LOCKER_NAME

    Fields inherited from interface wt.fc._Persistable

    PERSIST_INFO

    Fields inherited from interface wt.access._SecurityLabeled

    SECURITY_LABELS

    Fields inherited from interface wt.identity.DisplayIdentification

    DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

    Fields inherited from interface wt.fc.Persistable

    IDENTITY, TYPE

    Fields inherited from interface wt.access.SecurityLabeled

    SECURITY_LABELS_INTERNAL_VALUE

  • Method Summary

    Modifier and Type
    Method
    Description
    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.queue._QueueEntry

    getClassInfo, getConceptualClassname, getLock, getLockDate, getLocker, getLockerEMail, getLockerFullName, getLockerName, getLockNote, getType, isLocked, readExternal, readExternal, readVersion, setLock, super_readExternal_QueueEntry, super_readVersion_QueueEntry, super_writeExternal_QueueEntry, writeExternal, writeExternal

    Methods inherited from class wt.queue.WtQueueEntry

    convertFromByteArray, convertFromVector, doDIcheck, doExit, isStopDeletePending

    Methods inherited from class wt.queue._WtQueueEntry

    getEndExec, getEntryNumber, getEntryOwner, getFailureCount, getQueueRef, getStartExec, getStatusInfo, getTargetClass, getTargetMethod, readVersion, setEndExec, setEntryNumber, setEntryOwner, setFailureCount, setQueueRef, setStartExec, setStatusInfo, setTargetClass, setTargetMethod, super_readExternal_WtQueueEntry, super_readVersion_WtQueueEntry, super_writeExternal_WtQueueEntry

    Methods inherited from class wt.fc.Item

    initialize

    Methods inherited from class wt.fc._Item

    getAdministrativeLock, getDomainRef, getSecurityLabels, isInheritedDomain, readVersion, setAdministrativeLock, setDomainRef, setInheritedDomain, setSecurityLabels, super_readExternal_Item, super_readVersion_Item, super_writeExternal_Item

    Methods inherited from class wt.fc.WTObject

    checkAttributes, duplicate, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity

    Methods inherited from class wt.fc._WTObject

    equals, getCreateTimestamp, getModifyTimestamp, getPersistInfo, hashCode, readVersion, setPersistInfo

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface wt.fc._Persistable

    getPersistInfo, setPersistInfo

    Methods inherited from interface wt.fc.Persistable

    checkAttributes, getIdentity

  • 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