1 /*
2  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License").
5  * You may not use this file except in compliance with the License.
6  * A copy of the License is located at
7  *
8  *  http://aws.amazon.com/apache2.0
9  *
10  * or in the "license" file accompanying this file. This file is distributed
11  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12  * express or implied. See the License for the specific language governing
13  * permissions and limitations under the License.
14  */
15 
16 package software.amazon.awssdk.http;
17 
18 import java.io.InputStream;
19 import software.amazon.awssdk.annotations.SdkPublicApi;
20 
21 /**
22  * Provides the content stream of a request.
23  * <p>
24  * Each call to to the {@link #newStream()} method must result in a stream whose position is at the beginning of the content.
25  * Implementations may return a new stream or the same stream for each call. If returning a new stream, the implementation
26  * must ensure to {@code close()} and free any resources acquired by the previous stream. The last stream returned by {@link
27  * #newStream()}} will be closed by the SDK.
28  *
29  */
30 @SdkPublicApi
31 @FunctionalInterface
32 public interface ContentStreamProvider {
33     /**
34      * @return The content stream.
35      */
newStream()36     InputStream newStream();
37 }
38