Package wt.queue

Class WtQueueEntry

java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.fc._Item
wt.fc.Item
wt.queue._WtQueueEntry
wt.queue.WtQueueEntry
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
Direct Known Subclasses:
wt.queue._QueueEntry, wt.queue._ScheduleQueueEntry
@GenAsPersistable(superClass=Item.class,versions=-6719972175812851039L,properties={@GeneratedProperty(name="queueRef",type=ObjectReference.class,javaDoc="Reference to the processing queue to which the entry belongs.",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="targetMethod",type=java.lang.String.class,javaDoc="Name of the method to be executed.",accessors=@PropertyAccessors(setExceptions={}),constraints=@PropertyConstraints(upperLimit=60)),@GeneratedProperty(name="targetClass",type=java.lang.String.class,javaDoc="Fully qualified name of the class whose\'s method is to be executed.",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="startExec",type=java.sql.Timestamp.class,javaDoc="Time that execution started.",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="endExec",type=java.sql.Timestamp.class,javaDoc="Time execution finished (COMPLETED or FAILED).",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="entryOwner",type=WTPrincipalReference.class,accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="statusInfo",type=StatusInfo.class,accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="entryNumber",type=java.lang.Long.class,accessors=@PropertyAccessors(setExceptions={}),constraints=@PropertyConstraints(required=true),columnProperties=@ColumnProperties(index=true,columnType=SEQUENCE)),@GeneratedProperty(name="failureCount",type=java.lang.Long.class,accessors=@PropertyAccessors(setExceptions={}))}) public abstract class WtQueueEntry extends wt.queue._WtQueueEntry


Supported API: true

Extendable: false
See Also:

  • Field Summary

    Fields inherited from class wt.queue._WtQueueEntry

    END_EXEC, ENTRY_NUMBER, ENTRY_OWNER, EXTERNALIZATION_VERSION_UID, 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.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
    static boolean
    doExit()
    Returns a boolean indicating whether or not the current entry, if executing, should return.
    StatusInfo
    execute()
    Executes the entry's processing request.
    String
    getDisplayString()


    Supported API: true
    WTPrincipal
    getPrincipal()
    Returns the principal that owns the entry's execution.
    static boolean
    isStopDeletePending()
    Returns a boolean indicating whether there is a pending stop request that is associated with a delete entries request This method should be by used queue entries to check and see if there is an outstanding stop/delete/entries request pending.
    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._WtQueueEntry

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

    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

  • Method Details

    • execute

      public StatusInfo execute() throws WTException
      Executes the entry's processing request. Assumes the identity of the entry's principal for the execution.

      Note that subclasses should call super.execute() prior to executing their own logic.

      Supported API: true

      Returns:
      StatusInfo
      Throws:
      WTException

    • toString

      public String toString()
      Returns a string representation of the entry.

      Supported API: true
      Overrides:
      toString in class WTObject
      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
      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
      Parameters:
      status_code -
      Throws:
      WTException

    • getDisplayString

      public String getDisplayString()


      Supported API: true
      Returns:
      String

    • doExit

      public static boolean doExit()
      Returns a boolean indicating whether or not the current entry, if executing, should return. This method should be by used queue entries to check and see if there is an outstanding stop request pending. This will allow the entry to abort execution before the thread is interrupted

      Supported API: true
      Returns:
      boolean

    • isStopDeletePending

      public static boolean isStopDeletePending()
      Returns a boolean indicating whether there is a pending stop request that is associated with a delete entries request This method should be by used queue entries to check and see if there is an outstanding stop/delete/entries request pending. This will allow the entry to abort execution before the thread is interrupted

      Supported API: true
      Returns:
      boolean