software.amazon.awssdk.core.client.builder

Class SdkDefaultClientBuilder<B extends SdkClientBuilder<B,C>,C>

java.lang.Object

software.amazon.awssdk.core.client.builder.SdkDefaultClientBuilder<B,C>

Type Parameters:

B - The type of builder, for chaining.

C - The type of client generated by this builder.

All Implemented Interfaces:

SdkClientBuilder<B,C>, Buildable, SdkBuilder<B,C>

public abstract class SdkDefaultClientBuilder<B extends SdkClientBuilder<B,C>,C>
extends Object
implements SdkClientBuilder<B,C>

An SDK-internal implementation of the methods in SdkClientBuilder, SdkAsyncClientBuilder and SdkSyncClientBuilder. This implements all methods required by those interfaces, allowing service-specific builders to just implement the configuration they wish to add.

By implementing both the sync and async interface's methods, service-specific builders can share code between their sync and async variants without needing one to extend the other. Note: This only defines the methods in the sync and async builder interfaces. It does not implement the interfaces themselves. This is because the sync and async client builder interfaces both require a type-constrained parameter for use in fluent chaining, and a generic type parameter conflict is introduced into the class hierarchy by this interface extending the builder interfaces themselves.

Like all SdkClientBuilders, this class is not thread safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SdkDefaultClientBuilder.NonManagedSdkAsyncHttpClient Wrapper around SdkAsyncHttpClient to prevent it from being closed.
static class	SdkDefaultClientBuilder.NonManagedSdkHttpClient Wrapper around SdkHttpClient to prevent it from being closed.

Field Summary

Fields

Modifier and Type	Field and Description
protected SdkClientConfiguration.Builder	clientConfiguration
protected AttributeMap.Builder	clientContextParams

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SdkDefaultClientBuilder()
protected	SdkDefaultClientBuilder(SdkHttpClient.Builder defaultHttpClientBuilder, SdkAsyncHttpClient.Builder defaultAsyncHttpClientBuilder)

Method Summary

Modifier and Type	Method and Description
protected SdkClientConfiguration	asyncClientConfiguration() Return a client configuration object, populated with the following chain of priorities.
B	asyncConfiguration(ClientAsyncConfiguration asyncConfiguration)
C	build() Build a client using the current state of this builder.
protected abstract C	buildClient() Implemented by child classes to create a client using the provided immutable configuration objects.
protected AttributeMap	childHttpConfig() Deprecated. use childHttpConfig(SdkClientConfiguration) instead
protected AttributeMap	childHttpConfig(SdkClientConfiguration configuration) Optionally overridden by child implementations to provide implementation-specific default HTTP configuration.
B	endpointOverride(URI endpointOverride) Configure the endpoint with which the SDK should communicate.
protected SdkClientConfiguration	finalizeChildConfiguration(SdkClientConfiguration configuration) Optionally overridden by child implementations to derive implementation-specific configuration from the default-applied configuration.
B	httpClient(SdkAsyncHttpClient httpClient)
B	httpClient(SdkHttpClient httpClient)
B	httpClientBuilder(SdkAsyncHttpClient.Builder httpClientBuilder)
B	httpClientBuilder(SdkHttpClient.Builder httpClientBuilder)
protected SdkClientConfiguration	mergeChildDefaults(SdkClientConfiguration configuration) Optionally overridden by child implementations to apply implementation-specific default configuration.
B	metricPublishers(List<MetricPublisher> metricPublishers)
ClientOverrideConfiguration	overrideConfiguration() Retrieve the current override configuration.
B	overrideConfiguration(ClientOverrideConfiguration overrideConfig) Specify overrides to the default SDK configuration that should be used for clients created by this builder.
void	setAsyncConfiguration(ClientAsyncConfiguration asyncConfiguration)
void	setEndpointOverride(URI endpointOverride)
void	setOverrideConfiguration(ClientOverrideConfiguration overrideConfiguration)
protected SdkClientConfiguration	syncClientConfiguration() Return a client configuration object, populated with the following chain of priorities.
protected B	thisBuilder() Return "this" for method chaining.

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.client.builder.SdkClientBuilder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation

Field Detail

clientConfiguration

protected final SdkClientConfiguration.Builder clientConfiguration

clientContextParams

protected final AttributeMap.Builder clientContextParams

Constructor Detail

SdkDefaultClientBuilder

protected SdkDefaultClientBuilder()

SdkDefaultClientBuilder

protected SdkDefaultClientBuilder(SdkHttpClient.Builder defaultHttpClientBuilder,
                                  SdkAsyncHttpClient.Builder defaultAsyncHttpClientBuilder)

Method Detail

build

public final C build()

Build a client using the current state of this builder. This is marked final in order to allow this class to add standard "build" logic between all service clients. Service clients are expected to implement the buildClient() method, that accepts the immutable client configuration generated by this build method.

Specified by:

build in interface Buildable

Specified by:

build in interface SdkBuilder<B extends SdkClientBuilder<B,C>,C>

buildClient

protected abstract C buildClient()

Implemented by child classes to create a client using the provided immutable configuration objects. The async and sync configurations are not yet immutable. Child classes will need to make them immutable in order to validate them and pass them to the client's constructor.

Returns:

A client based on the provided configuration.

syncClientConfiguration

protected final SdkClientConfiguration syncClientConfiguration()

Return a client configuration object, populated with the following chain of priorities.

1. Client Configuration Overrides
2. Customer Configuration
3. Service-Specific Defaults
4. Global Defaults

asyncClientConfiguration

protected final SdkClientConfiguration asyncClientConfiguration()

Return a client configuration object, populated with the following chain of priorities.

1. Client Configuration Overrides
2. Customer Configuration
3. Implementation/Service-Specific Configuration
4. Global Default Configuration

mergeChildDefaults

protected SdkClientConfiguration mergeChildDefaults(SdkClientConfiguration configuration)

Optionally overridden by child implementations to apply implementation-specific default configuration. (eg. AWS's default credentials providers)

finalizeChildConfiguration

protected SdkClientConfiguration finalizeChildConfiguration(SdkClientConfiguration configuration)

Optionally overridden by child implementations to derive implementation-specific configuration from the default-applied configuration. (eg. AWS's endpoint, derived from the region).

childHttpConfig

protected AttributeMap childHttpConfig(SdkClientConfiguration configuration)

Optionally overridden by child implementations to provide implementation-specific default HTTP configuration.

childHttpConfig

@Deprecated
protected AttributeMap childHttpConfig()

Deprecated. use childHttpConfig(SdkClientConfiguration) instead

Optionally overridden by child implementations to provide implementation-specific default HTTP configuration.

endpointOverride

public final B endpointOverride(URI endpointOverride)

Description copied from interface: SdkClientBuilder

Configure the endpoint with which the SDK should communicate.

It is important to know that EndpointProviders and the endpoint override on the client are not mutually exclusive. In all existing cases, the endpoint override is passed as a parameter to the provider and the provider *may* modify it. For example, the S3 provider may add the bucket name as a prefix to the endpoint override for virtual bucket addressing.

Specified by:

endpointOverride in interface SdkClientBuilder<B extends SdkClientBuilder<B,C>,C>

setEndpointOverride

public final void setEndpointOverride(URI endpointOverride)

asyncConfiguration

public final B asyncConfiguration(ClientAsyncConfiguration asyncConfiguration)

setAsyncConfiguration

public final void setAsyncConfiguration(ClientAsyncConfiguration asyncConfiguration)

overrideConfiguration

public final B overrideConfiguration(ClientOverrideConfiguration overrideConfig)

Description copied from interface: SdkClientBuilder

Specify overrides to the default SDK configuration that should be used for clients created by this builder.

Specified by:

overrideConfiguration in interface SdkClientBuilder<B extends SdkClientBuilder<B,C>,C>

setOverrideConfiguration

public final void setOverrideConfiguration(ClientOverrideConfiguration overrideConfiguration)

overrideConfiguration

public final ClientOverrideConfiguration overrideConfiguration()

Description copied from interface: SdkClientBuilder

Retrieve the current override configuration. This allows further overrides across calls. Can be modified by first converting to a builder with ClientOverrideConfiguration.toBuilder().

Specified by:

overrideConfiguration in interface SdkClientBuilder<B extends SdkClientBuilder<B,C>,C>

Returns:

The existing override configuration for the builder.

httpClient

public final B httpClient(SdkHttpClient httpClient)

httpClientBuilder

public final B httpClientBuilder(SdkHttpClient.Builder httpClientBuilder)

httpClient

public final B httpClient(SdkAsyncHttpClient httpClient)

httpClientBuilder

public final B httpClientBuilder(SdkAsyncHttpClient.Builder httpClientBuilder)

metricPublishers

public final B metricPublishers(List<MetricPublisher> metricPublishers)

thisBuilder

protected B thisBuilder()

Return "this" for method chaining.