Package wt.queue

Overview

See:
Description

Interface Summary

QueueJspCons
QueueMonitor
QueueService	Interface containing the methods supported by the queue service implementations.

Class Summary

entries	Use the newentries static factory method(s), not the entries constructor, to construct instances of this class.
MethodArgument	This class represents a single argument of the processing request.
PollingQueueThread	This class implements the logic to run a polling or FIFO style queue
principal	Use the newprincipal static factory method(s), not the principal constructor, to construct instances of this class.
ProcessingQueue	The ProcessingQueue represents a specific (named) processing queue.
ProcessQueueDriver	Test driver class to manipulate processingQueues
QueueCache
QueueController
QueueController.QueueInfo
QueueController.Runner
QueueEntry	The QueueEntry represents an individual processing request.
QueueEntryComparator
QueueEntryInfo
QueueEntryListener
QueueEntryMigrator
QueueHelper	Helper function that provides access to the QueueService API.
QueueInfo
QueueManager	This is the general utility for managing queues.
QueueManagerBean
QueueMessage
QueueMonitorHelper	This class provides support methods to the QueueMonitor some of which are also used by the StandardQueueService
QueueMonitorHelper.QueueModificationListener	Top level inner class which signals queue modifications - creates and deletes
QueueMonitorHelper.QueueStateListener	Top level inner class which signals queue modifications - queue state changes
QueuePage
QueueServiceEvent
QueueServiceFwd	Interface containing the methods supported by the queue service implementations.
QueueWatcher	This class holds the threads and state associated with running a particular queue
sch_entries	Use the newsch_entries static factory method(s), not the sch_entries constructor, to construct instances of this class.
sch_principal	Use the newsch_principal static factory method(s), not the sch_principal constructor, to construct instances of this class.
ScheduleQueue	Use the newScheduleQueue static factory method(s), not the ScheduleQueue constructor, to construct instances of this class.
ScheduleQueueDriver
ScheduleQueueEntry	Use the newScheduleQueueEntry static factory method(s), not the ScheduleQueueEntry constructor, to construct instances of this class.
ScheduleQueueThread
StandardQueueMonitor
StandardQueueService	Standard implementation of the QueueService interface.
StatusInfo	Represents the status of the queue entry.
UpdateEntry
WtQueue	Supported API: true Extendable: false
WtQueue.QueueCacheUpdater	Top level inner class which updates the queue cache
WtQueueEntry	Supported API: true Extendable: false

Exception Summary

QueueException

This class represents exceptions that can be thrown in the process of storing, retrieving and executing queue entries.

Package wt.queue Description

Overview

The Queue service (package wt.queue) is responsible for creating, executing
monitoring and managment of queues. The Queue service runs on a (background)
MethodServer in a multi-MethodServer configuration. The R7 release of Windchill
support the concept of multiple (background) MethodServers where by queues are
assigned to a specific (background) server via groupings.

There are currently two supported queue types: Process queues & Schedule
queues. Process queues process entries FIFO style. Schedule queue entries are
executed at the entries scheduled execution time. Schedule queue entries can also
reschedule themselves for later execution.

The Queues themselves are named and can be in one of the given states:
starting, started, stopping, stopped, deleting or suspended. The last of
these states (suspended) is worth additional explaination. A queue in a
suspended state indicates that it is having difficulty with execution of one
of its entries. Queue suspension is configurable in terms of the number of
times it will attempt to execute the problem entry and the duration of
suspension which will occur between retries.

Queue entries take the general form of a class, the (public static) method to be
executed and a set of arguments to be used for the method execution.
Schedule queue entries have the additional requirement of an execution time.
Queue entries also have an associated state: read, failed, reschedule, executing,
severe, completed. Generally completed entries are removed from the queue.
Entries in a failed or severe state need maintenance.

External Interface

The external interface of the Queue service can be accessed through the
QueueHelper.manager object. The important apis on this interface support
starting and stopping queues and adding queue entries to a given queue.
Additional apis support configuration of a queues behavior and the management
of queue entries.

Multi-Object support

The Queue service supports a multi-obejct add entry allowing batch submission
of multiple queue entries simultainously.