com.ibm.cos.v2.services.s3.internal.handlers

Class EnableTrailingChecksumInterceptor

java.lang.Object

com.ibm.cos.v2.services.s3.internal.handlers.EnableTrailingChecksumInterceptor

All Implemented Interfaces:

ExecutionInterceptor

public final class EnableTrailingChecksumInterceptor
extends Object
implements ExecutionInterceptor

Constructor Summary

Constructors

Constructor and Description
EnableTrailingChecksumInterceptor()

Method Summary

Modifier and Type	Method and Description
SdkHttpRequest	modifyHttpRequest(Context.ModifyHttpRequest context, ExecutionAttributes executionAttributes) Append trailing checksum header for GetObjectRequest if trailing checksum is enabled from config, ChecksumMode is disabled, and is not S3Express.
SdkRequest	modifyRequest(Context.ModifyRequest context, ExecutionAttributes executionAttributes) Enable ChecksumMode for GetObjectRequest if trailing checksum is enabled from config, ChecksumMode is disabled, and is S3Express.
SdkResponse	modifyResponse(Context.ModifyResponse context, ExecutionAttributes executionAttributes) Subtract the contentLength of GetObjectResponse if trailing checksums is enabled.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.cos.v2.core.interceptor.ExecutionInterceptor

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

Constructor Detail

EnableTrailingChecksumInterceptor

public EnableTrailingChecksumInterceptor()

Method Detail

modifyRequest

public SdkRequest modifyRequest(Context.ModifyRequest context,
                                ExecutionAttributes executionAttributes)

Enable ChecksumMode for GetObjectRequest if trailing checksum is enabled from config, ChecksumMode is disabled, and is S3Express. TODO (s3express) - refactor to migrate out s3express specific code

Specified by:

modifyRequest in interface ExecutionInterceptor

Parameters:

context - The current state of the execution, including the current SDK request from the service client call.

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 request that should be used for the rest of the execution. Must not be null.

modifyHttpRequest

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

Append trailing checksum header for GetObjectRequest if trailing checksum is enabled from config, ChecksumMode is disabled, and is not S3Express.

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.

modifyResponse

public SdkResponse modifyResponse(Context.ModifyResponse context,
                                  ExecutionAttributes executionAttributes)

Subtract the contentLength of GetObjectResponse if trailing checksums is enabled.

Specified by:

modifyResponse in interface ExecutionInterceptor

Parameters:

context - The current state of the execution, including the SDK and HTTP requests as well as the SDK and HTTP response.

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 SDK response that should be returned by the client. Must not be null.