Class MockAsyncHttpClient

java.lang.Object

software.amazon.awssdk.testutils.service.http.MockAsyncHttpClient

All Implemented Interfaces:

AutoCloseable, SdkAsyncHttpClient, MockHttpClient, SdkAutoCloseable

public final class MockAsyncHttpClient
extends Object
implements SdkAsyncHttpClient, MockHttpClient

Mock implementation of SdkAsyncHttpClient.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awssdk.http.async.SdkAsyncHttpClient

SdkAsyncHttpClient.Builder<T extends SdkAsyncHttpClient.Builder<T>>

Constructor Summary

Constructors

Constructor	Description
MockAsyncHttpClient()

Method Summary

Modifier and Type	Method	Description
void	close()
CompletableFuture<Void>	execute(AsyncExecuteRequest request)	Execute the request.
SdkHttpRequest	getLastRequest()	Get the last request called on the mock.
List<SdkHttpRequest>	getRequests()	Get all requests called on the mock.
Optional<byte[]>	getStreamingPayload()	Returns the streaming payload byte array, if the asyncRequestBodyLength was set correctly.
void	reset()	Resets this mock by clearing any captured requests and wiping any stubbed responses.
void	setAsyncRequestBodyLength(int asyncRequestBodyLength)	Enable capturing the streaming payload by setting the length of the AsyncRequestBody.
void	stubNextResponse(HttpExecuteResponse nextResponse)	Sets up the next HTTP response that will be returned by the mock.
void	stubNextResponse(HttpExecuteResponse nextResponse, Duration delay)	Sets up the next HTTP response that will be returned by the mock with a delay.
void	stubResponses(HttpExecuteResponse... responses)	Sets the next set of HTTP responses that will be returned by the mock.
void	stubResponses(Pair<HttpExecuteResponse,Duration>... responses)

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.testutils.service.http.MockHttpClient

stubNextResponse200

Methods inherited from interface software.amazon.awssdk.http.async.SdkAsyncHttpClient

clientName

Constructor Details

MockAsyncHttpClient

public MockAsyncHttpClient()

Method Details

execute

public CompletableFuture<Void> execute(AsyncExecuteRequest request)

Description copied from interface: SdkAsyncHttpClient

Execute the request.

Specified by:

execute in interface SdkAsyncHttpClient

Parameters:

request - The request object.

Returns:

The future holding the result of the request execution. Upon success execution of the request, the future is completed with null, otherwise it is completed exceptionally.

close

public void close()

Description copied from interface: SdkAutoCloseable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SdkAutoCloseable

reset

public void reset()

Description copied from interface: MockHttpClient

Resets this mock by clearing any captured requests and wiping any stubbed responses.

Specified by:

reset in interface MockHttpClient

getRequests

public List<SdkHttpRequest> getRequests()

Description copied from interface: MockHttpClient

Get all requests called on the mock.

Specified by:

getRequests in interface MockHttpClient

getLastRequest

public SdkHttpRequest getLastRequest()

Description copied from interface: MockHttpClient

Get the last request called on the mock.

Specified by:

getLastRequest in interface MockHttpClient

stubNextResponse

public void stubNextResponse(HttpExecuteResponse nextResponse)

Description copied from interface: MockHttpClient

Sets up the next HTTP response that will be returned by the mock. Removes responses previously added to the mock.

Specified by:

stubNextResponse in interface MockHttpClient

stubNextResponse

public void stubNextResponse(HttpExecuteResponse nextResponse,
 Duration delay)

Description copied from interface: MockHttpClient

Sets up the next HTTP response that will be returned by the mock with a delay. Removes responses previously added to the mock.

Specified by:

stubNextResponse in interface MockHttpClient

stubResponses

public void stubResponses(Pair<HttpExecuteResponse,Duration>... responses)

Specified by:

stubResponses in interface MockHttpClient

stubResponses

public void stubResponses(HttpExecuteResponse... responses)

Description copied from interface: MockHttpClient

Sets the next set of HTTP responses that will be returned by the mock. Removes responses previously added to the mock.

Specified by:

stubResponses in interface MockHttpClient

setAsyncRequestBodyLength

public void setAsyncRequestBodyLength(int asyncRequestBodyLength)

Enable capturing the streaming payload by setting the length of the AsyncRequestBody.

getStreamingPayload

public Optional<byte[]> getStreamingPayload()

Returns the streaming payload byte array, if the asyncRequestBodyLength was set correctly. Otherwise, returns empty Optional.