software.amazon.awssdk.core.internal.interceptor

Class HttpChecksumRequiredInterceptor

java.lang.Object

software.amazon.awssdk.core.internal.interceptor.HttpChecksumRequiredInterceptor

All Implemented Interfaces:

ExecutionInterceptor

public class HttpChecksumRequiredInterceptor
extends Object
implements ExecutionInterceptor

Implements the "httpChecksumRequired" C2J trait. Operations with that trait applied will automatically include a "Content-MD5" header, containing a checksum of the payload.

This is NOT supported for asynchronous HTTP content, which is currently only used for streaming upload operations. If such operations are added in the future, we'll have to find a way to support them in a non-blocking manner. That will likely require interface changes of some sort, because it's not currently possible to do a non-blocking update to request headers.

Constructor Summary

Constructors

Constructor and Description
HttpChecksumRequiredInterceptor()

Method Summary

Modifier and Type	Method and Description
SdkHttpRequest	modifyHttpRequest(Context.ModifyHttpRequest context, ExecutionAttributes executionAttributes) Calculates the MD5 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

HttpChecksumRequiredInterceptor

public HttpChecksumRequiredInterceptor()

Method Detail

modifyHttpRequest

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

Calculates the MD5 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.