io.restassured.filter.cookie

Class CookieFilter

java.lang.Object

io.restassured.filter.cookie.CookieFilter

All Implemented Interfaces:

Filter

public class CookieFilter
extends Object
implements Filter

The cookie filter can be used to keep track of all the cookies sent by the server and use them in subsequent requests. It might come in handy when more than just the SessionFilter is needed. For example:

 CookieFilter cookieFilter = new CookieFilter();

 given().
         filter(cookieFilter).
 expect().
         statusCode(200).
 when().
         get("/x");

 given().
         cookie("foo", "bar").
         filter(cookieFilter). // Reuse the same cookie filter
                               // if "foo" is stored in cookieFilter it won't be applied because it's already applied explicitly
 expect().
         statusCode(200).
 when().
         get("/y");
 

Constructor Summary

Constructors

Constructor and Description
CookieFilter()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

CookieFilter

public CookieFilter()

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