Uses of Class
com.shri.restinpeace.mock.MockResponse

Packages that use MockResponse

Package	Description
com.shri.restinpeace.mock

Uses of MockResponse in com.shri.restinpeace.mock

Methods in com.shri.restinpeace.mock that return MockResponse

Modifier and Type	Method	Description
static MockResponse	MockResponse.connectionFailure()	Simulates a transport-level failure - the connection is closed before any response is sent, instead of returning an HTTP status - so a test can exercise RIP's "no response at all" error path (a kong.unirest.UnirestException thrown directly, not wrapped in RestInPeaceHttpException, and always retried by @Retry regardless of retryOnStatus) instead of only ever seeing a non-2xx status.
MockResponse	MockResponse.delay(long delayMillis)	Delays sending this response by delayMillis, to simulate a slow server - the way to prove @Timeout(readMillis = ...) (or RipClientConfig.readTimeoutMillis(...)) actually fires, rather than assuming it does because the annotation is present.
MockResponse	MockResponse.header(String name, String value)	Adds a response header.
static MockResponse	MockResponse.json(Object body)	A 200 OK response, serializing body with the same Unirest ObjectMapper RIP itself delegates to (the one RIP.setObjectMapper(kong.unirest.ObjectMapper) sets) - so a test can hand this a plain object instead of hand-writing a JSON string.
static MockResponse	MockResponse.noContent()	A 204 No Content response.
static MockResponse	MockResponse.notModified()	A 304 Not Modified response, for a test simulating a cache revalidation hit - RIP's response cache sends If-None-Match/ If-Modified-Since automatically once a cached GET entry goes stale, and expects exactly this status back to keep serving the previously-cached body instead of treating the response as a fresh one.
static MockResponse	MockResponse.ok(String body)	A 200 OK response with a body, defaulting Content-Type to application/json - override via header(java.lang.String, java.lang.String) for a plain-text/other body.
static MockResponse	MockResponse.status(int status, byte[] body)	A response with the given status and raw bytes, for a binary (byte[]/File-returning) call.
static MockResponse	MockResponse.status(int status, String body)	A response with the given status and a raw body, no default headers.

Methods in com.shri.restinpeace.mock with parameters of type MockResponse

Modifier and Type	Method	Description
MockRestServer	MockRestServer.enqueue(MockResponse response)	Queues a response for the next request that doesn't match any route registered via MockRestServer.on(com.shri.restinpeace.constant.HTTPMethod, java.lang.String, com.shri.restinpeace.mock.MockResponse) - a route always wins over this queue for a request it matches, so this only ever answers a path with no matching route at all.
MockRestServer	MockRestServer.enqueueFor(HTTPMethod httpMethod, String pathTemplate, MockResponse response)	Scripts a one-time response for a route already registered via MockRestServer.on(HTTPMethod, String, MockResponse), consumed - in the order queued - before that route's sticky response, the way to combine a scripted failure sequence with a sticky final answer for the same path (e.g. a 503 then a 200, to prove @Retry recovers, while every request after that still gets the 200 the route was registered with).
MockRestServer	MockRestServer.enqueueFor(HTTPMethod httpMethod, String pathTemplate, Map<String,String> requiredQueryParams, MockResponse response)	Same as MockRestServer.enqueueFor(HTTPMethod, String, MockResponse), for a route registered via MockRestServer.on(HTTPMethod, String, Map, MockResponse) with the same requiredQueryParams.
MockRestServer	MockRestServer.on(HTTPMethod httpMethod, String pathTemplate, MockResponse response)	Registers a response for every request matching httpMethod and pathTemplate - unlike MockRestServer.enqueue(com.shri.restinpeace.mock.MockResponse), this doesn't get consumed; it keeps answering every matching request the same way.
MockRestServer	MockRestServer.on(HTTPMethod httpMethod, String pathTemplate, Predicate<RecordedRequest> matcher, MockResponse response)	Same as MockRestServer.on(HTTPMethod, String, MockResponse), but only matches a request for which matcher also returns true - for matching on a request header or the request body, neither of which the requiredQueryParams overload covers, e.g.
MockRestServer	MockRestServer.on(HTTPMethod httpMethod, String pathTemplate, Map<String,String> requiredQueryParams, MockResponse response)	Same as MockRestServer.on(HTTPMethod, String, MockResponse), but only matches a request whose query params contain every entry in requiredQueryParams with an equal value - any other query params the request carries are ignored.
MockRestServer	MockRestServer.onFlaky(HTTPMethod httpMethod, String pathTemplate, int failuresBeforeSuccess, MockResponse failureResponse, MockResponse successResponse)	Registers a route that fails failuresBeforeSuccess times with failureResponse before settling into successResponse for every request after that - sugar for calling MockRestServer.on(HTTPMethod, String, MockResponse) with successResponse and then MockRestServer.enqueueFor(com.shri.restinpeace.constant.HTTPMethod, java.lang.String, com.shri.restinpeace.mock.MockResponse) with failureResponse failuresBeforeSuccess times.
MockRestServer	MockRestServer.onPages(HTTPMethod httpMethod, String pathTemplate, MockResponse... responses)	Scripts an ordered sequence of responses for a route - the 1st matching request gets responses[0], the 2nd gets responses[1], and so on, with the last response answering every request after the sequence is exhausted.
MockRestServer	MockRestServer.onPages(HTTPMethod httpMethod, String pathTemplate, Map<String,String> requiredQueryParams, MockResponse... responses)	Same as MockRestServer.onPages(HTTPMethod, String, MockResponse...), but only matches a request whose query params contain every entry in requiredQueryParams - for a path also serving other, non-paginated traffic that a bare MockRestServer.onPages(HTTPMethod, String, MockResponse...) route would otherwise intercept too.