@ProviderType public interface RequestProgressTracker
RequestProgressTrackerclass provides the functionality to track the progress of request processing. Instances of this class are provided through the
The following functionality is provided:
logTimer(String, String, Object...)methods.
Tracking Request Processing
As the request being processed, certain steps may be tracked by calling
either of the
log methods. A tracking entry consists of a time
stamp managed by this class and a tracking message noting the actual step
Timing Processing StepsCertain steps during request processing may need to be timed in that the time required for processing should be recorded. Instances of this class maintain a map of named timers. Each timer is started (initialized or reset) by calling the
startTimer(String)method. This method just records the starting time of the named timer and adds a tracking entry with the timer name as the message.
To record the number of milliseconds elapsed since a timer has been started,
logTimer(String, String, Object...)
method may be called. This method logs a tracking entry with a message
consisting of the name of the timer and the number of milliseconds elapsed
since the timer was last
logTimer methods may be called multiple times to record
several timed steps.
startTimer(String) method with the name of timer which
already exists, resets the start time of the named timer to the current
Retrieving Tracking Entries
dump(PrintWriter) method may be used to write the tracking
entries to the given
PrintWriter to for example log them in a
HTML comment. Alternatively the tracking entries may be retrieved as an
iterator of messages through the
getMessages() method. The
formatting of the tracking entries is implementation specific.
|Modifier and Type||Method and Description|
Call this when done processing the request - only the first call of this method is processed, all further calls to this method are ignored.
Dumps the process timer entries to the given writer, one entry per line.
Creates an entry with the given message
Creates an entry with a message constructed from the given
Logs an entry with the message set to the name of the timer and the number of milliseconds elapsed since the timer start.
Logs an entry with the message constructed from the given
Starts a named timer.
void log(String message)
MessageFormatformat evaluated using the given formatting arguments.
void startTimer(String timerName)
void logTimer(String timerName)
MessageFormatpattern evaluated using the given arguments and the number of milliseconds elapsed since the timer start.
Iteratorof tracking entries. If there are no messages
void dump(PrintWriter writer)
Copyright © 2014 The Apache Software Foundation. All rights reserved.