Class UrlConnectionHttpClient

java.lang.Object

software.amazon.awssdk.http.urlconnection.UrlConnectionHttpClient

All Implemented Interfaces:

AutoCloseable, SdkHttpClient, SdkAutoCloseable

public final class UrlConnectionHttpClient
extends Object
implements SdkHttpClient

An implementation of SdkHttpClient that uses HttpURLConnection to communicate with the service. This is the leanest synchronous client that optimizes for minimum dependencies and startup latency in exchange for having less functionality than other implementations.

See software.amazon.awssdk.http.apache.ApacheHttpClient for an alternative implementation.

This can be created via builder()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UrlConnectionHttpClient.Builder	A builder for an instance of SdkHttpClient that uses JDKs build-in URLConnection HTTP implementation.

Method Summary

Modifier and Type	Method	Description
static UrlConnectionHttpClient.Builder	builder()
String	clientName()	Each HTTP client implementation should return a well-formed client name that allows requests to be identifiable back to the client that made the request.
void	close()
static SdkHttpClient	create()	Create a HttpURLConnection client with the default properties
static SdkHttpClient	create(UrlConnectionFactory connectionFactory)	Use this method if you want to control the way a HttpURLConnection is created.
ExecutableHttpRequest	prepareRequest(HttpExecuteRequest request)	Create a ExecutableHttpRequest that can be used to execute the HTTP request.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static UrlConnectionHttpClient.Builder builder()

create

public static SdkHttpClient create()

Create a HttpURLConnection client with the default properties

Returns:

an UrlConnectionHttpClient

create

public static SdkHttpClient create(UrlConnectionFactory connectionFactory)

Use this method if you want to control the way a HttpURLConnection is created. This will ignore SDK defaults like SdkHttpConfigurationOption.CONNECTION_TIMEOUT and SdkHttpConfigurationOption.READ_TIMEOUT

Parameters:

connectionFactory - a function that, given a URI will create an HttpURLConnection

Returns:

an UrlConnectionHttpClient

prepareRequest

public ExecutableHttpRequest prepareRequest(HttpExecuteRequest request)

Description copied from interface: SdkHttpClient

Create a ExecutableHttpRequest that can be used to execute the HTTP request.

Specified by:

prepareRequest in interface SdkHttpClient

Parameters:

request - Representation of an HTTP request.

Returns:

Task that can execute an HTTP request and can be aborted.

close

public void close()

Description copied from interface: SdkAutoCloseable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SdkAutoCloseable

clientName

public String clientName()

Description copied from interface: SdkHttpClient

Each HTTP client implementation should return a well-formed client name that allows requests to be identifiable back to the client that made the request. The client name should include the backing implementation as well as the Sync or Async to identify the transmission type of the request. Client names should only include alphanumeric characters. Examples of well formed client names include, ApacheSync, for requests using Apache's synchronous http client or NettyNioAsync for Netty's asynchronous http client.

Specified by:

clientName in interface SdkHttpClient

Returns:

String containing the name of the client