Class ClientTestingAdapter
java.lang.Object
org.apache.hc.core5.testing.framework.ClientTestingAdapter
- Direct Known Subclasses:
ClassicTestClientTestingAdapter
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected ClientPOJOAdapter
This adapter will perform the HTTP request and return the response in the expected format.protected boolean
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionexecute
(String defaultURI, Map<String, Object> request, TestingFrameworkRequestHandler requestHandler, Map<String, Object> responseExpectations) See the documentation for the same method inClientPOJOAdapter
.Getter for theClientPOJOAdapter
that is actually used to make the HTTP request.boolean
isRequestSupported
(Map<String, Object> request) See the documentation for the same method inClientPOJOAdapter
.modifyRequest
(Map<String, Object> request) See the documentation for the same method inClientPOJOAdapter
.Generally a test's response expectations should not need to be modified, but if a particular HTTP client (such as Groovy's RESTClient which uses HttpClient) needs to modify the response expectations, it should do so here.
-
Field Details
-
adapter
This adapter will perform the HTTP request and return the response in the expected format. -
callAssertNothingThrown
protected boolean callAssertNothingThrown
-
-
Constructor Details
-
ClientTestingAdapter
public ClientTestingAdapter() -
ClientTestingAdapter
-
-
Method Details
-
execute
public Map<String,Object> execute(String defaultURI, Map<String, Object> request, TestingFrameworkRequestHandler requestHandler, Map<String, throws TestingFrameworkExceptionObject> responseExpectations) See the documentation for the same method inClientPOJOAdapter
. This method will typically call it. However, this method also has access to the test's response expectations if that is needed for some reason. Furthermore, this method also has access to theTestingFrameworkRequestHandler
so it can optionally call assertNothingThrown() before checking the response further. It is optional because the test framework will call it later.- Parameters:
defaultURI
- See execute method ofClientPOJOAdapter
.request
- See execute method ofClientPOJOAdapter
.requestHandler
- The request handler that checks the received HTTP request with the request that was intended. If there is a mismatch of expectations, then the requestHandler will throw an exception. If this execute method does not want to make further checks of the response in the case the responseHandler threw, then the assertNothingThrown() method should be called before doing further checks.responseExpectations
- The response expectations of the test.- Returns:
- See return of the execute method of
ClientPOJOAdapter
. - Throws:
TestingFrameworkException
- in the case of a problem.
-
isRequestSupported
See the documentation for the same method inClientPOJOAdapter
. -
modifyRequest
See the documentation for the same method inClientPOJOAdapter
. -
modifyResponseExpectations
public Map<String,Object> modifyResponseExpectations(Map<String, Object> request, Map<String, Object> responseExpectations) Generally a test's response expectations should not need to be modified, but if a particular HTTP client (such as Groovy's RESTClient which uses HttpClient) needs to modify the response expectations, it should do so here. After this method returns, theTestingFrameworkRequestHandler
is sent the expectations so the request handler will return a response that matches the expectations. When the HTTP response is obtained, the received response is matched against the expectations.- Parameters:
request
- for the format, see the documentation forClientPOJOAdapter
.responseExpectations
- for the format, see the documentation forClientPOJOAdapter
.- Returns:
- the same or modified response expectations.
-
getClientPOJOAdapter
Getter for theClientPOJOAdapter
that is actually used to make the HTTP request.- Returns:
- the
ClientPOJOAdapter
.
-