software.amazon.awssdk.core.internal.interceptor

Class HttpChecksumInHeaderInterceptor

java.lang.Object

software.amazon.awssdk.core.internal.interceptor.HttpChecksumInHeaderInterceptor

All Implemented Interfaces:

ExecutionInterceptor

public class HttpChecksumInHeaderInterceptor
extends Object
implements ExecutionInterceptor

Implements the "HttpChecksum" C2J trait for a request. HttpChecksum is added in the header only in following cases

1. non streaming payload and Unsigned Payload
2. non streaming payload and Header-based Signing auth
3. streaming payload and Header-based Signing auth

This interceptor will inject the Http checksum only for case 1 as above i.e. for unsigned payloads. For the other two cases the http checksum will be injected by the signers

Constructor Summary

Constructors

Constructor and Description
HttpChecksumInHeaderInterceptor()

Method Summary

Modifier and Type	Method and Description
SdkHttpRequest	modifyHttpRequest(Context.ModifyHttpRequest context, ExecutionAttributes executionAttributes) Calculates the checksum of the provided request (and base64 encodes it), and adds the header to the request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.core.interceptor.ExecutionInterceptor

afterExecution, afterMarshalling, afterTransmission, afterUnmarshalling, beforeExecution, beforeMarshalling, beforeTransmission, beforeUnmarshalling, modifyAsyncHttpContent, modifyAsyncHttpResponseContent, modifyException, modifyHttpContent, modifyHttpResponse, modifyHttpResponseContent, modifyRequest, modifyResponse, onExecutionFailure

Constructor Detail

HttpChecksumInHeaderInterceptor

public HttpChecksumInHeaderInterceptor()

Method Detail

modifyHttpRequest

public SdkHttpRequest modifyHttpRequest(Context.ModifyHttpRequest context,
                                        ExecutionAttributes executionAttributes)

Calculates the checksum of the provided request (and base64 encodes it), and adds the header to the request.

Note: This assumes that the content stream provider can create multiple new streams. If it only supports one (e.g. with an input stream that doesn't support mark/reset), we could consider buffering the content in memory here and updating the request body to use that buffered content. We obviously don't want to do that for giant streams, so we haven't opted to do that yet.

Specified by:

modifyHttpRequest in interface ExecutionInterceptor

Parameters:

context - The current state of the execution, including the SDK and current HTTP request.

executionAttributes - A mutable set of attributes scoped to one specific request/response cycle that can be used to give data to future lifecycle methods.

Returns:

The potentially-modified HTTP request that should be sent to the service. Must not be null.