diff --git a/module/spring-boot-elasticsearch/src/main/java/org/springframework/boot/elasticsearch/autoconfigure/ElasticsearchConnectionDetails.java b/module/spring-boot-elasticsearch/src/main/java/org/springframework/boot/elasticsearch/autoconfigure/ElasticsearchConnectionDetails.java index 6c3ae2511620..10b99bd6f8ea 100644 --- a/module/spring-boot-elasticsearch/src/main/java/org/springframework/boot/elasticsearch/autoconfigure/ElasticsearchConnectionDetails.java +++ b/module/spring-boot-elasticsearch/src/main/java/org/springframework/boot/elasticsearch/autoconfigure/ElasticsearchConnectionDetails.java @@ -57,6 +57,14 @@ public interface ElasticsearchConnectionDetails extends ConnectionDetails { return null; } + /** + * APIKey for authentication with Elasticsearch. + * @return APIKey for authentication with Elasticsearch or {@code null} + */ + default @Nullable String getAPIKey() { + return null; + } + /** * Prefix added to the path of every request sent to Elasticsearch. * @return prefix added to the path of every request sent to Elasticsearch or diff --git a/module/spring-boot-elasticsearch/src/main/java/org/springframework/boot/elasticsearch/autoconfigure/ElasticsearchProperties.java b/module/spring-boot-elasticsearch/src/main/java/org/springframework/boot/elasticsearch/autoconfigure/ElasticsearchProperties.java index d6d98718686a..4189533bb422 100644 --- a/module/spring-boot-elasticsearch/src/main/java/org/springframework/boot/elasticsearch/autoconfigure/ElasticsearchProperties.java +++ b/module/spring-boot-elasticsearch/src/main/java/org/springframework/boot/elasticsearch/autoconfigure/ElasticsearchProperties.java @@ -48,6 +48,10 @@ public class ElasticsearchProperties { * Password for authentication with Elasticsearch. */ private @Nullable String password; + /** + * APIKey for authentication with Elasticsearch. + */ + private @Nullable String APIKey; /** * Connection timeout used when communicating with Elasticsearch. @@ -95,6 +99,14 @@ public void setPassword(@Nullable String password) { this.password = password; } + public @Nullable String getAPIKey() { + return this.APIKey; + } + + public void setAPIKey(@Nullable String APIKey) { + this.APIKey = APIKey; + } + public Duration getConnectionTimeout() { return this.connectionTimeout; } diff --git a/module/spring-boot-elasticsearch/src/main/java/org/springframework/boot/elasticsearch/autoconfigure/ElasticsearchRestClientConfigurations.java b/module/spring-boot-elasticsearch/src/main/java/org/springframework/boot/elasticsearch/autoconfigure/ElasticsearchRestClientConfigurations.java index 5ca31778274c..253c7727fdfc 100644 --- a/module/spring-boot-elasticsearch/src/main/java/org/springframework/boot/elasticsearch/autoconfigure/ElasticsearchRestClientConfigurations.java +++ b/module/spring-boot-elasticsearch/src/main/java/org/springframework/boot/elasticsearch/autoconfigure/ElasticsearchRestClientConfigurations.java @@ -36,7 +36,9 @@ import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManagerBuilder; import org.apache.hc.client5.http.ssl.DefaultClientTlsStrategy; import org.apache.hc.client5.http.ssl.NoopHostnameVerifier; +import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHost; +import org.apache.hc.core5.http.message.BasicHeader; import org.apache.hc.core5.reactor.IOReactorConfig; import org.apache.hc.core5.reactor.ssl.SSLBufferMode; import org.apache.hc.core5.util.Timeout; @@ -67,6 +69,7 @@ * @author Moritz Halbritter * @author Andy Wilkinson * @author Phillip Webb + * @author Laura Trotta */ class ElasticsearchRestClientConfigurations { @@ -99,6 +102,11 @@ Rest5ClientBuilder elasticsearchRestClientBuilder(ElasticsearchConnectionDetails .stream() .map((node) -> new HttpHost(node.protocol().getScheme(), node.hostname(), node.port())) .toArray(HttpHost[]::new)); + if (connectionDetails.getAPIKey() != null) { + builder.setDefaultHeaders(new Header[]{ + new BasicHeader("Authorization", "ApiKey " + connectionDetails.getAPIKey()), + }); + } builder.setHttpClientConfigCallback((httpClientBuilder) -> builderCustomizers.orderedStream() .forEach((customizer) -> customizer.customize(httpClientBuilder))); builder.setConnectionManagerCallback((connectionManagerBuilder) -> builderCustomizers.orderedStream() @@ -275,6 +283,11 @@ public List getNodes() { return this.properties.getPassword(); } + @Override + public @Nullable String getAPIKey() { + return this.properties.getAPIKey(); + } + @Override public @Nullable String getPathPrefix() { return this.properties.getPathPrefix(); diff --git a/module/spring-boot-elasticsearch/src/test/java/org/springframework/boot/elasticsearch/autoconfigure/ElasticsearchRestClientAutoConfigurationTests.java b/module/spring-boot-elasticsearch/src/test/java/org/springframework/boot/elasticsearch/autoconfigure/ElasticsearchRestClientAutoConfigurationTests.java index a80a819d0d63..d35091a1bf12 100644 --- a/module/spring-boot-elasticsearch/src/test/java/org/springframework/boot/elasticsearch/autoconfigure/ElasticsearchRestClientAutoConfigurationTests.java +++ b/module/spring-boot-elasticsearch/src/test/java/org/springframework/boot/elasticsearch/autoconfigure/ElasticsearchRestClientAutoConfigurationTests.java @@ -19,6 +19,7 @@ import java.time.Duration; import java.util.ArrayList; import java.util.List; +import java.util.Optional; import co.elastic.clients.transport.rest5_client.low_level.Node; import co.elastic.clients.transport.rest5_client.low_level.Rest5Client; @@ -33,6 +34,7 @@ import org.apache.hc.client5.http.impl.async.HttpAsyncClientBuilder; import org.apache.hc.client5.http.impl.nio.PoolingAsyncClientConnectionManagerBuilder; import org.apache.hc.core5.function.Resolver; +import org.apache.hc.core5.http.Header; import org.apache.hc.core5.http.HttpHost; import org.apache.hc.core5.http.config.Registry; import org.apache.hc.core5.util.Timeout; @@ -47,6 +49,7 @@ import org.springframework.boot.testsupport.classpath.resources.WithPackageResources; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; +import org.springframework.web.client.RestClient; import static org.assertj.core.api.Assertions.assertThat; import static org.mockito.BDDMockito.then; @@ -62,6 +65,7 @@ * @author Andy Wilkinson * @author Moritz Halbritter * @author Phillip Webb + * @author Laura Trotta */ class ElasticsearchRestClientAutoConfigurationTests { @@ -134,6 +138,25 @@ void configureUriWithNoScheme() { }); } + @Test + void configureUriWithAPiKey() { + this.contextRunner.withPropertyValues("spring.elasticsearch.uris=http://user@localhost:9200","spring.elasticsearch.apikey=some-apiKey").run((context) -> { + Rest5Client client = context.getBean(Rest5Client.class); + assertThat(client.getNodes().stream().map(Node::getHost).map(HttpHost::toString)) + .containsExactly("http://localhost:9200"); + assertThat(client) + .extracting("defaultHeaders", InstanceOfAssertFactories.list(Header.class)) + .satisfies(( defaultHeaders) -> { + Optional authHeader = defaultHeaders.stream() + .filter(x -> x.getName().equals("Authorization")) + .findFirst(); + assertThat(authHeader).isPresent(); + assertThat(authHeader.get().getValue()).isEqualTo("ApiKey some-apiKey"); + }); + }); + } + + @Test void configureUriWithUsernameOnly() { this.contextRunner.withPropertyValues("spring.elasticsearch.uris=http://user@localhost:9200").run((context) -> {