io.restassured.specification

Interface FilterableRequestSpecification

All Superinterfaces:

QueryableRequestSpecification, RequestSender, RequestSenderOptions<Response>, RequestSpecification

All Known Implementing Classes:

RequestSpecificationImpl

public interface FilterableRequestSpecification
extends QueryableRequestSpecification, RequestSpecification

A request specification that also supports getting and changing the defined values. Intended for Filters.

Method Summary

Modifier and Type	Method and Description
FilterableRequestSpecification	path(String path) Set the request path of the request specification.
FilterableRequestSpecification	removeCookie(Cookie cookie) Remove a cookie
FilterableRequestSpecification	removeCookie(String cookieName) Remove a cookie with the given name.
FilterableRequestSpecification	removeCookies() Removed all defined cookies
FilterableRequestSpecification	removeFormParam(String parameterName) Remove a form parameter from the request.
FilterableRequestSpecification	removeHeader(String headerName) Remove a header with the given name.
FilterableRequestSpecification	removeHeaders() Removes all defined headers
FilterableRequestSpecification	removeNamedPathParam(String parameterName) Remove a named path parameter from the request.
FilterableRequestSpecification	removeParam(String parameterName) Remove a request parameter from the request.
FilterableRequestSpecification	removePathParam(String parameterName) Remove a path parameter from the request.
FilterableRequestSpecification	removeQueryParam(String parameterName) Remove a query parameter from the request.
FilterableRequestSpecification	removeUnnamedPathParam(String parameterName) Remove an unnamed path parameter from the request.
FilterableRequestSpecification	removeUnnamedPathParamByValue(String parameterValue) Remove the first unnamed path parameter from the request based on its value.
FilterableRequestSpecification	replaceCookie(Cookie cookie) Replace a cookie, if it doesn't exist then it will be added.
FilterableRequestSpecification	replaceCookie(String cookieName, String value) Replace a cookie with the given name.
FilterableRequestSpecification	replaceCookies(Cookies cookies) Replace all defined cookies
FilterableRequestSpecification	replaceHeader(String headerName, String newValue) Replace a header with the new value.
FilterableRequestSpecification	replaceHeaders(Headers headers) Replace all defined headers

Methods inherited from interface io.restassured.specification.QueryableRequestSpecification

getAuthenticationScheme, getBasePath, getBaseUri, getBody, getConfig, getContentType, getCookies, getDefinedFilters, getDerivedPath, getFormParams, getHeaders, getHttpClient, getMethod, getMultiPartParams, getNamedPathParams, getPathParamPlaceholders, getPathParams, getPort, getProxySpecification, getQueryParams, getRequestParams, getUndefinedPathParamPlaceholders, getUnnamedPathParams, getUnnamedPathParamValues, getURI, getUserDefinedPath

Methods inherited from interface io.restassured.specification.RequestSpecification

accept, accept, and, auth, basePath, baseUri, body, body, body, body, body, body, body, config, contentType, contentType, cookie, cookie, cookie, cookies, cookies, cookies, expect, filter, filters, filters, formParam, formParam, formParams, formParams, given, header, header, headers, headers, headers, keyStore, keyStore, keyStore, log, multiPart, multiPart, multiPart, multiPart, multiPart, multiPart, multiPart, multiPart, multiPart, multiPart, multiPart, multiPart, multiPart, noContentType, noFilters, noFiltersOfType, param, param, params, params, pathParam, pathParams, pathParams, port, proxy, proxy, proxy, proxy, proxy, proxy, queryParam, queryParam, queryParams, queryParams, redirects, relaxedHTTPSValidation, relaxedHTTPSValidation, request, response, sessionId, sessionId, spec, that, then, trustStore, trustStore, trustStore, urlEncodingEnabled, when, with

Methods inherited from interface io.restassured.specification.RequestSenderOptions

delete, delete, delete, delete, delete, get, get, get, get, get, head, head, head, head, head, options, options, options, options, options, patch, patch, patch, patch, patch, post, post, post, post, post, put, put, put, put, put, request, request, request, request, request, request, request, request

Method Detail

path

FilterableRequestSpecification path(String path)

Set the request path of the request specification. For example if the request was defined like this:

 get("/x");
 

You can change to path to "/y" instead using this method. This will result in a request that looks like this:

 get("/y");
 

Parameters:

path - The path

Returns:

the filterable request specification

removeFormParam

FilterableRequestSpecification removeFormParam(String parameterName)

Remove a form parameter from the request.

Parameters:

parameterName - The parameter key

Returns:

The FilterableRequestSpecification without the parameter

removePathParam

FilterableRequestSpecification removePathParam(String parameterName)

Remove a path parameter from the request. It will remove both named and unnamed path parameters.

Parameters:

parameterName - The parameter key

Returns:

The FilterableRequestSpecification without the parameter

removeNamedPathParam

FilterableRequestSpecification removeNamedPathParam(String parameterName)

Remove a named path parameter from the request. It will remove both named and unnamed path parameters.

Parameters:

parameterName - The parameter key

Returns:

The FilterableRequestSpecification without the parameter

removeUnnamedPathParam

FilterableRequestSpecification removeUnnamedPathParam(String parameterName)

Remove an unnamed path parameter from the request.

Parameters:

parameterName - The parameter key

Returns:

The FilterableRequestSpecification without the parameter

removeUnnamedPathParamByValue

FilterableRequestSpecification removeUnnamedPathParamByValue(String parameterValue)

Remove the first unnamed path parameter from the request based on its value.

Parameters:

parameterValue - The parameter key

Returns:

The FilterableRequestSpecification without the parameter

removeParam

FilterableRequestSpecification removeParam(String parameterName)

Remove a request parameter from the request.

Parameters:

parameterName - The parameter key

Returns:

The FilterableRequestSpecification without the parameter

removeQueryParam

FilterableRequestSpecification removeQueryParam(String parameterName)

Remove a query parameter from the request.

Parameters:

parameterName - The parameter key

Returns:

The FilterableRequestSpecification without the parameter

removeHeader

FilterableRequestSpecification removeHeader(String headerName)

Remove a header with the given name.

Parameters:

headerName - The header name

Returns:

The FilterableRequestSpecification without the specified header

removeCookie

FilterableRequestSpecification removeCookie(String cookieName)

Remove a cookie with the given name.

Parameters:

cookieName - The cookie name

Returns:

The FilterableRequestSpecification without the specified cookie

removeCookie

FilterableRequestSpecification removeCookie(Cookie cookie)

Remove a cookie

Parameters:

cookie - The cookie

Returns:

The FilterableRequestSpecification without the specified cookie

replaceHeader

FilterableRequestSpecification replaceHeader(String headerName,
                                             String newValue)

Replace a header with the new value. If the headerName doesn't exist the will be added.

Parameters:

headerName - The header name to replace

Returns:

The FilterableRequestSpecification with the replaced header

replaceCookie

FilterableRequestSpecification replaceCookie(String cookieName,
                                             String value)

Replace a cookie with the given name. If the cookieName doesn't exist it will be added.

Parameters:

cookieName - The cookie name

Returns:

The FilterableRequestSpecification with the replaced cookie

replaceCookie

FilterableRequestSpecification replaceCookie(Cookie cookie)

Replace a cookie, if it doesn't exist then it will be added.

Parameters:

cookie - The cookie

Returns:

The FilterableRequestSpecification with the replaced cookie

replaceHeaders

FilterableRequestSpecification replaceHeaders(Headers headers)

Replace all defined headers

Parameters:

headers - The new headers

Returns:

The FilterableRequestSpecification with the replaced headers

replaceCookies

FilterableRequestSpecification replaceCookies(Cookies cookies)

Replace all defined cookies

Parameters:

cookies - The new cookies

Returns:

The FilterableRequestSpecification with the replaced cookies

removeHeaders

FilterableRequestSpecification removeHeaders()

Removes all defined headers

Returns:

The FilterableRequestSpecification without

removeCookies

FilterableRequestSpecification removeCookies()

Removed all defined cookies

Returns:

The FilterableRequestSpecification with the replaced cookies