com.jayway.restassured.filter

Interface FilterContext

All Known Implementing Classes:

FilterContextImpl

public interface FilterContext

Provides the functionality to set properties, sending requests and continue the filter chain.

Method Summary

Modifier and Type	Method and Description
String	getCompleteRequestPath() Deprecated. Use FilterableRequestSpecification.getURI() instead.
String	getOriginalRequestPath() Deprecated. Use FilterableRequestSpecification.getUserDefinedPath() instead.
Method	getRequestMethod() Deprecated. Use FilterableRequestSpecification.getMethod() instead.
String	getRequestPath() Deprecated. Use FilterableRequestSpecification.getDerivedPath() instead.
String	getRequestURI() Deprecated. Use FilterableRequestSpecification.getURI() instead.
<T> T	getValue(String name) Get a value
boolean	hasValue(String name) See if this filter context contain a value with the given name
Response	next(FilterableRequestSpecification request, FilterableResponseSpecification response) Continue to the next filter in the chain.
Response	send(RequestSender requestSender) Send a request to the same request path and with the same request method as the original request.
void	setValue(String name, Object value) Add a value that may be used be subsequent filters.

Method Detail

setValue

void setValue(String name,
              Object value)

Add a value that may be used be subsequent filters.

Parameters:

name - The name of the value

value - The value itself

getValue

<T> T getValue(String name)

Get a value

Type Parameters:

T - The type of the value

Parameters:

name - The name of the value

Returns:

The value itself or null if no value was found for the supplied name.

hasValue

boolean hasValue(String name)

See if this filter context contain a value with the given name

Parameters:

name - The name of the value

Returns:

true if the value exists in this filter context, false otherwise.

send

Response send(RequestSender requestSender)

Send a request to the same request path and with the same request method as the original request.

Parameters:

requestSender - The response or request specification.

Returns:

The response.

getRequestMethod

@Deprecated
Method getRequestMethod()

Deprecated. Use FilterableRequestSpecification.getMethod() instead.

Returns:

The request method of the request (E.g. POST, GET etc)

getRequestPath

@Deprecated
String getRequestPath()

Deprecated. Use FilterableRequestSpecification.getDerivedPath() instead.

Returns:

The request path

getOriginalRequestPath

@Deprecated
String getOriginalRequestPath()

Deprecated. Use FilterableRequestSpecification.getUserDefinedPath() instead.

Returns the original request path as it was before any path parameters were applied. For example if you made the following request to REST Assured:

 get("/something/{x}", x);
 

Then this method would return "/something/{x}".

Returns:

The original request path

getRequestURI

@Deprecated
String getRequestURI()

Deprecated. Use FilterableRequestSpecification.getURI() instead.

Returns:

The request URI as a string. This is the fully-qualified path including host, port number, scheme, path and query params.

getCompleteRequestPath

@Deprecated
String getCompleteRequestPath()

Deprecated. Use FilterableRequestSpecification.getURI() instead.

Returns:

The request URI as a string. This is the fully-qualified path including host, port number, scheme, path and query params.

next

Response next(FilterableRequestSpecification request,
              FilterableResponseSpecification response)

Continue to the next filter in the chain.

Parameters:

request - The request specification

response - The response specification

Returns:

The response of the request