software.amazon.awssdk.http.auth.aws.signer

Interface AwsV4FamilyHttpSigner<T extends Identity>

All Superinterfaces:

HttpSigner<T>

All Known Subinterfaces:

AwsV4aHttpSigner, AwsV4HttpSigner

All Known Implementing Classes:

DefaultAwsCrtV4aHttpSigner, DefaultAwsV4HttpSigner

public interface AwsV4FamilyHttpSigner<T extends Identity>
extends HttpSigner<T>

An interface shared by AwsV4HttpSigner and AwsV4aHttpSigner for defining signer properties that are common across both signers.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AwsV4FamilyHttpSigner.AuthLocation This enum represents where auth-related data is inserted, as a result of signing.

Field Summary

Fields

Modifier and Type	Field and Description
static SignerProperty<AwsV4FamilyHttpSigner.AuthLocation>	AUTH_LOCATION The location where auth-related data is inserted, as a result of signing.
static SignerProperty<ChecksumAlgorithm>	CHECKSUM_ALGORITHM The algorithm to use for calculating a "flexible" checksum.
static SignerProperty<Boolean>	CHUNK_ENCODING_ENABLED Whether to indicate that a payload is chunk-encoded or not.
static SignerProperty<Boolean>	DOUBLE_URL_ENCODE A boolean to indicate whether to double url-encode the resource path when constructing the canonical request.
static SignerProperty<Duration>	EXPIRATION_DURATION The duration for the request to be valid.
static SignerProperty<Boolean>	NORMALIZE_PATH A boolean to indicate whether the resource path should be "normalized" according to RFC3986 when constructing the canonical request.
static SignerProperty<Boolean>	PAYLOAD_SIGNING_ENABLED Whether to indicate that a payload is signed or not.
static SignerProperty<String>	SERVICE_SIGNING_NAME The name of the AWS service.

Fields inherited from interface software.amazon.awssdk.http.auth.spi.signer.HttpSigner

SIGNING_CLOCK

Method Summary

Methods inherited from interface software.amazon.awssdk.http.auth.spi.signer.HttpSigner

sign, sign, signAsync, signAsync

Field Detail

SERVICE_SIGNING_NAME

static final SignerProperty<String> SERVICE_SIGNING_NAME

The name of the AWS service. This property is required.

DOUBLE_URL_ENCODE

static final SignerProperty<Boolean> DOUBLE_URL_ENCODE

A boolean to indicate whether to double url-encode the resource path when constructing the canonical request. This property defaults to true.

NORMALIZE_PATH

static final SignerProperty<Boolean> NORMALIZE_PATH

A boolean to indicate whether the resource path should be "normalized" according to RFC3986 when constructing the canonical request. This property defaults to true.

AUTH_LOCATION

static final SignerProperty<AwsV4FamilyHttpSigner.AuthLocation> AUTH_LOCATION

The location where auth-related data is inserted, as a result of signing. This property defaults to HEADER.

EXPIRATION_DURATION

static final SignerProperty<Duration> EXPIRATION_DURATION

The duration for the request to be valid. This property defaults to null. This can be set to presign the request for later use. The maximum allowed value for this property is 7 days. This is only supported when AuthLocation=QUERY.

PAYLOAD_SIGNING_ENABLED

static final SignerProperty<Boolean> PAYLOAD_SIGNING_ENABLED

Whether to indicate that a payload is signed or not. This property defaults to true. This can be set false to disable payload signing.

CHUNK_ENCODING_ENABLED

static final SignerProperty<Boolean> CHUNK_ENCODING_ENABLED

Whether to indicate that a payload is chunk-encoded or not. This property defaults to false. This can be set true to enable the `aws-chunk` content-encoding

CHECKSUM_ALGORITHM

static final SignerProperty<ChecksumAlgorithm> CHECKSUM_ALGORITHM

The algorithm to use for calculating a "flexible" checksum. This property is optional.