Package org.opensearch.client.transport.httpclient5

Class ApacheHttpClient5TransportBuilder

java.lang.Object

org.opensearch.client.transport.httpclient5.ApacheHttpClient5TransportBuilder

public class ApacheHttpClient5TransportBuilder
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ApacheHttpClient5TransportBuilder.ConnectionConfigCallback	Callback used the default ConnectionConfig being set to the CloseableHttpClient.
static interface	ApacheHttpClient5TransportBuilder.HttpClientConfigCallback	Callback used to customize the CloseableHttpClient instance used by a RestClient instance.
static interface	ApacheHttpClient5TransportBuilder.RequestConfigCallback	Callback used the default RequestConfig being set to the CloseableHttpClient

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_CONNECT_TIMEOUT_MILLIS	The default connection timeout in milliseconds.
static int	DEFAULT_MAX_CONN_PER_ROUTE	The default maximum of connections per route.
static int	DEFAULT_MAX_CONN_TOTAL	The default maximum total connections.
static int	DEFAULT_RESPONSE_TIMEOUT_MILLIS	The default response timeout in milliseconds.

Method Summary

Modifier and Type	Method	Description
ApacheHttpClient5Transport	build()	Creates a new RestClient based on the provided configuration.
static ApacheHttpClient5TransportBuilder	builder(org.apache.hc.core5.http.HttpHost... hosts)	Returns a new ApacheHttpClient5TransportBuilder to help with ApacheHttpClient5Transport creation.
static ApacheHttpClient5TransportBuilder	builder(Node... nodes)	Returns a new ApacheHttpClient5TransportBuilder to help with ApacheHttpClient5Transport creation.
static java.lang.String	cleanPathPrefix(java.lang.String pathPrefix)	Cleans up the given path prefix to ensure that looks like "/base/path".
ApacheHttpClient5TransportBuilder	setChunkedEnabled(boolean chunkedEnabled)	Whether the REST client should use Transfer-Encoding: chunked for requests or not"
ApacheHttpClient5TransportBuilder	setCompressionEnabled(boolean compressionEnabled)	Whether the REST client should compress requests using gzip content encoding and add the "Accept-Encoding: gzip" header to receive compressed responses.
ApacheHttpClient5TransportBuilder	setConnectionConfigCallback(ApacheHttpClient5TransportBuilder.ConnectionConfigCallback connectionConfigCallback)	Sets the ApacheHttpClient5TransportBuilder.ConnectionConfigCallback to be used to customize http client configuration
ApacheHttpClient5TransportBuilder	setDefaultHeaders(org.apache.hc.core5.http.Header[] defaultHeaders)	Sets the default request headers, which will be sent along with each request.
ApacheHttpClient5TransportBuilder	setFailureListener(ApacheHttpClient5Transport.FailureListener failureListener)	Sets the RestClient.FailureListener to be notified for each request failure
ApacheHttpClient5TransportBuilder	setHttpClientConfigCallback(ApacheHttpClient5TransportBuilder.HttpClientConfigCallback httpClientConfigCallback)	Sets the ApacheHttpClient5TransportBuilder.HttpClientConfigCallback to be used to customize http client configuration
ApacheHttpClient5TransportBuilder	setMapper(JsonpMapper mapper)	Sets the JsonpMapper instance to be used for parsing JSON payloads.
ApacheHttpClient5TransportBuilder	setNodeSelector(NodeSelector nodeSelector)	Sets the NodeSelector to be used for all requests.
ApacheHttpClient5TransportBuilder	setOptions(TransportOptions options)	Sets the default TransportOptions to be used by the client
ApacheHttpClient5TransportBuilder	setPathPrefix(java.lang.String pathPrefix)	Sets the path's prefix for every request used by the http client.
ApacheHttpClient5TransportBuilder	setRequestConfigCallback(ApacheHttpClient5TransportBuilder.RequestConfigCallback requestConfigCallback)	Sets the ApacheHttpClient5TransportBuilder.RequestConfigCallback to be used to customize http client configuration
ApacheHttpClient5TransportBuilder	setStrictDeprecationMode(boolean strictDeprecationMode)	Whether the REST client should return any response containing at least one warning header as a failure.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONNECT_TIMEOUT_MILLIS

public static final int DEFAULT_CONNECT_TIMEOUT_MILLIS

The default connection timeout in milliseconds.

See Also:

Constant Field Values

DEFAULT_RESPONSE_TIMEOUT_MILLIS

public static final int DEFAULT_RESPONSE_TIMEOUT_MILLIS

The default response timeout in milliseconds.

See Also:

Constant Field Values

DEFAULT_MAX_CONN_PER_ROUTE

public static final int DEFAULT_MAX_CONN_PER_ROUTE

The default maximum of connections per route.

See Also:

Constant Field Values

DEFAULT_MAX_CONN_TOTAL

public static final int DEFAULT_MAX_CONN_TOTAL

The default maximum total connections.

See Also:

Constant Field Values

Method Detail

setDefaultHeaders

public ApacheHttpClient5TransportBuilder setDefaultHeaders(org.apache.hc.core5.http.Header[] defaultHeaders)

Sets the default request headers, which will be sent along with each request.

Request-time headers will always overwrite any default headers.

Parameters:

defaultHeaders - array of default header

Throws:

java.lang.NullPointerException - if defaultHeaders or any header is null.

setFailureListener

public ApacheHttpClient5TransportBuilder setFailureListener(ApacheHttpClient5Transport.FailureListener failureListener)

Sets the RestClient.FailureListener to be notified for each request failure

Parameters:

failureListener - the RestClient.FailureListener for each failure

Throws:

java.lang.NullPointerException - if failureListener is null.

setHttpClientConfigCallback

public ApacheHttpClient5TransportBuilder setHttpClientConfigCallback(ApacheHttpClient5TransportBuilder.HttpClientConfigCallback httpClientConfigCallback)

Sets the ApacheHttpClient5TransportBuilder.HttpClientConfigCallback to be used to customize http client configuration

Parameters:

httpClientConfigCallback - the ApacheHttpClient5TransportBuilder.HttpClientConfigCallback to be used

Throws:

java.lang.NullPointerException - if httpClientConfigCallback is null.

setRequestConfigCallback

public ApacheHttpClient5TransportBuilder setRequestConfigCallback(ApacheHttpClient5TransportBuilder.RequestConfigCallback requestConfigCallback)

Sets the ApacheHttpClient5TransportBuilder.RequestConfigCallback to be used to customize http client configuration

Parameters:

requestConfigCallback - the ApacheHttpClient5TransportBuilder.RequestConfigCallback to be used

Throws:

java.lang.NullPointerException - if requestConfigCallback is null.

setConnectionConfigCallback

public ApacheHttpClient5TransportBuilder setConnectionConfigCallback(ApacheHttpClient5TransportBuilder.ConnectionConfigCallback connectionConfigCallback)

Sets the ApacheHttpClient5TransportBuilder.ConnectionConfigCallback to be used to customize http client configuration

Parameters:

connectionConfigCallback - the ApacheHttpClient5TransportBuilder.ConnectionConfigCallback to be used

Throws:

java.lang.NullPointerException - if connectionConfigCallback is null.

setPathPrefix

public ApacheHttpClient5TransportBuilder setPathPrefix(java.lang.String pathPrefix)

Sets the path's prefix for every request used by the http client.

For example, if this is set to "/my/path", then any client request will become "/my/path/" + endpoint.

In essence, every request's endpoint is prefixed by this pathPrefix. The path prefix is useful for when OpenSearch is behind a proxy that provides a base path or a proxy that requires all paths to start with '/'; it is not intended for other purposes and it should not be supplied in other scenarios.

Parameters:

pathPrefix - the path prefix for every request.

Throws:

java.lang.NullPointerException - if pathPrefix is null.

java.lang.IllegalArgumentException - if pathPrefix is empty, or ends with more than one '/'.

setMapper

public ApacheHttpClient5TransportBuilder setMapper(JsonpMapper mapper)

Sets the JsonpMapper instance to be used for parsing JSON payloads. If not provided the JacksonJsonpMapper is going to be used.

Parameters:

mapper - the JsonpMapper instance

setOptions

public ApacheHttpClient5TransportBuilder setOptions(TransportOptions options)

Sets the default TransportOptions to be used by the client

Parameters:

options - default TransportOptions

cleanPathPrefix

public static java.lang.String cleanPathPrefix(java.lang.String pathPrefix)

Cleans up the given path prefix to ensure that looks like "/base/path".

Parameters:

pathPrefix - the path prefix to be cleaned up.

Returns:

the cleaned up path prefix.

Throws:

java.lang.NullPointerException - if pathPrefix is null.

java.lang.IllegalArgumentException - if pathPrefix is empty, or ends with more than one '/'.

setNodeSelector

public ApacheHttpClient5TransportBuilder setNodeSelector(NodeSelector nodeSelector)

Sets the NodeSelector to be used for all requests.

Parameters:

nodeSelector - the NodeSelector to be used

Throws:

java.lang.NullPointerException - if the provided nodeSelector is null

setStrictDeprecationMode

public ApacheHttpClient5TransportBuilder setStrictDeprecationMode(boolean strictDeprecationMode)

Whether the REST client should return any response containing at least one warning header as a failure.

Parameters:

strictDeprecationMode - flag for enabling strict deprecation mode

setCompressionEnabled

public ApacheHttpClient5TransportBuilder setCompressionEnabled(boolean compressionEnabled)

Whether the REST client should compress requests using gzip content encoding and add the "Accept-Encoding: gzip" header to receive compressed responses.

Parameters:

compressionEnabled - flag for enabling compression

setChunkedEnabled

public ApacheHttpClient5TransportBuilder setChunkedEnabled(boolean chunkedEnabled)

Whether the REST client should use Transfer-Encoding: chunked for requests or not"

Parameters:

chunkedEnabled - force enable/disable chunked transfer-encoding.

build

public ApacheHttpClient5Transport build()

Creates a new RestClient based on the provided configuration.

builder

public static ApacheHttpClient5TransportBuilder builder(Node... nodes)

Returns a new ApacheHttpClient5TransportBuilder to help with ApacheHttpClient5Transport creation. Creates a new builder instance and sets the hosts that the client will send requests to.

Prefer this to builder(HttpHost...) if you have metadata up front about the nodes. If you don't either one is fine.

Parameters:

nodes - The nodes that the client will send requests to.

builder

public static ApacheHttpClient5TransportBuilder builder(org.apache.hc.core5.http.HttpHost... hosts)

Returns a new ApacheHttpClient5TransportBuilder to help with ApacheHttpClient5Transport creation. Creates a new builder instance and sets the nodes that the client will send requests to.

You can use this if you do not have metadata up front about the nodes. If you do, prefer builder(Node...).

Parameters:

hosts - The hosts that the client will send requests to.

See Also:

Node(HttpHost)