com.ibm.cos.v2.http.nio.netty

Class NettyNioAsyncHttpClient

java.lang.Object

com.ibm.cos.v2.http.nio.netty.NettyNioAsyncHttpClient

All Implemented Interfaces:

SdkAsyncHttpClient, SdkAutoCloseable, AutoCloseable

public final class NettyNioAsyncHttpClient
extends Object
implements SdkAsyncHttpClient

An implementation of SdkAsyncHttpClient that uses a Netty non-blocking HTTP client to communicate with the service.

This can be created via builder()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NettyNioAsyncHttpClient.Builder Builder that allows configuration of the Netty NIO HTTP implementation.

Method Summary

Modifier and Type	Method and Description
static NettyNioAsyncHttpClient.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 SdkAsyncHttpClient	create() Create a NettyNioAsyncHttpClient with the default properties
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.

builder

public static NettyNioAsyncHttpClient.Builder builder()

create

public static SdkAsyncHttpClient create()

Create a NettyNioAsyncHttpClient with the default properties

Returns:

an NettyNioAsyncHttpClient

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: 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