Package wt.queue

Overview

See:
Description

Interface Summary

NotifierMBean	Simple marker interface for a Notifer MBean This notifier provides general admin notification capabilities for queue entry execution failures.
QueueLoggerMBean	General queue logger bean Supported API: true Extendable: true
QueueService	Interface containing the methods supported by the queue service implementations.
QueueWatcherMBean	This class is the Management interface for the QueueWatcher class.
StandardQueueMonitorMBean	Standard queue monitor bean.

Class Summary

ProcessingQueue	The ProcessingQueue represents a specific (named) processing queue.
QueueEntry	The QueueEntry represents an individual processing request.
QueueHelper	Helper function that provides access to the QueueService API.
QueueManager	This is the general utility for managing queues.
ScheduleQueue	Use the newScheduleQueue static factory method(s), not the ScheduleQueue constructor, to construct instances of this class.
ScheduleQueueEntry	Use the newScheduleQueueEntry static factory method(s), not the ScheduleQueueEntry constructor, to construct instances of this class.
StandardQueueService	Standard implementation of the QueueService interface.
WtQueue	Supported API: true Extendable: false
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.