software.amazon.awssdk.http.nio.netty

Class NettySdkHttpClientFactory

java.lang.Object

software.amazon.awssdk.http.nio.netty.NettySdkHttpClientFactory

All Implemented Interfaces:

SdkAsyncHttpClientFactory, ToCopyableBuilder<NettySdkHttpClientFactory.Builder,NettySdkHttpClientFactory>

@Immutable
public final class NettySdkHttpClientFactory
extends Object
implements SdkAsyncHttpClientFactory, ToCopyableBuilder<NettySdkHttpClientFactory.Builder,NettySdkHttpClientFactory>

Factory that allows more advanced configuration of the Netty NIO HTTP implementation. Use builder() to configure and construct an immutable instance of the factory.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NettySdkHttpClientFactory.Builder Builder interface for NettySdkHttpClientFactory.

Method Summary

Modifier and Type	Method and Description
static NettySdkHttpClientFactory.Builder	builder()
Optional<Duration>	connectionAcquisitionTimeout()
Optional<Duration>	connectionTimeout()
SdkAsyncHttpClient	createHttpClient() Create an HTTP client instance with global defaults applied.
SdkAsyncHttpClient	createHttpClientWithDefaults(AttributeMap serviceDefaults) Create an SdkAsyncHttpClient with service specific defaults applied.
EventLoopGroupConfiguration	eventLoopGroupConfiguration()
Optional<Integer>	maxConnectionsPerEndpoint()
Optional<Integer>	maxPendingAcquires()
Optional<Duration>	readTimeout()
NettySdkHttpClientFactory.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Optional<Boolean>	trustAllCertificates()
Optional<Duration>	writeTimeout()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

maxConnectionsPerEndpoint

public Optional<Integer> maxConnectionsPerEndpoint()

Returns:

Optional of the maxConnectionsPerEndpoint setting.

See Also:

NettySdkHttpClientFactory.Builder.maxConnectionsPerEndpoint(Integer)

maxPendingAcquires

public Optional<Integer> maxPendingAcquires()

Returns:

Optional of the maxPendingAcquires setting.

See Also:

NettySdkHttpClientFactory.Builder.maxPendingAcquires(Integer)

writeTimeout

public Optional<Duration> writeTimeout()

Returns:

Optional of the writeTimeout setting.

See Also:

NettySdkHttpClientFactory.Builder.writeTimeout(Duration)

readTimeout

public Optional<Duration> readTimeout()

Returns:

Optional of the readTimeout setting.

See Also:

NettySdkHttpClientFactory.Builder.readTimeout(Duration)

connectionTimeout

public Optional<Duration> connectionTimeout()

Returns:

Optional of the connectionTimeout setting.

See Also:

NettySdkHttpClientFactory.Builder.connectionTimeout(Duration)

connectionAcquisitionTimeout

public Optional<Duration> connectionAcquisitionTimeout()

Returns:

Optional of the connectionAcquisitionTimeout setting.

See Also:

NettySdkHttpClientFactory.Builder.connectionTimeout(Duration)

trustAllCertificates

public Optional<Boolean> trustAllCertificates()

Returns:

Optional of the trustAllCertificates setting.

See Also:

NettySdkHttpClientFactory.Builder.trustAllCertificates(Boolean)

eventLoopGroupConfiguration

public EventLoopGroupConfiguration eventLoopGroupConfiguration()

Returns:

The current EventLoopGroupConfiguration which is a container for either an EventLoopGroup or an DefaultEventLoopGroupFactory.

See Also:

NettySdkHttpClientFactory.Builder.eventLoopGroupConfiguration(EventLoopGroupConfiguration)

createHttpClient

public SdkAsyncHttpClient createHttpClient()

Create an HTTP client instance with global defaults applied. This client instance can be shared across multiple SDK clients for better resource utilization. Note that if sharing is not needed then it is recommended to pass this factory into the SDK client builders so that service defaults may be applied.

Returns:

Created client.

createHttpClientWithDefaults

public SdkAsyncHttpClient createHttpClientWithDefaults(AttributeMap serviceDefaults)

Description copied from interface: SdkAsyncHttpClientFactory

Create an SdkAsyncHttpClient with service specific defaults applied. Applying service defaults is optional and some options may not be supported by a particular implementation.

Specified by:

createHttpClientWithDefaults in interface SdkAsyncHttpClientFactory

Parameters:

serviceDefaults - Service specific defaults. Keys will be one of the constants defined in SdkHttpConfigurationOption.

Returns:

Created client

toBuilder

public NettySdkHttpClientFactory.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<NettySdkHttpClientFactory.Builder,NettySdkHttpClientFactory>

Returns:

a builder for type T

builder

public static NettySdkHttpClientFactory.Builder builder()

Returns:

A NettySdkHttpClientFactory.Builder for creating an immutable NettySdkHttpClientFactory.

toString

public String toString()

Overrides:

toString in class Object