Package wt.queue

Class WtQueue

java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.fc._Item
wt.fc.Item
wt.queue._WtQueue
wt.queue.WtQueue
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._ProcessingQueue, wt.queue._ScheduleQueue
@GenAsPersistable(superClass=Item.class,versions={6098226469578592873L,-3467512890522574741L},properties={@GeneratedProperty(name="name",type=java.lang.String.class,accessors=@PropertyAccessors(setAccess=PACKAGE,setExceptions={}),constraints=@PropertyConstraints(upperLimit=30,required=true),columnProperties=@ColumnProperties(unique=true)),@GeneratedProperty(name="executionHost",type=java.lang.String.class,accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="enabled",type=boolean.class,initialValue="true",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="removeFailedEntires",type=boolean.class,initialValue="false",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="exceptionRetries",type=java.lang.Long.class,accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="deleteWhenEmpty",type=boolean.class,initialValue="false",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="queueState",type=java.lang.String.class,supportedAPI=PRIVATE,accessors=@PropertyAccessors(setAccess=PACKAGE,setExceptions={})),@GeneratedProperty(name="lastStateSet",type=java.lang.String.class,accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="suspendUntil",type=java.lang.Long.class,accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="suspendDuration",type=java.lang.Long.class,accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="totalEntries",type=java.lang.Integer.class,accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="totalNotificationThreshold",type=java.lang.Integer.class,javaDoc="JMX notification threshold for total entries enqueued",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="waitingEntries",type=java.lang.Integer.class,accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="waitingNotificationThreshold",type=java.lang.Integer.class,javaDoc="JMX notification threshold for waiting ready entries enqueued",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="maxEntryExecutionTimeThreshold",type=java.lang.Long.class,javaDoc="Max duruation an entry can execute before triggering a JMX notification. Time is in seconds",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="randomAccessQueue",type=boolean.class,initialValue="false",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="stopWaitEntryCompletion",type=boolean.class,initialValue="false",supportedAPI=PRIVATE,javaDoc="Indicates this queue will wait as long as necessary for an executing entry to complete before stopping",accessors=@PropertyAccessors(getAccess=PACKAGE,setAccess=PACKAGE,setExceptions={})),@GeneratedProperty(name="stopDeleteRequest",type=boolean.class,initialValue="false",supportedAPI=PRIVATE,javaDoc="Indicates that the current stop request is part of a delete operation.This attribute is made available to the executing entry so that it can abort it\'s execution if appropriate",accessors=@PropertyAccessors(getAccess=PACKAGE,setAccess=PACKAGE,setExceptions={})),@GeneratedProperty(name="stopInterruptWaitEntryCompletion",type=boolean.class,initialValue="false",supportedAPI=PRIVATE,javaDoc="If this field is set it indicates that as part of a stop request -on a stopWaitEntryCompletion configured queue- an attempt to interrupt the thread will be part of the stop requests. This is future work, not currently implemented",accessors=@PropertyAccessors(getAccess=PACKAGE,setAccess=PACKAGE,setExceptions={}))},foreignKeys=@GeneratedForeignKey(name="QueueQueueLock",foreignKeyRole=@ForeignKeyRole(name="queueLock",type=wt.queue.QueueLock.class,cascade=true),myRole=@MyRole(name="queue",cardinality=ONE))) public abstract class WtQueue extends wt.queue._WtQueue


Supported API: true

Extendable: false
See Also:

  • Field Summary

    Fields inherited from class wt.queue._WtQueue

    DELETE_WHEN_EMPTY, ENABLED, EXCEPTION_RETRIES, EXECUTION_HOST, EXTERNALIZATION_VERSION_UID, LAST_STATE_SET, MAX_ENTRY_EXECUTION_TIME_THRESHOLD, NAME, QUEUE_LOCK, QUEUE_LOCK_REFERENCE, QUEUE_STATE, RANDOM_ACCESS_QUEUE, REMOVE_FAILED_ENTIRES, STOP_DELETE_REQUEST, STOP_INTERRUPT_WAIT_ENTRY_COMPLETION, STOP_WAIT_ENTRY_COMPLETION, SUSPEND_DURATION, SUSPEND_UNTIL, TOTAL_ENTRIES, TOTAL_NOTIFICATION_THRESHOLD, WAITING_ENTRIES, WAITING_NOTIFICATION_THRESHOLD

    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
    String
    toString()
    Returns a string representation of the queue.

    Methods inherited from class wt.queue._WtQueue

    getClassInfo, getConceptualClassname, getExecutionHost, getLastStateSet, getMaxEntryExecutionTimeThreshold, getName, getQueueLock, getQueueLockReference, getTotalEntries, getTotalNotificationThreshold, getType, getWaitingEntries, getWaitingNotificationThreshold, isDeleteWhenEmpty, isRandomAccessQueue, isRemoveFailedEntires, readExternal, readExternal, readVersion, setDeleteWhenEmpty, setEnabled, setExceptionRetries, setExecutionHost, setLastStateSet, setMaxEntryExecutionTimeThreshold, setQueueLock, setQueueLockReference, setRandomAccessQueue, setRemoveFailedEntires, setSuspendDuration, setSuspendUntil, setTotalEntries, setTotalNotificationThreshold, setWaitingEntries, setWaitingNotificationThreshold, super_readExternal_WtQueue, super_readVersion_WtQueue, super_writeExternal_WtQueue, 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

    • toString

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

      Supported API: true
      Overrides:
      toString in class WTObject
      Returns:
      String