RestAssuredResponseOptionsImpl (REST Assured 4.3.3 API)

java.lang.Object
- io.restassured.internal.RestAssuredResponseOptionsImpl<R>

All Implemented Interfaces:

ExtractableResponse<R>, ResponseBodyData, ResponseBodyExtractionOptions

Direct Known Subclasses:

RestAssuredResponseImpl
```
public class RestAssuredResponseOptionsImpl<R extends ResponseOptions<R>>
extends Object
implements ExtractableResponse<R>
```
We delegate to the groovy impl here because the Groovy impl messes up generics (see e.g. http://stackoverflow.com/questions/11395527/groovy-generics-failure) and thus we cannot let the Groovy implementation implement our interfaces directly.

Field Summary

Fields
Modifier and Type Field and Description

protected RestAssuredResponseOptionsGroovyImpl groovyResponse

Fields
Modifier and Type	Field and Description
`protected RestAssuredResponseOptionsGroovyImpl`	`groovyResponse`

Constructor Summary

Constructors
Constructor and Description

RestAssuredResponseOptionsImpl()

Constructors
Constructor and Description
`RestAssuredResponseOptionsImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`R`	`andReturn()`
`<T> T`	`as(Class<T> cls)` Get the body and map it to a Java object.
`<T> T`	`as(Class<T> cls, ObjectMapper mapper)` Get the body and map it to a Java object using a specific object mapper.
`<T> T`	`as(Class<T> cls, ObjectMapperType mapperType)` Get the body and map it to a Java object using a specific object mapper type.
`<T> T`	`as(Type cls)` Get the body and map it to a Java type with specified type.
`<T> T`	`as(Type cls, ObjectMapper mapper)` Get the body and map it to a Java type using a specific object mapper.
`<T> T`	`as(Type cls, ObjectMapperType mapperType)` Get the body and map it to a Java type with specified type using a specific object mapper type.
`<T> T`	`as(io.restassured.common.mapper.TypeRef<T> typeRef)` Get the body as a container with a generic type.
`byte[]`	`asByteArray()` Get the body as a byte array.
`InputStream`	`asInputStream()` Get the body as an input stream.
`String`	`asPrettyString()` Get the body as a pretty formatted string.
`String`	`asString()` Get the body as a string.
`String`	`asString(boolean forcePlatformDefaultCharsetIfNoCharsetIsSpecifiedInResponse)`
`ResponseBody`	`body()` Returns the response body
`String`	`contentType()` Get the content type of the response
`String`	`cookie(String name)` Get a single cookie value associated with the given name.
`Map<String,String>`	`cookies()` The response cookies as simple name/value pair.
`Cookie`	`detailedCookie(String name)` Get a single cookie including all attributes associated with the given name.
`Cookies`	`detailedCookies()` The response cookies with all the attributes.
`ResponseBody`	`getBody()`
`RestAssuredConfig`	`getConfig()`
`Object`	`getConnectionManager()`
`Object`	`getContent()`
`String`	`getContentType()`
`String`	`getCookie(String name)`
`Map<String,String>`	`getCookies()`
`DecoderConfig`	`getDecoderConfig()`
`String`	`getDefaultContentType()`
`Cookie`	`getDetailedCookie(String name)`
`Cookies`	`getDetailedCookies()`
`Map`	`getFilterContextProperties()`
`RestAssuredResponseOptionsGroovyImpl`	`getGroovyResponse()`
`boolean`	`getHasExpectations()`
`String`	`getHeader(String name)`
`Headers`	`getHeaders()`
`LogRepository`	`getLogRepository()`
`Object`	`getResponseHeaders()`
`ResponseParserRegistrar`	`getRpr()`
`String`	`getSessionId()`
`Object`	`getSessionIdName()`
`int`	`getStatusCode()`
`String`	`getStatusLine()`
`long`	`getTime()`
`long`	`getTimeIn(TimeUnit timeUnit)`
`String`	`header(String name)` Get a single header value associated with the given name.
`Headers`	`headers()` The response headers.
`io.restassured.path.xml.XmlPath`	`htmlPath()` Get an XmlPath view of the response body that uses `XmlPath.CompatibilityMode` `HTML`.
`boolean`	`isInputStream()`
`io.restassured.path.json.JsonPath`	`jsonPath()` Get a JsonPath view of the response body.
`io.restassured.path.json.JsonPath`	`jsonPath(io.restassured.path.json.config.JsonPathConfig config)` Get a JsonPath view of the response body using the specified configuration.
`<T> T`	`path(String path, String... arguments)` Get a value from the response body using the JsonPath or XmlPath syntax.
`R`	`peek()`
`R`	`prettyPeek()`
`String`	`prettyPrint()`
`String`	`print()`
`R`	`response()`
`String`	`sessionId()` Get the session id from the response.
`void`	`setConfig(RestAssuredConfig config)`
`void`	`setConnectionManager(Object connectionManager)`
`void`	`setContent(Object content)`
`void`	`setContentType(Object contentType)`
`void`	`setCookies(Cookies cookies)`
`void`	`setDecoderConfig(DecoderConfig decoderConfig)`
`void`	`setDefaultContentType(String defaultContentType)`
`void`	`setFilterContextProperties(Map filterContextProperties)`
`void`	`setGroovyResponse(RestAssuredResponseOptionsGroovyImpl groovyResponse)`
`void`	`setHasExpectations(boolean hasExpectations)`
`void`	`setLogRepository(LogRepository logRepository)`
`void`	`setResponseHeaders(Object responseHeaders)`
`void`	`setRpr(ResponseParserRegistrar rpr)`
`void`	`setSessionIdName(Object sessionIdName)`
`void`	`setStatusCode(Object statusCode)`
`void`	`setStatusLine(Object statusLine)`
`int`	`statusCode()` Get the status code of the response.
`String`	`statusLine()` Get the status line of the response.
`R`	`thenReturn()`
`long`	`time()`
`long`	`timeIn(TimeUnit timeUnit)`
`io.restassured.path.xml.XmlPath`	`xmlPath()` Get an XmlPath view of the response body.
`io.restassured.path.xml.XmlPath`	`xmlPath(io.restassured.path.xml.XmlPath.CompatibilityMode compatibilityMode)` Get an XmlPath view of the response body but also pass in a `XmlPath.CompatibilityMode`.
`io.restassured.path.xml.XmlPath`	`xmlPath(io.restassured.path.xml.config.XmlPathConfig config)` Get an XmlPath view of the response body with a given configuration.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - groovyResponse
```
protected RestAssuredResponseOptionsGroovyImpl groovyResponse
```
- Constructor Detail
  - RestAssuredResponseOptionsImpl
```
public RestAssuredResponseOptionsImpl()
```
- Method Detail
  - setResponseHeaders
```
public void setResponseHeaders(Object responseHeaders)
```
  - setCookies
```
public void setCookies(Cookies cookies)
```
  - setContent
```
public void setContent(Object content)
```
  - setContentType
```
public void setContentType(Object contentType)
```
  - setStatusLine
```
public void setStatusLine(Object statusLine)
```
  - setStatusCode
```
public void setStatusCode(Object statusCode)
```
  - setSessionIdName
```
public void setSessionIdName(Object sessionIdName)
```
  - setFilterContextProperties
```
public void setFilterContextProperties(Map filterContextProperties)
```
  - setConnectionManager
```
public void setConnectionManager(Object connectionManager)
```
  - setDefaultContentType
```
public void setDefaultContentType(String defaultContentType)
```
  - setRpr
```
public void setRpr(ResponseParserRegistrar rpr)
```
  - setDecoderConfig
```
public void setDecoderConfig(DecoderConfig decoderConfig)
```
  - setHasExpectations
```
public void setHasExpectations(boolean hasExpectations)
```
  - setConfig
```
public void setConfig(RestAssuredConfig config)
```
  - getRpr
```
public ResponseParserRegistrar getRpr()
```
  - getConfig
```
public RestAssuredConfig getConfig()
```
  - body
```
public ResponseBody body()
```
    Description copied from interface: ExtractableResponse
    
    Returns the response body
    
    Specified by:
    
    body in interface ExtractableResponse<R extends ResponseOptions<R>>
    
    Returns:
    
    The response body.
  - headers
```
public Headers headers()
```
    Description copied from interface: ExtractableResponse
    
    The response headers. If there are several response headers with the same name a list of the response header values are returned.
    
    Specified by:
    
    headers in interface ExtractableResponse<R extends ResponseOptions<R>>
    
    Returns:
    
    The response headers.
  - header
```
public String header(String name)
```
    Description copied from interface: ExtractableResponse
    
    Get a single header value associated with the given name. If the header is a multi-value header then you need to use Headers.getList(String) in order to get all values.
    
    Specified by:
    
    header in interface ExtractableResponse<R extends ResponseOptions<R>>
    
    Returns:
    
    The header value or null if value was not found.
  - cookies
```
public Map<String,String> cookies()
```
    Description copied from interface: ExtractableResponse
    
    The response cookies as simple name/value pair. It assumes that no cookies have the same name. If two cookies should never the less have the same name the Last cookie value is used. If you want to return ALL cookies including all the details such as Max-Age etc use ExtractableResponse.detailedCookies().
    
    Specified by:
    
    cookies in interface ExtractableResponse<R extends ResponseOptions<R>>
    
    Returns:
    
    The response cookies.
  - detailedCookies
```
public Cookies detailedCookies()
```
    Description copied from interface: ExtractableResponse
    
    The response cookies with all the attributes. It also gives you the possibility to get multi-value cookies.
    
    Specified by:
    
    detailedCookies in interface ExtractableResponse<R extends ResponseOptions<R>>
    
    Returns:
    
    The response cookies.
  - cookie
```
public String cookie(String name)
```
    Description copied from interface: ExtractableResponse
    
    Get a single cookie value associated with the given name. If you want more details than just the value use ExtractableResponse.detailedCookie(String).
    
    Specified by:
    
    cookie in interface ExtractableResponse<R extends ResponseOptions<R>>
    
    Returns:
    
    The cookie value or null if value was not found.
  - detailedCookie
```
public Cookie detailedCookie(String name)
```
    Description copied from interface: ExtractableResponse
    
    Get a single cookie including all attributes associated with the given name.
    
    Specified by:
    
    detailedCookie in interface ExtractableResponse<R extends ResponseOptions<R>>
    
    Returns:
    
    The cookie value or null if value was not found.
  - contentType
```
public String contentType()
```
    Description copied from interface: ExtractableResponse
    
    Get the content type of the response
    
    Specified by:
    
    contentType in interface ExtractableResponse<R extends ResponseOptions<R>>
    
    Returns:
    
    The content type value or null if not found.
  - statusLine
```
public String statusLine()
```
    Description copied from interface: ExtractableResponse
    
    Get the status line of the response.
    
    Specified by:
    
    statusLine in interface ExtractableResponse<R extends ResponseOptions<R>>
    
    Returns:
    
    The status line of the response.
  - sessionId
```
public String sessionId()
```
    Description copied from interface: ExtractableResponse
    
    Get the session id from the response. The session id name can be configured from the SessionConfig.
    
    Specified by:
    
    sessionId in interface ExtractableResponse<R extends ResponseOptions<R>>
    
    Returns:
    
    The session id of the response or null if not defined.
  - statusCode
```
public int statusCode()
```
    Description copied from interface: ExtractableResponse
    
    Get the status code of the response.
    
    Specified by:
    
    statusCode in interface ExtractableResponse<R extends ResponseOptions<R>>
    
    Returns:
    
    The status code of the response.
  - response
```
public R response()
```
    Specified by:
    
    response in interface ExtractableResponse<R extends ResponseOptions<R>>
    
    Returns:
    
    The entire response object including headers, cookies and body etc.
  - as
```
public <T> T as(Class<T> cls)
```
    Description copied from interface: ResponseBodyExtractionOptions
    Get the body and map it to a Java object. For JSON responses this requires that you have either
    1. Jackson, or
    2. Gson
    in the classpath or for XML responses it requires JAXB to be in the classpath.
    It also requires that the response content-type is either JSON or XML or that a default parser has been been set. You can also force a specific object mapper using ResponseBodyExtractionOptions.as(Class, ObjectMapper).
    Specified by:
    
    as in interface ResponseBodyExtractionOptions
    
    Returns:
    
    The object
  - as
```
public <T> T as(Class<T> cls,
                ObjectMapperType mapperType)
```
    Description copied from interface: ResponseBodyExtractionOptions
    
    Get the body and map it to a Java object using a specific object mapper type. It will use the supplied mapper regardless of the response content-type.
    
    Specified by:
    
    as in interface ResponseBodyExtractionOptions
    
    Returns:
    
    The object
  - as
```
public <T> T as(Class<T> cls,
                ObjectMapper mapper)
```
    Description copied from interface: ResponseBodyExtractionOptions
    
    Get the body and map it to a Java object using a specific object mapper. It will use the supplied mapper regardless of the response content-type.
    
    Specified by:
    
    as in interface ResponseBodyExtractionOptions
    
    Returns:
    
    The object
  - as
```
public <T> T as(io.restassured.common.mapper.TypeRef<T> typeRef)
```
    Description copied from interface: ResponseBodyExtractionOptions
    
    Get the body as a container with a generic type. Note that this may not work for JAXB (XML) or HTML.
    
    Specified by:
    
    as in interface ResponseBodyExtractionOptions
    
    Returns:
    
    The object
  - as
```
public <T> T as(Type cls)
```
    Description copied from interface: ResponseBodyExtractionOptions
    Get the body and map it to a Java type with specified type. For JSON responses this requires that you have either
    1. Jackson, or
    2. Gson
    in the classpath or for XML responses it requires JAXB to be in the classpath.
    It also requires that the response content-type is either JSON or XML or that a default parser has been been set. You can also force a specific object mapper using ResponseBodyExtractionOptions.as(Type, ObjectMapper).
    Specified by:
    
    as in interface ResponseBodyExtractionOptions
    
    Returns:
    
    The object
  - as
```
public <T> T as(Type cls,
                ObjectMapperType mapperType)
```
    Description copied from interface: ResponseBodyExtractionOptions
    
    Get the body and map it to a Java type with specified type using a specific object mapper type. It will use the supplied mapper regardless of the response content-type.
    
    Specified by:
    
    as in interface ResponseBodyExtractionOptions
    
    Returns:
    
    The object
  - as
```
public <T> T as(Type cls,
                ObjectMapper mapper)
```
    Description copied from interface: ResponseBodyExtractionOptions
    
    Get the body and map it to a Java type using a specific object mapper. It will use the supplied mapper regardless of the response content-type.
    
    Specified by:
    
    as in interface ResponseBodyExtractionOptions
    
    Returns:
    
    The object
  - jsonPath
```
public io.restassured.path.json.JsonPath jsonPath()
```
    Description copied from interface: ResponseBodyExtractionOptions
    Get a JsonPath view of the response body. This will let you use the JsonPath syntax to get values from the response. Example:
    Assume that the GET request (to http://localhost:8080/lotto) returns JSON as:
```
 {
 "lotto":{
   "lottoId":5,
   "winning-numbers":[2,45,34,23,7,5,3],
   "winners":[{
     "winnerId":23,
     "numbers":[2,45,34,23,3,5]
   },{
     "winnerId":54,
     "numbers":[52,3,12,11,18,22]
   }]
  }
 }
 
```
    You can the make the request and get the winner id's by using JsonPath:
```
 List winnerIds = get("/lotto").jsonPath().getList("lotto.winnders.winnerId");
 
```
    Specified by:
    
    jsonPath in interface ResponseBodyExtractionOptions
  - jsonPath
```
public io.restassured.path.json.JsonPath jsonPath(io.restassured.path.json.config.JsonPathConfig config)
```
    Description copied from interface: ResponseBodyExtractionOptions
    
    Get a JsonPath view of the response body using the specified configuration.
    
    Specified by:
    
    jsonPath in interface ResponseBodyExtractionOptions
    
    Parameters:
    
    config - The configuration to use
    
    See Also:
    
    ResponseBodyExtractionOptions.jsonPath()
  - xmlPath
```
public io.restassured.path.xml.XmlPath xmlPath()
```
    Description copied from interface: ResponseBodyExtractionOptions
    Get an XmlPath view of the response body. This will let you use the XmlPath syntax to get values from the response. Example:
    Imagine that a POST request to http://localhost:8080/greetXML returns:
```
 <greeting>
     <firstName>John</firstName>
     <lastName>Doe</lastName>
   </greeting>
 
```
    You can the make the request and get the winner id's by using JsonPath: String firstName = get("/greetXML").xmlPath().getString("greeting.firstName");
    Specified by: xmlPath in interface ResponseBodyExtractionOptions
  xmlPath public io.restassured.path.xml.XmlPath xmlPath(io.restassured.path.xml.config.XmlPathConfig config) Description copied from interface: ResponseBodyExtractionOptions Get an XmlPath view of the response body with a given configuration. Specified by: xmlPath in interface ResponseBodyExtractionOptions Parameters: config - The configuration of the XmlPath See Also: ResponseBodyExtractionOptions.xmlPath() xmlPath public io.restassured.path.xml.XmlPath xmlPath(io.restassured.path.xml.XmlPath.CompatibilityMode compatibilityMode) Description copied from interface: ResponseBodyExtractionOptions Get an XmlPath view of the response body but also pass in a XmlPath.CompatibilityMode. This is mainly useful if you want to parse HTML documents. Specified by: xmlPath in interface ResponseBodyExtractionOptions Parameters: compatibilityMode - The compatibility mode to use See Also: ResponseBodyExtractionOptions.htmlPath(), ResponseBodyExtractionOptions.xmlPath() htmlPath public io.restassured.path.xml.XmlPath htmlPath() Description copied from interface: ResponseBodyExtractionOptions Get an XmlPath view of the response body that uses XmlPath.CompatibilityMode HTML. This is mainly useful when parsing HTML documents. Note that this is the same as calling ResponseBodyExtractionOptions.xmlPath(XmlPath.CompatibilityMode) with CompatibilityMode HTML. Specified by: htmlPath in interface ResponseBodyExtractionOptions path public <T> T path(String path, String... arguments) Description copied from interface: ResponseBodyExtractionOptions Get a value from the response body using the JsonPath or XmlPath syntax. REST Assured will automatically determine whether to use JsonPath or XmlPath based on the content-type of the response. If no content-type is defined then REST Assured will try to look at the "default parser" if defined (RestAssured.defaultParser). Note that you can also also supply arguments, for example: String z = get("/x").path("x.y.%s", "z"); The path and arguments follows the standard formatting syntax of Java. Specified by: path in interface ResponseBodyExtractionOptions Type Parameters: T - The return type Parameters: path - The json- or xml path arguments - Options arguments Returns: The value returned by the path See Also: ResponseBodyExtractionOptions.jsonPath(), ResponseBodyExtractionOptions.xmlPath() asString public String asString() Description copied from interface: ResponseBodyData Get the body as a string. Specified by: asString in interface ResponseBodyData Returns: The body as a string. asString public String asString(boolean forcePlatformDefaultCharsetIfNoCharsetIsSpecifiedInResponse) asPrettyString public String asPrettyString() Description copied from interface: ResponseBodyData Get the body as a pretty formatted string. Specified by: asPrettyString in interface ResponseBodyData Returns: The body as a string. asByteArray public byte[] asByteArray() Description copied from interface: ResponseBodyData Get the body as a byte array. Specified by: asByteArray in interface ResponseBodyData Returns: The body as a array. asInputStream public InputStream asInputStream() Description copied from interface: ResponseBodyData Get the body as an input stream. Specified by: asInputStream in interface ResponseBodyData Returns: The body as an input stream. isInputStream public boolean isInputStream() print public String print() prettyPrint public String prettyPrint() peek public R peek() prettyPeek public R prettyPeek() andReturn public R andReturn() thenReturn public R thenReturn() getBody public ResponseBody getBody() getHeaders public Headers getHeaders() getHeader public String getHeader(String name) getDetailedCookies public Cookies getDetailedCookies() getCookie public String getCookie(String name) getDetailedCookie public Cookie getDetailedCookie(String name) getSessionId public String getSessionId() getCookies public Map<String,String> getCookies() getContentType public String getContentType() getStatusLine public String getStatusLine() getStatusCode public int getStatusCode() getContent public Object getContent() getHasExpectations public boolean getHasExpectations() getDefaultContentType public String getDefaultContentType() getDecoderConfig public DecoderConfig getDecoderConfig() getSessionIdName public Object getSessionIdName() getConnectionManager public Object getConnectionManager() getResponseHeaders public Object getResponseHeaders() getLogRepository public LogRepository getLogRepository() setLogRepository public void setLogRepository(LogRepository logRepository) getGroovyResponse public RestAssuredResponseOptionsGroovyImpl getGroovyResponse() getFilterContextProperties public Map getFilterContextProperties() setGroovyResponse public void setGroovyResponse(RestAssuredResponseOptionsGroovyImpl groovyResponse) time public long time() Specified by: time in interface ExtractableResponse<R extends ResponseOptions<R>> Returns: The response time in milliseconds (or -1 if no response time could be measured) timeIn public long timeIn(TimeUnit timeUnit) Specified by: timeIn in interface ExtractableResponse<R extends ResponseOptions<R>> Returns: The response time in the given time unit (or -1 if no response time could be measured) getTime public long getTime() getTimeIn public long getTimeIn(TimeUnit timeUnit)

Class RestAssuredResponseOptionsImpl<R extends ResponseOptions<R>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

groovyResponse

Constructor Detail

RestAssuredResponseOptionsImpl

Method Detail

setResponseHeaders

setCookies

setContent

setContentType

setStatusLine

setStatusCode

setSessionIdName

setFilterContextProperties

setConnectionManager

setDefaultContentType

setRpr

setDecoderConfig

setHasExpectations

setConfig

getRpr

getConfig

body

headers

header

cookies

detailedCookies

cookie

detailedCookie

contentType

statusLine

sessionId

statusCode

response

as

as

as

as

as

as

as

jsonPath

jsonPath

xmlPath

xmlPath

xmlPath

htmlPath

path

asString

asString

asPrettyString

asByteArray

asInputStream

isInputStream

print

prettyPrint

peek

prettyPeek

andReturn

thenReturn

getBody

getHeaders

getHeader

getDetailedCookies

getCookie

getDetailedCookie

getSessionId

getCookies

getContentType

getStatusLine

getStatusCode

getContent

getHasExpectations

getDefaultContentType

getDecoderConfig

getSessionIdName