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

Class S3OverrideAuthSchemePropertiesPlugin

java.lang.Object

com.ibm.cos.v2.services.s3.internal.plugins.S3OverrideAuthSchemePropertiesPlugin

All Implemented Interfaces:

SdkPlugin, SdkAutoCloseable, AutoCloseable

public final class S3OverrideAuthSchemePropertiesPlugin
extends Object
implements SdkPlugin

Plugin that allows override of signer and identity properties on the selected auth scheme options. The class offers static methods to create plugins for common cases such as enable payload signing by default. For instance, if you want to unconditionally enable payload signing across the board you can create the S3 client, e.g., The plugin can also be used for a particular request, e.g.,

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	S3OverrideAuthSchemePropertiesPlugin.Builder

Method Summary

Modifier and Type	Method and Description
static S3OverrideAuthSchemePropertiesPlugin.Builder	builder() Creates a new builder to configure the plugin.
void	configureClient(SdkServiceClientConfiguration.Builder config) Modify the provided client configuration.
static SdkPlugin	disableChunkEncodingPlugin() Creates a new plugin that disables the ChunkEncoding signers property for the `UploadPart` and `PutObject` operations.
static SdkPlugin	enablePayloadSigningPlugin() Creates a new plugin that enables payload signing.

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.SdkPlugin

close

Method Detail

configureClient

public void configureClient(SdkServiceClientConfiguration.Builder config)

Description copied from interface: SdkPlugin

Modify the provided client configuration.

Specified by:

configureClient in interface SdkPlugin

enablePayloadSigningPlugin

public static SdkPlugin enablePayloadSigningPlugin()

Creates a new plugin that enables payload signing. This plugin can be used per client or by per-request.

disableChunkEncodingPlugin

public static SdkPlugin disableChunkEncodingPlugin()

Creates a new plugin that disables the ChunkEncoding signers property for the `UploadPart` and `PutObject` operations. This plugin can be used per client or by per-request.

builder

public static S3OverrideAuthSchemePropertiesPlugin.Builder builder()

Creates a new builder to configure the plugin.