software.amazon.awssdk.http.auth.spi.signer.SignRequest Maven / Gradle / Ivy

Go to download
/*
 * 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.http.auth.spi.signer;

import software.amazon.awssdk.annotations.Immutable;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.http.ContentStreamProvider;
import software.amazon.awssdk.http.auth.spi.internal.signer.DefaultSignRequest;
import software.amazon.awssdk.identity.spi.Identity;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;

/**
 * Input parameters to sign a request with sync payload, using {@link HttpSigner}.
 *
 * @param  The type of the identity.
 */
@SdkPublicApi
@Immutable
@ThreadSafe
public interface SignRequest
    extends BaseSignRequest,
            ToCopyableBuilder, SignRequest> {

    /**
     * Get a new builder for creating a {@link SignRequest}.
     */
    static  Builder builder(IdentityT identity) {
        return DefaultSignRequest.builder(identity);
    }

    /**
     * A builder for a {@link SignRequest}.
     */
    interface Builder
        extends BaseSignRequest.Builder, ContentStreamProvider, IdentityT>,
            CopyableBuilder, SignRequest> {
    }
}