QueryableRequestSpecification (REST Assured 3.3.0 API)

All Known Subinterfaces:

FilterableRequestSpecification

All Known Implementing Classes:

RequestSpecificationImpl
```
public interface QueryableRequestSpecification
```
A request specification that also supports getting the defined values.

Method Summary

All Methods Instance Methods Abstract 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()`
`String`	`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()`
`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.

- 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
```
String 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
  - 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.
  - 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 getPathParamPlaceholders() 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()

Interface QueryableRequestSpecification

Method Summary

Method Detail

getBaseUri

getBasePath

getDerivedPath

getUserDefinedPath

getMethod

getURI

getPort

getContentType

getAuthenticationScheme

getRequestParams

getFormParams

getPathParams

getNamedPathParams

getUnnamedPathParams

getUnnamedPathParamValues

getQueryParams

getMultiPartParams

getHeaders

getCookies

getBody

getDefinedFilters

getConfig

getHttpClient

getProxySpecification

getUndefinedPathParamPlaceholders

getPathParamPlaceholders