Package wt.queue

Class ScheduleQueue

java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.fc._Item
wt.fc.Item
wt.queue._WtQueue
wt.queue.WtQueue
wt.queue._ScheduleQueue
wt.queue.ScheduleQueue
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
@GenAsPersistable(superClass=WtQueue.class, versions=-7711177415529140536L, properties=@GeneratedProperty(name="nextProcessTime",type=java.sql.Timestamp.class)) public class ScheduleQueue extends wt.queue._ScheduleQueue

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

    • newScheduleQueue

      public static ScheduleQueue newScheduleQueue(String name) throws WTException
      Constructs a queue given its name.

      Supported API: true
      Parameters:
      name -
      Returns:
      ScheduleQueue
      Throws:
      WTException

    • initialize

      protected void initialize(String name) throws WTException
      Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

      Supported API: true
      Parameters:
      name -
      Throws:
      WTException

    • addUniqueEntry

      @Deprecated public ScheduleQueueEntry addUniqueEntry(WTPrincipal princ, String t_method, String t_class, Class[] arg_types, Object[] args, Timestamp sched_time) throws WTException
      Deprecated.
      Add a Queue entry with the given method invalid input: '&' class signature if one does not exist. Note this method doesn't tell us anything about whether more than one entry exists with the specified method invalid input: '&' class signature

      Supported API: true
      Parameters:
      princ -
      t_method -
      t_class -
      arg_types -
      args -
      sched_time -
      Returns:
      Throws:
      WTException

    • addEntry

      public ScheduleQueueEntry addEntry(WTPrincipal princ, String t_method, String t_class, Class[] arg_types, Object[] args, Timestamp sched_time) throws WTException
      Creates a new QueueEntry object corresponding to a processing request.

      Supported API: true
      Parameters:
      princ -
      t_method -
      t_class -
      arg_types -
      args -
      sched_time -
      Returns:
      ScheduleQueueEntry
      Throws:
      WTException

    • contains

      public boolean contains(ScheduleQueueEntry entry) throws WTException
      Returns whether or not an entry belongs to the queue.

      Supported API: true
      Parameters:
      entry -
      Returns:
      boolean
      Throws:
      WTException

    • toString

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

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

    • newScheduleQueue

      public static ScheduleQueue newScheduleQueue(String name, String host) throws WTException
      Constructs a queue given its name.

      Supported API: true
      Parameters:
      name -
      host -
      Returns:
      ScheduleQueue
      Throws:
      WTException

    • addMultiEntry

      public void addMultiEntry(WTPrincipal princ, String t_method, String t_class, Class[] arg_types, Collection collection, Timestamp[] sched_time) throws WTException
      Create and commit multiple Queue entires from a Collection. All entries are batch commited. The arg_types is used to define the type of arguments and number of entries to be created from the Collection. The collection itself will contain one or more sets of these arguments. This method will iterate through the collection creating multiple queue entires each containing the number and type of arguments specified in arg_types. If the number of values in the collection is not evenly divisiable by the number of types (in arg_types) a WTException will be thrown. An array of Timestamp(s) is provides such that each entry may be scheduled at a different time

      Supported API: true
      Parameters:
      princ -
      t_method -
      t_class -
      arg_types -
      collection -
      sched_time -
      Throws:
      WTException