FilterableRequestSpecification (REST Assured 2.8.0 API)

All Superinterfaces:

RequestSender, RequestSenderOptions<Response>, RequestSpecification

All Known Implementing Classes:

RequestSpecificationImpl
```
public interface FilterableRequestSpecification
extends RequestSpecification
```
A request specification that also supports getting the defined values. Intended for Filters.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`AuthenticationScheme`	`getAuthenticationScheme()`
`String`	`getBasePath()`
`String`	`getBaseUri()`
`<T> T`	`getBody()`
`RestAssuredConfig`	`getConfig()`
`String`	`getContentType()`
`Cookies`	`getCookies()`
`List<Filter>`	`getDefinedFilters()`
`String`	`getDerivedPath()`
`Map<String,String>`	`getFormParams()`
`Headers`	`getHeaders()`
`org.apache.http.client.HttpClient`	`getHttpClient()`
`Method`	`getMethod()`
`List<MultiPartSpecification>`	`getMultiPartParams()`
`Map<String,String>`	`getNamedPathParams()`
`List<String>`	`getPathParamPlaceholders()` Returns a list of all path param placeholders that are currently undefined in the request.
`Map<String,String>`	`getPathParams()`
`int`	`getPort()`
`ProxySpecification`	`getProxySpecification()`
`Map<String,String>`	`getQueryParams()`
`String`	`getRequestContentType()` Deprecated. Use `getContentType()` instead.
`Map<String,String>`	`getRequestParams()`
`List<String>`	`getUndefinedPathParamPlaceholders()` Returns a list of all path param placeholders that are currently undefined in the request.
`Map<String,String>`	`getUnnamedPathParams()` Return the unnamed path parameters defined in the request specification as a map.
`List<String>`	`getUnnamedPathParamValues()`
`String`	`getURI()`
`String`	`getUserDefinedPath()` Returns the original request path as it was before any path parameters were applied.
`FilterableRequestSpecification`	`path(String path)` Set the request path of the request specification.
`FilterableRequestSpecification`	`removeFormParam(String parameterName)` Remove a form parameter from the request.
`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.

Methods inherited from interface com.jayway.restassured.specification.RequestSpecification
accept, accept, and, auth, authentication, basePath, baseUri, body, body, body, body, body, body, body, config, content, content, content, content, content, content, content, contentType, contentType, cookie, cookie, cookie, cookies, cookies, cookies, expect, filter, filters, filters, formParam, formParam, formParameter, formParameter, formParameters, formParameters, formParams, formParams, given, header, header, headers, headers, headers, keystore, keystore, log, multiPart, multiPart, multiPart, multiPart, multiPart, multiPart, multiPart, multiPart, multiPart, multiPart, multiPart, multiPart, multiPart, noFilters, noFiltersOfType, param, param, parameter, parameter, parameters, parameters, params, params, pathParam, pathParameter, pathParameters, pathParameters, pathParams, pathParams, port, proxy, proxy, proxy, proxy, proxy, proxy, queryParam, queryParam, queryParameter, queryParameter, queryParameters, queryParameters, queryParams, queryParams, redirects, relaxedHTTPSValidation, relaxedHTTPSValidation, request, response, sessionId, sessionId, spec, specification, that, then, trustStore, urlEncodingEnabled, when, with

Methods inherited from interface com.jayway.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

- Method Detail
  - getBaseUri
```
String getBaseUri()
```
    Returns:
    
    The base URI defined in the request specification
  - getBasePath
```
String getBasePath()
```
    Returns:
    
    The base path defined in the request specification
  - getDerivedPath
```
String getDerivedPath()
```
    Returns:
    
    The derived request path with path parameters and base path etc applied
  - getUserDefinedPath
```
String getUserDefinedPath()
```
    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
  - getMethod
```
Method getMethod()
```
    Returns:
    
    The request method of the request (E.g. POST, GET etc)
  - getURI
```
String getURI()
```
    Returns:
    
    The request URI as a string. This is the fully-qualified path including host, port number, scheme, path and query params.
  - getPort
```
int getPort()
```
    Returns:
    
    The port defined in the request specification
  - getRequestContentType
```
@Deprecated
String getRequestContentType()
```
    Deprecated. Use getContentType() instead.
    
    Returns:
    
    The request content type defined in the request specification
  - getContentType
```
String getContentType()
```
    Returns:
    
    The request content type defined in the request specification
  - getAuthenticationScheme
```
AuthenticationScheme getAuthenticationScheme()
```
    Returns:
    
    The authentication scheme defined in the request specification
  - getRequestParams
```
Map<String,String> getRequestParams()
```
    Returns:
    
    The request parameters defined in the request specification
  - getFormParams
```
Map<String,String> getFormParams()
```
    Returns:
    
    The form parameters defined in the request specification
  - getPathParams
```
Map<String,String> getPathParams()
```
    Returns:
    
    The all path parameters defined in the request specification (both named and unnamed)
  - getNamedPathParams
```
Map<String,String> getNamedPathParams()
```
    Returns:
    
    The named path parameters defined in the request specification
  - getUnnamedPathParams
```
Map<String,String> getUnnamedPathParams()
```
    Return the unnamed path parameters defined in the request specification as a map. Note that this only works when the unnamed path parameters are balanced (meaning that a place holder was defined in the user defined path and a value exists for this placeholder as an unnamed path parameter). For example when the request is defined as:
```
 get("/{x}/{y}", "one", "two");
 
```
    then this method will return { "x" : "one, "y" : "two" }. But if the request is missing the an unnamed path param for "y":
```
 get("/{x}/{y}", "one");
 
```
    then this method will return { "x" : "one" }. If the request is defined like this:
```
 get("/{x}/{y}", "one", "two", "three");
 
```
    then this method will return { "x" : "one, "y" : "two" }.
    If all you want is a list of the supplied unnamed path parameter (values) use getUnnamedPathParamValues().
    Returns:
    
    The unnamed path parameters defined in the request specification.
  - getUnnamedPathParamValues
```
List<String> getUnnamedPathParamValues()
```
    Returns:
    
    A list of all unnamed path parameters supplied to the request
    
    See Also:
    
    getUnnamedPathParams()
  - getQueryParams
```
Map<String,String> getQueryParams()
```
    Returns:
    
    The query parameters defined in the request specification
  - getMultiPartParams
```
List<MultiPartSpecification> getMultiPartParams()
```
    Returns:
    
    The multipart segments defined in the request specification
  - getHeaders
```
Headers getHeaders()
```
    Returns:
    
    The headers defined in the request specification
  - getCookies
```
Cookies getCookies()
```
    Returns:
    
    The cookies defined in the request specification
  - getBody
```
<T> T getBody()
```
    Returns:
    
    The request body
  - getDefinedFilters
```
List<Filter> getDefinedFilters()
```
    Returns:
    
    The filters (unmodifiable)
  - getConfig
```
RestAssuredConfig getConfig()
```
    Returns:
    
    The Rest Assured configurations
  - getHttpClient
```
org.apache.http.client.HttpClient getHttpClient()
```
    Returns:
    
    The underlying http client. Only use this for advanced configuration which is not accessible from Rest Assured! By default an instance of AbstractHttpClient is used by REST Assured.
  - getProxySpecification
```
ProxySpecification getProxySpecification()
```
    Returns:
    
    The defined proxy specification or null if undefined.
  - 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
  - getUndefinedPathParamPlaceholders
```
List<String> getUndefinedPathParamPlaceholders()
```
    Returns a list of all path param placeholders that are currently undefined in the request. For example if consider the following request:
```
 get("/{x}/{y}");
 
```
    Calling getPathParamPlaceholder() will return a list with "x" and "y". Note that if you have a path like this:
```
 get("/{x}/{x}");
 
```
    the list will include "x" twice. Also note that this function will only return those placeholders that are not yet defined. I.e. calling this method when the request is defined like this:
```
 get("/{x}/{y}", "something");
 
```
    will only return a list of "y". Use getPathParamPlaceholders() to get ALL placeholders.
    Returns:
    
    A list of all path param templates that were defined in the request
    
    See Also:
    
    getPathParamPlaceholders()
  - getPathParamPlaceholders
```
List<String> getPathParamPlaceholders()
```
    Returns a list of all path param placeholders that are currently undefined in the request. For example if consider the following request:
```
 get("/{x}/{y}");
 
```
    Calling getPathParamPlaceholder() will return a list with "x" and "y". Note that if you have a path like this:
```
 get("/{x}/{x}");
 
```
    the list will include "x" twice. Note that this function will return all placeholders as they were when the user issued the request. I.e. calling this method when the request is defined like this:
```
 get("/{x}/{y}", "something");
 
```
    will return a list of "x" and "y". Use getUndefinedPathParamPlaceholders() to get a list of only the placeholders that are currently undefined ("y" in this case).
    Returns:
    
    A list of all path param templates that were defined in the request
    
    See Also:
    
    getUndefinedPathParamPlaceholders()
  - 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

Interface FilterableRequestSpecification

Method Summary

Methods inherited from interface com.jayway.restassured.specification.RequestSpecification

Methods inherited from interface com.jayway.restassured.specification.RequestSenderOptions

Method Detail

getBaseUri

getBasePath

getDerivedPath

getUserDefinedPath

getMethod

getURI

getPort

getRequestContentType

getContentType

getAuthenticationScheme

getRequestParams

getFormParams

getPathParams

getNamedPathParams

getUnnamedPathParams

getUnnamedPathParamValues

getQueryParams

getMultiPartParams

getHeaders

getCookies

getBody

getDefinedFilters

getConfig

getHttpClient

getProxySpecification

path

getUndefinedPathParamPlaceholders

getPathParamPlaceholders

removeFormParam

removePathParam

removeNamedPathParam

removeUnnamedPathParam

removeUnnamedPathParamByValue

removeParam

removeQueryParam