com.ibm.cos.v2.core.client.builder

Class SdkDefaultClientBuilder.NonManagedSdkHttpClient

java.lang.Object

com.ibm.cos.v2.core.client.builder.SdkDefaultClientBuilder.NonManagedSdkHttpClient

All Implemented Interfaces:

SdkHttpClient, SdkAutoCloseable, AutoCloseable

Enclosing class:

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

public static final class SdkDefaultClientBuilder.NonManagedSdkHttpClient
extends Object
implements SdkHttpClient

Wrapper around SdkHttpClient to prevent it from being closed. Used when the customer provides an already built client in which case they are responsible for the lifecycle of it.

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.cos.v2.http.SdkHttpClient

SdkHttpClient.Builder<T extends SdkHttpClient.Builder<T>>

Method Summary

Modifier and Type	Method and Description
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()
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

Method Detail

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