Java Doc for CompletionWatcherWorker.java in  » Science » Cougaar12_4 » org » cougaar » glm » servlet » Java Source Code / Java DocumentationJava Source Code and Java Documentation

 One created for every URL access.
 Uses a blackboard
 service, a watcher, and a trigger to monitor published tasks to see
 when they are complete.
 Note : may not return if it can't go through all it's states.
 

 Called when either 
 1) the task subscription changes
 2) the plan element subscription changes
 3) a timer expires
 Does book-keeping to keep track of incomplete tasks.

 Handles all HTTP and HTTPS service requests.

 Called when either 
 1) the task subscription changes
 2) the plan element subscription changes
 3) a timer expires
 Does book-keeping to keep track of incomplete tasks. 
 (If a plan element has completed, it's task is removed from the
 set of incomplete tasks.)
 Given whether all tasks are complete, if any arrived in the last transaction,
 or if a timer expired, calls advance state.
 

 States are :
 BEFORE_FIRST - some tasks are incomplete
 Transition : when all are complete, start first timer, go to next state
 DURING_FIRST - all tasks are complete
 Transition : waited first interval, go to next state
 Transition : saw incomplete task before time elapsed, go to previous state
 END_OF_FIRST - the required quiet interval has elapsed
 Transition : saw first incomplete task, mark time, go to next state
 AFTER_FIRST  - there are some incomplete tasks
 Transition : all tasks complete, mark time, start second timer, go to next state
 DURING_SECOND - all tasks are complete again, we're possibly done
 Transition : waited second interval, go to next state
 Transition : saw incomplete task before time elapsed, forget end time, go to previous state
 AFTER_SECOND - we waited long enough to make sure we're done
 

 Handles all HTTP and HTTPS service requests.
 Makes a watcher to watch
 the blackboard, a trigger that will call blackboardChanged (), 
 and a trigger model to connect them.
 When a change to a subscription happens, the method call cascade is :
 1) The watcher's signalNotify method is called, which
 2) Triggers the TriggerModel
 3) The TriggerModel queues the trigger with the SchedulerService
 4) The SchedulerService calls my Trigger's trigger method
 5) That trigger method calls blackboardChanged
 Does these in order :
 - Creates all the watcher, trigger model, trigger overhead
 - Creates subscriptions to tasks and plan elements
 - Calls getResult
 - Writes results to output stream with writeResponse ()
 - Unsubscribes
 - Has the watcher unregister interest
 - Tells the trigger model to stop.
 

Calls blackboard changed initially, then waits until the state machine has reached "done."

Then records run elapsed time.
See Also:   CompletionWatcherWorker.getSettings
See Also:   CompletionWatcherWorker.blackboardChanged an "XMLable" result.

 Use a query parameter to set a field
 Sets the recognized parameters : firstInterval, secondInterval
 

Uses an alarm.
Parameters:
  delay - how long to delay before the timer expires.
See Also:   org.cougaar.core.agent.service.alarm.Alarm
See Also:   org.cougaar.core.service.AlarmService.addRealTimeAlarm