software.amazon.awssdk.testutils.service.http.MockHttpClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of service-test-utils Show documentation

The AWS SDK for Java - Service Test Utils module holds utilities used by service tests that may have dependencies on the core runtime.

There is a newer version: 2.30.1

Show newest version

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

package software.amazon.awssdk.testutils.service.http;

import java.time.Duration;
import java.util.List;
import software.amazon.awssdk.http.HttpExecuteResponse;
import software.amazon.awssdk.http.SdkHttpRequest;
import software.amazon.awssdk.utils.Pair;

public interface MockHttpClient {
    /**
     * Resets this mock by clearing any captured requests and wiping any stubbed responses.
     */
    void reset();

    /**
     * Sets up the next HTTP response that will be returned by the mock. Removes responses previously added to the mock.
     */
    void stubNextResponse(HttpExecuteResponse nextResponse);

    /**
     * Sets up the next HTTP response that will be returned by the mock with a delay. Removes responses previously added to the
     * mock.
     */
    void stubNextResponse(HttpExecuteResponse nextResponse, Duration delay);

    void stubResponses(Pair... responses);

    /**
     * Sets the next set of HTTP responses that will be returned by the mock. Removes responses previously added to the mock.
     */
    void stubResponses(HttpExecuteResponse... responses);

    /**
     * Get the last request called on the mock.
     */
    SdkHttpRequest getLastRequest();

    /**
     * Get all requests called on the mock.
     */
    List getRequests();

}