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

Class SdkDefaultClientBuilder.NonManagedSdkAsyncHttpClient

java.lang.Object

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

All Implemented Interfaces:

SdkAsyncHttpClient, SdkAutoCloseable, AutoCloseable

Enclosing class:

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

public static final class SdkDefaultClientBuilder.NonManagedSdkAsyncHttpClient
extends Object
implements SdkAsyncHttpClient

Wrapper around SdkAsyncHttpClient 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.async.SdkAsyncHttpClient

SdkAsyncHttpClient.Builder<T extends SdkAsyncHttpClient.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()
CompletableFuture<Void>	execute(AsyncExecuteRequest request) Execute the request.

Methods inherited from class java.lang.Object

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

Method Detail

execute

public CompletableFuture<Void> execute(AsyncExecuteRequest request)

Description copied from interface: SdkAsyncHttpClient

Execute the request.

Specified by:

execute in interface SdkAsyncHttpClient

Parameters:

request - The request object.

Returns:

The future holding the result of the request execution. Upon success execution of the request, the future is completed with null, otherwise it is completed exceptionally.

clientName

public String clientName()

Description copied from interface: SdkAsyncHttpClient

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, Apache, for requests using Apache's http client or NettyNio for Netty's http client.

Specified by:

clientName in interface SdkAsyncHttpClient

Returns:

String containing the name of the client

close

public void close()

Description copied from interface: SdkAutoCloseable

Specified by:

close in interface SdkAutoCloseable

Specified by:

close in interface AutoCloseable