Package org.opensearch.client.transport.httpclient5

Class ApacheHttpClient5Transport

java.lang.Object

org.opensearch.client.transport.httpclient5.ApacheHttpClient5Transport

All Implemented Interfaces:

Closeable, AutoCloseable, OpenSearchTransport, Transport

public class ApacheHttpClient5Transport
extends Object
implements OpenSearchTransport

Apache HttpClient 5 based client transport.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ApacheHttpClient5Transport.ContentCompressingEntity	A gzip compressing entity that also implements getContent().
static class	ApacheHttpClient5Transport.ContentHttpEntity	An entity that lets the caller specify the return value of isChunked().
static class	ApacheHttpClient5Transport.FailureListener	Listener that allows to be notified whenever a failure happens.

Constructor Summary

Constructors

Constructor

Description

ApacheHttpClient5Transport(org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient client, org.apache.hc.core5.http.Header[] defaultHeaders, List<Node> nodes, JsonpMapper mapper, TransportOptions options, String pathPrefix, ApacheHttpClient5Transport.FailureListener failureListener, NodeSelector nodeSelector, boolean strictDeprecationMode, boolean compressionEnabled, boolean chunkedEnabled)

Method Summary

Modifier and Type	Method	Description
void	close()
Map<Node,NodeState>	getNodes()	Returns a map of all nodes managed by this transport and their current state.
JsonpMapper	jsonpMapper()
TransportOptions	options()	Default options used by this transport if none are provided in Transport.performRequest(Object, Endpoint, TransportOptions) or Transport.performRequestAsync(Object, Endpoint, TransportOptions);
<RequestT, ResponseT, ErrorT> ResponseT	performRequest(RequestT request, Endpoint<RequestT,ResponseT,ErrorT> endpoint, TransportOptions options)
<RequestT, ResponseT, ErrorT> CompletableFuture<ResponseT>	performRequestAsync(RequestT request, Endpoint<RequestT,ResponseT,ErrorT> endpoint, TransportOptions options)

Methods inherited from class java.lang.Object

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

Constructor Details

ApacheHttpClient5Transport

public ApacheHttpClient5Transport(org.apache.hc.client5.http.impl.async.CloseableHttpAsyncClient client,
 org.apache.hc.core5.http.Header[] defaultHeaders,
 List<Node> nodes,
 JsonpMapper mapper,
 @Nullable
 TransportOptions options,
 String pathPrefix,
 ApacheHttpClient5Transport.FailureListener failureListener,
 NodeSelector nodeSelector,
 boolean strictDeprecationMode,
 boolean compressionEnabled,
 boolean chunkedEnabled)

Method Details

performRequest

public <RequestT,
ResponseT,
ErrorT> ResponseT performRequest(RequestT request,
 Endpoint<RequestT,ResponseT,ErrorT> endpoint,
 TransportOptions options)
                                                       throws IOException

Specified by:

performRequest in interface Transport

Throws:

IOException

performRequestAsync

public <RequestT,
ResponseT,
ErrorT>
CompletableFuture<ResponseT> performRequestAsync(RequestT request,
 Endpoint<RequestT,ResponseT,ErrorT> endpoint,
 TransportOptions options)

Specified by:

performRequestAsync in interface Transport

jsonpMapper

public JsonpMapper jsonpMapper()

Specified by:

jsonpMapper in interface Transport

options

public TransportOptions options()

Description copied from interface: Transport

Default options used by this transport if none are provided in Transport.performRequest(Object, Endpoint, TransportOptions) or Transport.performRequestAsync(Object, Endpoint, TransportOptions);

Specified by:

options in interface Transport

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

getNodes

public Map<Node,NodeState> getNodes()

Returns a map of all nodes managed by this transport and their current state.

Each node is mapped to either NodeState.Active if it is available for requests, or NodeState.Unavailable if it is currently denylisted due to previous failures. Nodes that are eligible for retry are considered active.

Returns:

an unmodifiable map of nodes to their current state