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.auth.spi.signer;
17 
18 import java.nio.ByteBuffer;
19 import org.reactivestreams.Publisher;
20 import software.amazon.awssdk.annotations.Immutable;
21 import software.amazon.awssdk.annotations.SdkPublicApi;
22 import software.amazon.awssdk.annotations.ThreadSafe;
23 import software.amazon.awssdk.http.auth.spi.internal.signer.DefaultAsyncSignedRequest;
24 import software.amazon.awssdk.utils.builder.CopyableBuilder;
25 import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
26 
27 /**
28  * Represents a request with async payload that has been signed by {@link HttpSigner}.
29  */
30 @SdkPublicApi
31 @Immutable
32 @ThreadSafe
33 public interface AsyncSignedRequest extends BaseSignedRequest<Publisher<ByteBuffer>>,
34                                             ToCopyableBuilder<AsyncSignedRequest.Builder, AsyncSignedRequest> {
35 
36     /**
37      * Get a new builder for creating a {@link AsyncSignedRequest}.
38      */
builder()39     static Builder builder() {
40         return DefaultAsyncSignedRequest.builder();
41     }
42 
43     /**
44      * A builder for a {@link AsyncSignedRequest}.
45      */
46     interface Builder extends BaseSignedRequest.Builder<Builder, Publisher<ByteBuffer>>,
47                               CopyableBuilder<AsyncSignedRequest.Builder, AsyncSignedRequest> {
48     }
49 }
50