io.devcon5.pageobjects.measure

Class ResponseTimes

java.lang.Object

io.devcon5.pageobjects.measure.ResponseTimes

public final class ResponseTimes
extends Object

Global Handler for recording response time. As default setting, the response times are stored in a global collection. This class allows to record response times of transaction across multiple threads. It must be ensured, that the response are cleared after the measured sequence, otherwise the response remain in memory permanently.

Method Summary

Modifier and Type	Method and Description
static void	clear() Clears the global response time collection
static ResponseTime	collect(ResponseTime responseTime) Collects a completed ResponeTime recording.
static ResponseTime	collect(String transaction, TimeMeasure result) Collects a completed time measure for a specific transaction.
static Map<String,List<ResponseTime>>	getResponseTimes() Returns all recorded response times.
static void	onMeasureEnd(Consumer<ResponseTime> responseTimeConsumer) Overrides the default consumer that handles response times on the end of a transaction
static void	onMeasureStart(Consumer<ResponseTime> responseTimeConsumer) Overrides the default consumer that handles response times on the beginning of a transaction
static void	resetResponseTimeHandlers() Resets the response time consumer to the default.
static ResponseTime	startTx(String transaction) Starts a transaction on the specified point in time
static ResponseTime	startTx(String transaction, Instant start) Starts a transaction on the specified point in time
static ResponseTime	stopTx(ResponseTime finish) Records the response time as finished.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

clear

public static void clear()

Clears the global response time collection

resetResponseTimeHandlers

public static void resetResponseTimeHandlers()

Resets the response time consumer to the default.

onMeasureStart

public static void onMeasureStart(Consumer<ResponseTime> responseTimeConsumer)

Overrides the default consumer that handles response times on the beginning of a transaction

Parameters:

responseTimeConsumer - the consumer to process response times

onMeasureEnd

public static void onMeasureEnd(Consumer<ResponseTime> responseTimeConsumer)

Overrides the default consumer that handles response times on the end of a transaction

Parameters:

responseTimeConsumer - the consumer to process response times

startTx

public static ResponseTime startTx(String transaction)

Starts a transaction on the specified point in time

Parameters:

transaction - the transaction to start

Returns:

the ResponseTime handle to track the time measure

startTx

public static ResponseTime startTx(String transaction,
                                   Instant start)

Starts a transaction on the specified point in time

Parameters:

transaction - the transaction to start

start - the point in time when the transaction started

Returns:

the ResponseTime handle for this response time measure

stopTx

public static ResponseTime stopTx(ResponseTime finish)

Records the response time as finished.

Parameters:

finish - the response time of the finished transaction. If the response time denotes no finished transaction, it is finished now.

Returns:

the finished ResponseTime

collect

public static ResponseTime collect(ResponseTime responseTime)

Collects a completed ResponeTime recording.

Parameters:

responseTime - the responseTime to collect into the global collection.

collect

public static ResponseTime collect(String transaction,
                                   TimeMeasure result)

Collects a completed time measure for a specific transaction.

Parameters:

transaction - the transaction to be associated with the time measure

result - a time measure result to associate with the transaction

Returns:

the response time recorded

getResponseTimes

public static Map<String,List<ResponseTime>> getResponseTimes()

Returns all recorded response times.

Returns:

a map of the response times. The map contains the transaction names as key, and a list of measured responseTimes for that transaction as value.