public class RestAssuredResponseOptionsImpl<R extends ResponseOptions<R>> extends Object implements ExtractableResponse<R>
| Modifier and Type | Field and Description |
|---|---|
protected RestAssuredResponseOptionsGroovyImpl |
groovyResponse |
| Constructor and Description |
|---|
RestAssuredResponseOptionsImpl() |
| 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.
|
byte[] |
asByteArray()
Get the body as a byte array.
|
InputStream |
asInputStream()
Get the body as an input stream.
|
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() |
String |
getDefaultCharset() |
String |
getDefaultContentType() |
Cookie |
getDetailedCookie(String name) |
Cookies |
getDetailedCookies() |
RestAssuredResponseOptionsGroovyImpl |
getGroovyResponse() |
boolean |
getHasExpectations() |
String |
getHeader(String name) |
Headers |
getHeaders() |
LogRepository |
getLogRepository() |
Object |
getResponseHeaders() |
ResponseParserRegistrar |
getRpr() |
String |
getSessionId() |
Object |
getSessionIdName() |
int |
getStatusCode() |
String |
getStatusLine() |
String |
header(String name)
Get a single header value associated with the given name.
|
Headers |
headers()
The response headers.
|
XmlPath |
htmlPath()
Get an XmlPath view of the response body that uses
XmlPath.CompatibilityMode HTML. |
JsonPath |
jsonPath()
Get a JsonPath view of the response body.
|
JsonPath |
jsonPath(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 |
setDefaultCharset(String defaultCharset) |
void |
setDefaultContentType(String defaultContentType) |
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() |
XmlPath |
xmlPath()
Get an XmlPath view of the response body.
|
XmlPath |
xmlPath(XmlPath.CompatibilityMode compatibilityMode)
Get an XmlPath view of the response body but also pass in a
XmlPath.CompatibilityMode. |
XmlPath |
xmlPath(XmlPathConfig config)
Get an XmlPath view of the response body with a given configuration.
|
protected RestAssuredResponseOptionsGroovyImpl groovyResponse
public void setResponseHeaders(Object responseHeaders)
public void setCookies(Cookies cookies)
public void setContent(Object content)
public void setContentType(Object contentType)
public void setStatusLine(Object statusLine)
public void setStatusCode(Object statusCode)
public void setSessionIdName(Object sessionIdName)
public void setConnectionManager(Object connectionManager)
public void setDefaultContentType(String defaultContentType)
public void setRpr(ResponseParserRegistrar rpr)
public void setDefaultCharset(String defaultCharset)
public void setHasExpectations(boolean hasExpectations)
public void setConfig(RestAssuredConfig config)
public ResponseParserRegistrar getRpr()
public RestAssuredConfig getConfig()
public ResponseBody body()
ExtractableResponsebody in interface ExtractableResponse<R extends ResponseOptions<R>>public Headers headers()
ExtractableResponseheaders in interface ExtractableResponse<R extends ResponseOptions<R>>public String header(String name)
ExtractableResponseHeaders.getList(String) in order to get all values.header in interface ExtractableResponse<R extends ResponseOptions<R>>null if value was not found.public Map<String,String> cookies()
ExtractableResponseExtractableResponse.detailedCookies().cookies in interface ExtractableResponse<R extends ResponseOptions<R>>public Cookies detailedCookies()
ExtractableResponsedetailedCookies in interface ExtractableResponse<R extends ResponseOptions<R>>public String cookie(String name)
ExtractableResponseExtractableResponse.detailedCookie(String).cookie in interface ExtractableResponse<R extends ResponseOptions<R>>null if value was not found.public Cookie detailedCookie(String name)
ExtractableResponsedetailedCookie in interface ExtractableResponse<R extends ResponseOptions<R>>null if value was not found.public String contentType()
ExtractableResponsecontentType in interface ExtractableResponse<R extends ResponseOptions<R>>null if not found.public String statusLine()
ExtractableResponsestatusLine in interface ExtractableResponse<R extends ResponseOptions<R>>public String sessionId()
ExtractableResponseSessionConfig.sessionId in interface ExtractableResponse<R extends ResponseOptions<R>>null if not defined.public int statusCode()
ExtractableResponsestatusCode in interface ExtractableResponse<R extends ResponseOptions<R>>public R response()
response in interface ExtractableResponse<R extends ResponseOptions<R>>public <T> T as(Class<T> cls)
ResponseBodyExtractionOptionsResponseBodyExtractionOptions.as(Class, com.jayway.restassured.mapper.ObjectMapper).as in interface ResponseBodyExtractionOptionspublic <T> T as(Class<T> cls, ObjectMapperType mapperType)
ResponseBodyExtractionOptionsas in interface ResponseBodyExtractionOptionspublic <T> T as(Class<T> cls, ObjectMapper mapper)
ResponseBodyExtractionOptionsas in interface ResponseBodyExtractionOptionspublic JsonPath jsonPath()
ResponseBodyExtractionOptionsAssume 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:
ListwinnerIds = get("/lotto").jsonPath().getList("lotto.winnders.winnerId");
jsonPath in interface ResponseBodyExtractionOptionspublic JsonPath jsonPath(JsonPathConfig config)
ResponseBodyExtractionOptionsjsonPath in interface ResponseBodyExtractionOptionsconfig - The configuration to useResponseBodyExtractionOptions.jsonPath()public XmlPath xmlPath()
ResponseBodyExtractionOptions
Imagine that a POST request to http://localhost:8080/greetXML returns:
<greeting>
<firstName>John</firstName>
<lastName>Doe</lastName>
</greeting>
String firstName = get("/greetXML").xmlPath().getString("greeting.firstName");
xmlPath in interface ResponseBodyExtractionOptionspublic XmlPath xmlPath(XmlPathConfig config)
ResponseBodyExtractionOptionsxmlPath in interface ResponseBodyExtractionOptionsconfig - The configuration of the XmlPathResponseBodyExtractionOptions.xmlPath()public XmlPath xmlPath(XmlPath.CompatibilityMode compatibilityMode)
ResponseBodyExtractionOptionsXmlPath.CompatibilityMode.
This is mainly useful if you want to parse HTML documents.xmlPath in interface ResponseBodyExtractionOptionscompatibilityMode - The compatibility mode to useResponseBodyExtractionOptions.htmlPath(),
ResponseBodyExtractionOptions.xmlPath()public XmlPath htmlPath()
ResponseBodyExtractionOptionsXmlPath.CompatibilityMode HTML.
This is mainly useful when parsing HTML documents.
Note that this is the same as calling ResponseBodyExtractionOptions.xmlPath(com.jayway.restassured.path.xml.XmlPath.CompatibilityMode) with CompatibilityMode HTML.
htmlPath in interface ResponseBodyExtractionOptionspublic <T> T path(String path, String... arguments)
ResponseBodyExtractionOptionsNote 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.
path in interface ResponseBodyExtractionOptionsT - The return typepath - The json- or xml patharguments - Options argumentsResponseBodyExtractionOptions.jsonPath(),
ResponseBodyExtractionOptions.xmlPath()public String asString()
ResponseBodyDataasString in interface ResponseBodyDatapublic String asString(boolean forcePlatformDefaultCharsetIfNoCharsetIsSpecifiedInResponse)
public byte[] asByteArray()
ResponseBodyDataasByteArray in interface ResponseBodyDatapublic InputStream asInputStream()
ResponseBodyDataasInputStream in interface ResponseBodyDatapublic String print()
public String prettyPrint()
public R peek()
public R prettyPeek()
public R andReturn()
public R thenReturn()
public ResponseBody getBody()
public Headers getHeaders()
public Cookies getDetailedCookies()
public String getSessionId()
public String getContentType()
public String getStatusLine()
public int getStatusCode()
public Object getContent()
public boolean getHasExpectations()
public String getDefaultContentType()
public String getDefaultCharset()
public Object getSessionIdName()
public Object getConnectionManager()
public Object getResponseHeaders()
public LogRepository getLogRepository()
public void setLogRepository(LogRepository logRepository)
public RestAssuredResponseOptionsGroovyImpl getGroovyResponse()
public void setGroovyResponse(RestAssuredResponseOptionsGroovyImpl groovyResponse)
Copyright © 2010–2014. All rights reserved.