io.restassured.filter.session

Class SessionFilter

java.lang.Object

io.restassured.filter.session.SessionFilter

All Implemented Interfaces:

Filter

public class SessionFilter
extends Object
implements Filter

A session filter can be used record the session id returned from the server as well as automatically apply this session id in subsequent requests. For example:

 SessionFilter sessionFilter = new SessionFilter();

 given().
         auth().form("John", "Doe").
         filter(sessionFilter).
 expect().
          statusCode(200).
 when().
        get("/x");

 given().
         filter(sessionFilter). // Reuse the same session filter instance to automatically apply the session id from the previous response
 expect().
          statusCode(200).
 when().
        get("/y");
 

Constructor Summary

Constructors

Constructor and Description
SessionFilter()

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.
String	getSessionId()
boolean	hasSessionId()

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionFilter

public SessionFilter()

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

getSessionId

public String getSessionId()

Returns:

The last received session id.

hasSessionId

public boolean hasSessionId()

Returns:

true if a session id has been returned from the server and caught by the filter, false otherwise.