Interface V4PayloadSigner

All Known Implementing Classes:

AwsChunkedV4PayloadSigner, DefaultV4PayloadSigner, EventStreamV4PayloadSigner

@SdkInternalApi
public interface V4PayloadSigner

An interface for defining how to sign a payload via SigV4.

Method Summary

Modifier and Type	Method	Description
default void	beforeSigning(SdkHttpRequest.Builder request, ContentStreamProvider payload)	Modify a request before it is signed, such as changing headers or query-parameters.
default CompletableFuture<Pair<SdkHttpRequest.Builder,Optional<org.reactivestreams.Publisher<ByteBuffer>>>>	beforeSigningAsync(SdkHttpRequest.Builder request, org.reactivestreams.Publisher<ByteBuffer> payload)
static V4PayloadSigner	create()	Get a default implementation of a SigV4 payload signer.
ContentStreamProvider	sign(ContentStreamProvider payload, V4RequestSigningResult requestSigningResult)	Given a payload and result of request signing, sign the payload via the SigV4 process.
org.reactivestreams.Publisher<ByteBuffer>	signAsync(org.reactivestreams.Publisher<ByteBuffer> payload, V4RequestSigningResult requestSigningResult)	Given a payload and result of request signing, sign the payload via the SigV4 process.

Method Details

create

static V4PayloadSigner create()

Get a default implementation of a SigV4 payload signer.

sign

ContentStreamProvider sign(ContentStreamProvider payload,
 V4RequestSigningResult requestSigningResult)

Given a payload and result of request signing, sign the payload via the SigV4 process.

signAsync

org.reactivestreams.Publisher<ByteBuffer> signAsync(org.reactivestreams.Publisher<ByteBuffer> payload,
 V4RequestSigningResult requestSigningResult)

Given a payload and result of request signing, sign the payload via the SigV4 process.

beforeSigning

default void beforeSigning(SdkHttpRequest.Builder request,
 ContentStreamProvider payload)

Modify a request before it is signed, such as changing headers or query-parameters.

beforeSigningAsync

default CompletableFuture<Pair<SdkHttpRequest.Builder,Optional<org.reactivestreams.Publisher<ByteBuffer>>>> beforeSigningAsync(SdkHttpRequest.Builder request,
 org.reactivestreams.Publisher<ByteBuffer> payload)