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

Packages that use MockRestServer

Package	Description
com.shri.restinpeace.mock

Uses of MockRestServer in com.shri.restinpeace.mock

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

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 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 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 enqueueFor(HTTPMethod, String, MockResponse), for a route registered via on(HTTPMethod, String, Map, MockResponse) with the same requiredQueryParams.
MockRestServer	MockRestServerExtension.getServer()	Returns the server for the current test class - only meaningful once beforeAll has run.
MockRestServer	MockRestServer.on(HTTPMethod httpMethod, String pathTemplate, MockResponse response)	Registers a response for every request matching httpMethod and pathTemplate - unlike 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 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 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 on(HTTPMethod, String, MockResponse) with successResponse and then 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 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 onPages(HTTPMethod, String, MockResponse...) route would otherwise intercept too.
MockRestServer	MockRestServer.reset()	Clears every queued response, registered route, and recorded request, so the same server can be reused across multiple tests instead of paying to start a new one for each - e.g. from a @BeforeEach method, with the server itself started once in a @BeforeAll.
static MockRestServer	MockRestServer.start()	Starts a new server on an OS-assigned loopback port.