com.ibm.cos.v2.http.apache

Class ApacheHttpClient

java.lang.Object

com.ibm.cos.v2.http.apache.ApacheHttpClient

All Implemented Interfaces:

SdkHttpClient, SdkAutoCloseable, AutoCloseable

public final class ApacheHttpClient
extends Object
implements SdkHttpClient

An implementation of SdkHttpClient that uses Apache HTTP client to communicate with the service. This is the most powerful synchronous client that adds an extra dependency and additional startup latency in exchange for more functionality, like support for HTTP proxies.

See com.ibm.cos.v2.http.urlconnection.UrlConnectionHttpClient for an alternative implementation.

This can be created via builder()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ApacheHttpClient.Builder Builder for creating an instance of SdkHttpClient.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_NAME

Method Summary

Modifier and Type	Method and Description
static ApacheHttpClient.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 ApacheHttpClient with the default properties
ExecutableHttpRequest	prepareRequest(HttpExecuteRequest request) Create a ExecutableHttpRequest that can be used to execute the HTTP request.

Methods inherited from class java.lang.Object

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

Field Detail

CLIENT_NAME

public static final String CLIENT_NAME

See Also:

Constant Field Values

Method Detail

builder

public static ApacheHttpClient.Builder builder()

create

public static SdkHttpClient create()

Create a ApacheHttpClient with the default properties

Returns:

an ApacheHttpClient

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 SdkAutoCloseable

Specified by:

close in interface AutoCloseable

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