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.async;
17 
18 import java.nio.ByteBuffer;
19 import org.reactivestreams.Publisher;
20 import software.amazon.awssdk.annotations.SdkPublicApi;
21 import software.amazon.awssdk.http.SdkHttpResponse;
22 
23 /**
24  * Handles asynchronous HTTP responses.
25  */
26 @SdkPublicApi
27 public interface SdkAsyncHttpResponseHandler {
28     /**
29      * Called when the headers have been received.
30      *
31      * @param headers The headers.
32      */
onHeaders(SdkHttpResponse headers)33     void onHeaders(SdkHttpResponse headers);
34 
35     /**
36      * Called when the streaming body is ready.
37      * <p>
38      * This method is always called. If the response does not have a body, then the publisher will complete the subscription
39      * without signalling any elements.
40      *
41      * @param stream The streaming body.
42      */
onStream(Publisher<ByteBuffer> stream)43     void onStream(Publisher<ByteBuffer> stream);
44 
45     /**
46      * Called when there is an error making the request or receiving the response. If the error is encountered while
47      * streaming the body, then the error is also delivered to the {@link org.reactivestreams.Subscriber}.
48      *
49      * @param error The error.
50      */
onError(Throwable error)51     void onError(Throwable error);
52 
53 }
54