Interface ClientConfiguration

public interface ClientConfiguration

Configuration interface exposing common client configuration properties for Elasticsearch clients.

Since:

3.2

Author:

Mark Paluch, Peter-Josef Meisch, Huw Ayling-Miller, Henrique Amaral

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ClientConfiguration.ClientConfigurationBuilderWithRequiredEndpoint
static interface	ClientConfiguration.ClientConfigurationCallback<T>	Callback to be executed to configure a client.
static interface	ClientConfiguration.MaybeSecureClientConfigurationBuilder
static interface	ClientConfiguration.TerminalClientConfigurationBuilder

Method Summary

Modifier and Type	Method	Description
static ClientConfiguration.ClientConfigurationBuilderWithRequiredEndpoint	builder()	Creates a new ClientConfigurationBuilder instance.
static ClientConfiguration	create(String hostAndPort)	Creates a new ClientConfiguration instance configured to a single host given hostAndPort.
static ClientConfiguration	create(InetSocketAddress socketAddress)	Creates a new ClientConfiguration instance configured to a single host given InetSocketAddress.
Optional<String>	getCaFingerprint()
<T> List<ClientConfiguration.ClientConfigurationCallback<?>>	getClientConfigurers()
Duration	getConnectTimeout()	Returns the connect timeout.
HttpHeaders	getDefaultHeaders()	Obtain the HttpHeaders to be used by default.
List<InetSocketAddress>	getEndpoints()	Returns the configured endpoints.
Supplier<HttpHeaders>	getHeadersSupplier()
Optional<HostnameVerifier>	getHostNameVerifier()	Deprecated, for removal: This API element is subject to removal in a future version. since 6.0
@Nullable String	getPathPrefix()	Returns the path prefix that should be prepended to HTTP(s) requests for Elasticsearch behind a proxy.
Optional<String>	getProxy()	returns an optionally set proxy in the form host:port
Duration	getSocketTimeout()	Returns the socket timeout which is typically applied as SO-timeout/read timeout.
Optional<SSLContext>	getSslContext()	Returns the SSLContext to use.
static ClientConfiguration	localhost()	Creates a new ClientConfiguration instance configured to localhost.
boolean	useSsl()	Returns true when the client should use SSL.

Method Details

builder

static ClientConfiguration.ClientConfigurationBuilderWithRequiredEndpoint builder()

Creates a new ClientConfigurationBuilder instance.

Returns:

a new ClientConfigurationBuilder instance.

localhost

static ClientConfiguration localhost()

Creates a new ClientConfiguration instance configured to localhost.

// "localhost:9200"
ClientConfiguration configuration = ClientConfiguration.localhost();

Returns:

a new ClientConfiguration instance

See Also:

• ClientConfiguration.ClientConfigurationBuilderWithRequiredEndpoint.connectedToLocalhost()

create

static ClientConfiguration create(String hostAndPort)

Creates a new ClientConfiguration instance configured to a single host given hostAndPort. For example given the endpoint http://localhost:9200

ClientConfiguration configuration = ClientConfiguration.create("localhost:9200");

Returns:

a new ClientConfigurationBuilder instance.

create

static ClientConfiguration create(InetSocketAddress socketAddress)

Creates a new ClientConfiguration instance configured to a single host given InetSocketAddress. For example given the endpoint http://localhost:9200

ClientConfiguration configuration = ClientConfiguration
                .create(InetSocketAddress.createUnresolved("localhost", 9200));

Returns:

a new ClientConfigurationBuilder instance.

getEndpoints

List<InetSocketAddress> getEndpoints()

Returns the configured endpoints.

Returns:

the configured endpoints.

getDefaultHeaders

HttpHeaders getDefaultHeaders()

Obtain the HttpHeaders to be used by default.

Returns:

the HttpHeaders to be used by default.

useSsl

boolean useSsl()

Returns true when the client should use SSL.

Returns:

true when the client should use SSL.

getSslContext

Optional<SSLContext> getSslContext()

Returns the SSLContext to use. Can be Optional.empty() if not configured.

Returns:

the SSLContext to use. Can be Optional.empty() if not configured.

getCaFingerprint

Optional<String> getCaFingerprint()

Returns:

the optional SHA-256 fingerprint of the self-signed http_ca.crt certificate output by Elasticsearch at startup time.

getHostNameVerifier

@Deprecated(since="6.0",
            forRemoval=true)
Optional<HostnameVerifier> getHostNameVerifier()

Deprecated, for removal: This API element is subject to removal in a future version.

since 6.0

Returns the HostnameVerifier to use. Must be Optional.empty() if not configured. Cannot be used with the Rest5Client used from Elasticsearch 9 on as the underlying Apache http components 5 does not offer a way to set this. Users that need a hostname verifier must integrate this in a SSLContext. Returning a value here is ignored in this case

Returns:

the HostnameVerifier to use. Can be Optional.empty() if not configured.

getConnectTimeout

Duration getConnectTimeout()

Returns the connect timeout.

See Also:

• Socket.connect(SocketAddress, int)

getSocketTimeout

Duration getSocketTimeout()

Returns the socket timeout which is typically applied as SO-timeout/read timeout.

See Also:

• Socket.setSoTimeout(int)

getPathPrefix

@Nullable String getPathPrefix()

Returns the path prefix that should be prepended to HTTP(s) requests for Elasticsearch behind a proxy.

Returns:

the path prefix.

Since:

4.0

getProxy

Optional<String> getProxy()

returns an optionally set proxy in the form host:port

Returns:

the optional proxy

Since:

4.0

getClientConfigurers

<T>
List<ClientConfiguration.ClientConfigurationCallback<?>> getClientConfigurers()

Returns:

the client configuration callbacks

Since:

4.3

getHeadersSupplier

Supplier<HttpHeaders> getHeadersSupplier()

Returns:

the supplier for custom headers.