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