io.restassured.internal

Class ValidatableResponseOptionsImpl<T extends ValidatableResponseOptions<T,R>,R extends ResponseBody<R> & ResponseOptions<R>>

java.lang.Object

io.restassured.internal.ValidatableResponseOptionsImpl<T,R>

All Implemented Interfaces:

ValidatableResponseLogSpec<T,R>

Direct Known Subclasses:

ValidatableResponseImpl

public abstract class ValidatableResponseOptionsImpl<T extends ValidatableResponseOptions<T,R>,R extends ResponseBody<R> & ResponseOptions<R>>
extends Object
implements ValidatableResponseLogSpec<T,R>

Field Summary

Fields

Modifier and Type	Field and Description
protected Response	response
ResponseSpecificationImpl	responseSpec

Constructor Summary

Constructors

Constructor and Description
ValidatableResponseOptionsImpl(ResponseParserRegistrar rpr, RestAssuredConfig config, Response response, ExtractableResponse<R> extractableResponse, LogRepository logRepository)

Method Summary

Modifier and Type	Method and Description
T	all() Logs everything in the response, including e.g.
T	all(boolean shouldPrettyPrint) Logs everything in the response, including e.g.
T	and()
T	appendRootPath(String pathToAppend)
T	appendRootPath(String pathToAppend, List<Argument> arguments)
T	assertThat()
T	body() Logs only the content of the body.
T	body(boolean shouldPrettyPrint) Logs only the content of the body and pretty-print the body if specified.
T	body(List<Argument> arguments, org.hamcrest.Matcher matcher, Object... additionalKeyMatcherPairs)
T	body(List<Argument> arguments, ResponseAwareMatcher<R> responseAwareMatcher)
T	body(org.hamcrest.Matcher<?> matcher, org.hamcrest.Matcher<?>... additionalMatchers)
T	body(String path, List<Argument> arguments, org.hamcrest.Matcher matcher, Object... additionalKeyMatcherPairs)
T	body(String key, List<Argument> arguments, ResponseAwareMatcher<R> responseAwareMatcher)
T	body(String path, org.hamcrest.Matcher<?> matcher, Object... additionalKeyMatcherPairs)
T	body(String key, ResponseAwareMatcher<R> responseAwareMatcher)
T	content(String path, List<Argument> arguments, org.hamcrest.Matcher matcher, Object... additionalKeyMatcherPairs)
T	contentType(ContentType contentType)
T	contentType(org.hamcrest.Matcher<? super String> contentType)
T	contentType(String contentType)
T	cookie(String cookieName)
T	cookie(String cookieName, DetailedCookieMatcher detailedCookieMatcher)
T	cookie(String cookieName, org.hamcrest.Matcher<?> expectedValueMatcher)
T	cookie(String cookieName, Object expectedValue)
T	cookies() Logs only the cookies.
T	cookies(Map<String,?> expectedCookies)
T	cookies(String firstExpectedCookieName, Object firstExpectedCookieValue, Object... expectedCookieNameValuePairs)
T	defaultParser(Parser parser)
T	detachRootPath(String pathToDetach)
T	everything() Logs everything in the response, including e.g.
T	everything(boolean shouldPrettyPrint) * Logs everything in the response, including e.g.
ExtractableResponse<R>	extract()
<U> T	header(String headerName, java.util.function.Function<String,U> f, org.hamcrest.Matcher<? super U> matcher)
T	header(String headerName, org.hamcrest.Matcher<?> expectedValueMatcher)
T	header(String headerName, ResponseAwareMatcher<R> r)
T	header(String headerName, String expectedValue)
T	headers() Logs only the headers.
T	headers(Map<String,?> expectedHeaders)
T	headers(String firstExpectedHeaderName, Object firstExpectedHeaderValue, Object... expectedHeaders)
T	ifError() Logs everything only if an error occurs (status code >= 400).
T	ifStatusCodeIsEqualTo(int statusCode) Logs everything only if if the status code is equal to statusCode.
T	ifStatusCodeMatches(org.hamcrest.Matcher<Integer> matcher) Logs everything only if if the status code matches the supplied matcher
T	ifValidationFails() Logs everything if a test validation fails.
T	ifValidationFails(LogDetail logDetail) Logs with the supplied log detail only if the validation fails.
T	ifValidationFails(LogDetail logDetail, boolean shouldPrettyPrint) Logs all parameters only if the validations fail.
ValidatableResponseLogSpec	log()
T	noRoot()
T	noRootPath()
abstract R	originalResponse()
T	parser(String contentType, Parser parser)
T	root(String rootPath)
T	root(String rootPath, List<Argument> arguments)
T	rootPath(String rootPath)
T	rootPath(String rootPath, List<Argument> arguments)
T	spec(ResponseSpecification responseSpecification)
T	status() Logs only the status line (includes the status code)
T	statusCode(int expectedStatusCode)
T	statusCode(org.hamcrest.Matcher<? super Integer> expectedStatusCode)
T	statusLine(org.hamcrest.Matcher<? super String> expectedStatusLine)
T	statusLine(String expectedStatusLine)
T	time(org.hamcrest.Matcher<Long> matcher)
T	time(org.hamcrest.Matcher<Long> matcher, TimeUnit timeUnit)
T	using()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

responseSpec

public final ResponseSpecificationImpl responseSpec

response

protected final Response response

Constructor Detail

ValidatableResponseOptionsImpl

public ValidatableResponseOptionsImpl(ResponseParserRegistrar rpr,
                                      RestAssuredConfig config,
                                      Response response,
                                      ExtractableResponse<R> extractableResponse,
                                      LogRepository logRepository)

Method Detail

body

public T body(List<Argument> arguments,
              ResponseAwareMatcher<R> responseAwareMatcher)

body

public T body(String key,
              List<Argument> arguments,
              ResponseAwareMatcher<R> responseAwareMatcher)

body

public T body(String key,
              ResponseAwareMatcher<R> responseAwareMatcher)

body

public T body(String path,
              List<Argument> arguments,
              org.hamcrest.Matcher matcher,
              Object... additionalKeyMatcherPairs)

body

public T body(List<Argument> arguments,
              org.hamcrest.Matcher matcher,
              Object... additionalKeyMatcherPairs)

statusCode

public T statusCode(org.hamcrest.Matcher<? super Integer> expectedStatusCode)

statusCode

public T statusCode(int expectedStatusCode)

statusLine

public T statusLine(org.hamcrest.Matcher<? super String> expectedStatusLine)

statusLine

public T statusLine(String expectedStatusLine)

headers

public T headers(Map<String,?> expectedHeaders)

headers

public T headers(String firstExpectedHeaderName,
                 Object firstExpectedHeaderValue,
                 Object... expectedHeaders)

header

public T header(String headerName,
                org.hamcrest.Matcher<?> expectedValueMatcher)

header

public T header(String headerName,
                ResponseAwareMatcher<R> r)

header

public T header(String headerName,
                String expectedValue)

header

public <U> T header(String headerName,
                    java.util.function.Function<String,U> f,
                    org.hamcrest.Matcher<? super U> matcher)

cookies

public T cookies(Map<String,?> expectedCookies)

cookie

public T cookie(String cookieName)

cookies

public T cookies(String firstExpectedCookieName,
                 Object firstExpectedCookieValue,
                 Object... expectedCookieNameValuePairs)

cookie

public T cookie(String cookieName,
                org.hamcrest.Matcher<?> expectedValueMatcher)

cookie

public T cookie(String cookieName,
                Object expectedValue)

cookie

public T cookie(String cookieName,
                DetailedCookieMatcher detailedCookieMatcher)

rootPath

public T rootPath(String rootPath)

rootPath

public T rootPath(String rootPath,
                  List<Argument> arguments)

root

public T root(String rootPath,
              List<Argument> arguments)

root

public T root(String rootPath)

noRoot

public T noRoot()

noRootPath

public T noRootPath()

appendRootPath

public T appendRootPath(String pathToAppend)

appendRootPath

public T appendRootPath(String pathToAppend,
                        List<Argument> arguments)

detachRootPath

public T detachRootPath(String pathToDetach)

contentType

public T contentType(ContentType contentType)

contentType

public T contentType(String contentType)

contentType

public T contentType(org.hamcrest.Matcher<? super String> contentType)

body

public T body(org.hamcrest.Matcher<?> matcher,
              org.hamcrest.Matcher<?>... additionalMatchers)

body

public T body(String path,
              org.hamcrest.Matcher<?> matcher,
              Object... additionalKeyMatcherPairs)

content

public T content(String path,
                 List<Argument> arguments,
                 org.hamcrest.Matcher matcher,
                 Object... additionalKeyMatcherPairs)

and

public T and()

using

public T using()

assertThat

public T assertThat()

spec

public T spec(ResponseSpecification responseSpecification)

parser

public T parser(String contentType,
                Parser parser)

defaultParser

public T defaultParser(Parser parser)

extract

public ExtractableResponse<R> extract()

log

public ValidatableResponseLogSpec log()

status

public T status()

Description copied from interface: ValidatableResponseLogSpec

Logs only the status line (includes the status code)

Specified by:

status in interface ValidatableResponseLogSpec<T extends ValidatableResponseOptions<T,R>,R extends ResponseBody<R> & ResponseOptions<R>>

Returns:

The validatable response specification

ifError

public T ifError()

Description copied from interface: ValidatableResponseLogSpec

Logs everything only if an error occurs (status code >= 400).

Specified by:

ifError in interface ValidatableResponseLogSpec<T extends ValidatableResponseOptions<T,R>,R extends ResponseBody<R> & ResponseOptions<R>>

Returns:

The validatable response specification

ifStatusCodeIsEqualTo

public T ifStatusCodeIsEqualTo(int statusCode)

Description copied from interface: ValidatableResponseLogSpec

Logs everything only if if the status code is equal to statusCode.

Specified by:

ifStatusCodeIsEqualTo in interface ValidatableResponseLogSpec<T extends ValidatableResponseOptions<T,R>,R extends ResponseBody<R> & ResponseOptions<R>>

Parameters:

statusCode - The status code

Returns:

The validatable response specification

ifStatusCodeMatches

public T ifStatusCodeMatches(org.hamcrest.Matcher<Integer> matcher)

Description copied from interface: ValidatableResponseLogSpec

Logs everything only if if the status code matches the supplied matcher

Specified by:

ifStatusCodeMatches in interface ValidatableResponseLogSpec<T extends ValidatableResponseOptions<T,R>,R extends ResponseBody<R> & ResponseOptions<R>>

Parameters:

matcher - The hamcrest matcher

Returns:

The validatable response specification

body

public T body()

Description copied from interface: ValidatableResponseLogSpec

Logs only the content of the body. The body will be pretty-printed by default if content-type is either XML, JSON or HTML.

Specified by:

body in interface ValidatableResponseLogSpec<T extends ValidatableResponseOptions<T,R>,R extends ResponseBody<R> & ResponseOptions<R>>

Returns:

The specification

body

public T body(boolean shouldPrettyPrint)

Description copied from interface: ValidatableResponseLogSpec

Logs only the content of the body and pretty-print the body if specified. Note that pretty-printing can only take place if the content-type is either XML, JSON or HTML.

Specified by:

body in interface ValidatableResponseLogSpec<T extends ValidatableResponseOptions<T,R>,R extends ResponseBody<R> & ResponseOptions<R>>

Parameters:

shouldPrettyPrint - true if the body should be pretty-printed, false otherwise.

Returns:

The specification

all

public T all()

Description copied from interface: ValidatableResponseLogSpec

Logs everything in the response, including e.g. headers, cookies, body. Pretty-prints the body if content-type is either either XML, JSON or HTML..

Specified by:

all in interface ValidatableResponseLogSpec<T extends ValidatableResponseOptions<T,R>,R extends ResponseBody<R> & ResponseOptions<R>>

Returns:

The specification

all

public T all(boolean shouldPrettyPrint)

Description copied from interface: ValidatableResponseLogSpec

Logs everything in the response, including e.g. headers, cookies, body with the option to pretty-print the body if the content-type is either XML, JSON or HTML..

Specified by:

all in interface ValidatableResponseLogSpec<T extends ValidatableResponseOptions<T,R>,R extends ResponseBody<R> & ResponseOptions<R>>

Parameters:

shouldPrettyPrint - true if the body should be pretty-printed, false otherwise.

Returns:

The specification

everything

public T everything()

Description copied from interface: ValidatableResponseLogSpec

Logs everything in the response, including e.g. headers, cookies, body. Pretty-prints the body if content-type is either either XML, JSON or HTML..

Specified by:

everything in interface ValidatableResponseLogSpec<T extends ValidatableResponseOptions<T,R>,R extends ResponseBody<R> & ResponseOptions<R>>

Returns:

The specification

everything

public T everything(boolean shouldPrettyPrint)

Description copied from interface: ValidatableResponseLogSpec

* Logs everything in the response, including e.g. headers, cookies, body with the option to pretty-print the body if the content-type is either XML, JSON or HTML..

Specified by:

everything in interface ValidatableResponseLogSpec<T extends ValidatableResponseOptions<T,R>,R extends ResponseBody<R> & ResponseOptions<R>>

Parameters:

shouldPrettyPrint - true if the body should be pretty-printed, false otherwise.

Returns:

The specification

headers

public T headers()

Description copied from interface: ValidatableResponseLogSpec

Logs only the headers.

Specified by:

headers in interface ValidatableResponseLogSpec<T extends ValidatableResponseOptions<T,R>,R extends ResponseBody<R> & ResponseOptions<R>>

Returns:

The specification

cookies

public T cookies()

Description copied from interface: ValidatableResponseLogSpec

Logs only the cookies.

Specified by:

cookies in interface ValidatableResponseLogSpec<T extends ValidatableResponseOptions<T,R>,R extends ResponseBody<R> & ResponseOptions<R>>

Returns:

The specification

ifValidationFails

public T ifValidationFails()

Description copied from interface: ValidatableResponseLogSpec

Logs everything if a test validation fails.

Specified by:

ifValidationFails in interface ValidatableResponseLogSpec<T extends ValidatableResponseOptions<T,R>,R extends ResponseBody<R> & ResponseOptions<R>>

Returns:

The specification

ifValidationFails

public T ifValidationFails(LogDetail logDetail)

Description copied from interface: ValidatableResponseLogSpec

Logs with the supplied log detail only if the validation fails.

Specified by:

ifValidationFails in interface ValidatableResponseLogSpec<T extends ValidatableResponseOptions<T,R>,R extends ResponseBody<R> & ResponseOptions<R>>

Parameters:

logDetail - The log detail

Returns:

The specification

ifValidationFails

public T ifValidationFails(LogDetail logDetail,
                           boolean shouldPrettyPrint)

Description copied from interface: ValidatableResponseLogSpec

Logs all parameters only if the validations fail.

Specified by:

ifValidationFails in interface ValidatableResponseLogSpec<T extends ValidatableResponseOptions<T,R>,R extends ResponseBody<R> & ResponseOptions<R>>

Parameters:

logDetail - The log detail

shouldPrettyPrint - true if the body should be pretty-printed, false otherwise.

Returns:

The specification

time

public T time(org.hamcrest.Matcher<Long> matcher)

time

public T time(org.hamcrest.Matcher<Long> matcher,
              TimeUnit timeUnit)

originalResponse

public abstract R originalResponse()