io.restassured.filter.time

Class TimingFilter

java.lang.Object

io.restassured.filter.time.TimingFilter

All Implemented Interfaces:

Filter

public class TimingFilter
extends Object
implements Filter

Filter that measures the response time and stores it in the FilterContext in key ""RA_RESPONSE_TIME_MILLIS"".

Note that this is the time it takes for REST Assured to perform the request and consume the response. It's does not say how fast the server responds. Measurements can be misleading especially if the JVM is not warm. It's highly recommended to warm up the JVM by running at least one REST Assured test prior to taking any measurements.

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESPONSE_TIME_MILLISECONDS

Constructor Summary

Constructors

Constructor and Description
TimingFilter() Constructs a new TimingFilter that doesn't consume the response body automatically if consuming an input stream.
TimingFilter(boolean consumeIfInputStream) Constructs a new TimingFilter that optionally consumes the response body if consuming an input stream.

Method Summary

Modifier and Type	Method and Description
Response	filter(FilterableRequestSpecification requestSpec, FilterableResponseSpecification responseSpec, FilterContext ctx) Filter the incoming request and response specifications and outgoing response.
static TimingFilter	measureTime() Syntactic sugar for creating a new timing filter

Methods inherited from class java.lang.Object

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

Field Detail

RESPONSE_TIME_MILLISECONDS

public static final String RESPONSE_TIME_MILLISECONDS

See Also:

Constant Field Values

Constructor Detail

TimingFilter

public TimingFilter()

Constructs a new TimingFilter that doesn't consume the response body automatically if consuming an input stream.

TimingFilter

public TimingFilter(boolean consumeIfInputStream)

Constructs a new TimingFilter that optionally consumes the response body if consuming an input stream.

Parameters:

consumeIfInputStream - Consume response body and include how long it takes to consume the input stream in the response time measurement.

Method Detail

filter

public Response filter(FilterableRequestSpecification requestSpec,
                       FilterableResponseSpecification responseSpec,
                       FilterContext ctx)

Description copied from interface: Filter

Filter the incoming request and response specifications and outgoing response. You need to call FilterContext.next(FilterableRequestSpecification, FilterableResponseSpecification) when you're done otherwise the request will not be delivered. It's of course possible to abort the filter chain execution by returning a Response directly.

Specified by:

filter in interface Filter

Parameters:

requestSpec - The incoming request spec

responseSpec - The incoming response spec

ctx - The filter context. You need to call FilterContext.next(FilterableRequestSpecification, FilterableResponseSpecification) when you're done otherwise the request will not be delivered.

Returns:

The response

measureTime

public static TimingFilter measureTime()

Syntactic sugar for creating a new timing filter

Returns:

A new TimingFilter