Extract HttpRequest.Node (future-proof this class for later use)

Author: swallez

java-client/src/main/java/co/elastic/clients/transport/http/Node.java

@@ -1,4 +1,142 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
 package co.elastic.clients.transport.http;
 
+import javax.annotation.Nullable;
+import java.net.URI;
+import java.util.List;
+import java.util.Map;
+import java.util.Objects;
+import java.util.Set;
+
+/**
+ * A node/host to send requests to.
+ */
 public class Node {
+    private final URI uri;
+    private final String name;
+    private final String version;
+    private final Set<String> roles;
+    private final Map<String, String> attributes;
+    private final List<String> boundHosts;
+
+    /**
+     * Create a node with its URI, roles and attributes.
+     * <p>
+     * If the URI doesn't end with a '{@code /}', then one is added.
+     *
+     * @param uri        the node's URI
+     * @param name       the node name/identifier
+     * @param version    the node's version, if known
+     * @param roles      the node's roles (such as "master", "ingest", etc).
+     * @param attributes the node's attributes. This can be used for routing decisions by multi-node implementations.
+     * @param boundHosts addresses on which the node is listening. Useful to find a host based on any address it's listening to.
+     */
+    public Node(
+        URI uri,
+        @Nullable String name,
+        @Nullable String version,
+        @Nullable Set<String> roles,
+        @Nullable Map<String, String> attributes,
+        @Nullable List<String> boundHosts
+    ) {
+
+        if (!uri.isAbsolute()) {
+            throw new IllegalArgumentException("Node URIs must be absolute: " + uri);
+        }
+
+        if (!uri.getRawPath().endsWith("/")) {
+            uri = uri.resolve(uri.getRawPath() + "/");
+        }
+
+        this.uri = uri;
+        this.name = name;
+        this.version = version;
+        this.roles = roles;
+        this.attributes = attributes;
+        this.boundHosts = boundHosts;
+    }
+
+    public Node(URI uri) {
+        this(uri, null, null, null, null, null);
+    }
+
+    public Node(String uri) {
+        this(URI.create(uri), null, null, null, null, null);
+    }
+
+    /**
+     * The URI of this node. This is an absolute URL with a path ending with a "/".
+     */
+    public URI uri() {
+        return this.uri;
+    }
+
+    /**
+     * The node name/identifier
+     */
+    @Nullable
+    public String name() {
+        return name;
+    }
+
+    @Nullable
+    public String version() {
+        return version;
+    }
+
+    @Nullable
+    public Set<String> roles() {
+        return roles;
+    }
+
+    @Nullable
+    public Map<String, String> attributes() {
+        return attributes;
+    }
+
+    @Nullable
+    public List<String> boundHosts() {
+        return boundHosts;
+    }
+
+    @Override
+    public String toString() {
+        return uri.toString();
+    }
+
+    /**
+     * Two nodes are considered equal if their URIs are equal. Other properties are ignored.
+     */
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (!(o instanceof Node node)) return false;
+        return Objects.equals(uri, node.uri);
+    }
+
+    /**
+     * A node's hash code is that of its URI. Other properties are ignored.
+     */
+    @Override
+    public int hashCode() {
+        return Objects.hash(uri);
+    }
 }

java-client/src/main/java/co/elastic/clients/transport/http/RepeatableBodyResponse.java

@@ -45,7 +45,7 @@ public RepeatableBodyResponse(TransportHttpClient.Response response) throws IOEx
     }
 
     @Override
-    public TransportHttpClient.Node node() {
+    public Node node() {
         return response.node();
     }
 

java-client/src/main/java/co/elastic/clients/transport/http/TransportHttpClient.java

@@ -26,13 +26,9 @@
 import javax.annotation.Nullable;
 import java.io.Closeable;
 import java.io.IOException;
-import java.net.URI;
 import java.nio.ByteBuffer;
-import java.util.Collections;
 import java.util.List;
 import java.util.Map;
-import java.util.Objects;
-import java.util.Set;
 import java.util.concurrent.CompletableFuture;
 
 /**
@@ -90,78 +86,6 @@ default TransportOptions createOptions(@Nullable TransportOptions options) {
      */
     void close() throws IOException;
 
-    /**
-     * A node/host to send requests to.
-     */
-    class Node {
-        private final URI uri;
-        private final Set<String> roles;
-        private final Map<String, String> attributes;
-
-        /**
-         * Create a node with its URI, roles and attributes.
-         * <p>
-         * If the URI doesn't end with a '{@code /}', then one is added.
-         *
-         * @param uri the node's URI
-         * @param roles the node's roles (such as "master", "ingest", etc). This can be used for routing decisions by multi-node
-         *              implementations.
-         * @param attributes the node's attributes. This can be used for routing decisions by multi-node implementations.
-         */
-        public Node(URI uri, Set<String> roles, Map<String, String> attributes) {
-            if (!uri.isAbsolute()) {
-                throw new IllegalArgumentException("Node URIs must be absolute: " + uri);
-            }
-
-            if (!uri.getRawPath().endsWith("/")) {
-                uri = uri.resolve(uri.getRawPath() + "/");
-            }
-
-            this.uri = uri;
-            this.roles = roles;
-            this.attributes = attributes;
-        }
-
-        public Node(URI uri) {
-            this(uri, Collections.emptySet(), Collections.emptyMap());
-        }
-
-        public Node(String uri) {
-            this(URI.create(uri), Collections.emptySet(), Collections.emptyMap());
-        }
-
-        /**
-         * The URI of this node. This is an absolute URL with a path ending with a "/".
-         */
-        public URI uri() {
-            return this.uri;
-        }
-
-        @Override
-        public String toString() {
-            return uri.toString();
-        }
-
-        /**
-         * Two nodes are considered equal if their URIs are equal. Roles and attributes are ignored.
-         */
-        @Override
-        public boolean equals(Object o) {
-            if (this == o) return true;
-            if (!(o instanceof Node)) return false;
-            Node node = (Node) o;
-            return Objects.equals(uri, node.uri);
-        }
-
-        /**
-         * A node's hash code is that of its URI. Roles and attributes are ignored.
-         */
-        @Override
-        public int hashCode() {
-            return Objects.hash(uri);
-        }
-    }
-
     /**
      * An http request.
      */

java-client/src/main/java/co/elastic/clients/transport/rest5_client/Rest5ClientHttpClient.java

@@ -21,6 +21,7 @@
 
 import co.elastic.clients.transport.TransportOptions;
 import co.elastic.clients.transport.http.HeaderMap;
+import co.elastic.clients.transport.http.Node;
 import co.elastic.clients.transport.http.TransportHttpClient;
 import co.elastic.clients.transport.rest5_client.low_level.Cancellable;
 import co.elastic.clients.transport.rest5_client.low_level.ResponseListener;

java-client/src/main/java/co/elastic/clients/transport/rest_client/RestClientHttpClient.java

@@ -21,6 +21,7 @@
 
 import co.elastic.clients.transport.TransportOptions;
 import co.elastic.clients.transport.http.HeaderMap;
+import co.elastic.clients.transport.http.Node;
 import co.elastic.clients.transport.http.TransportHttpClient;
 import co.elastic.clients.util.BinaryData;
 import co.elastic.clients.util.NoCopyByteArrayOutputStream;

java-client/src/test/java/co/elastic/clients/testkit/MockHttpClient.java

@@ -24,6 +24,7 @@
 import co.elastic.clients.transport.ElasticsearchTransportBase;
 import co.elastic.clients.transport.TransportException;
 import co.elastic.clients.transport.TransportOptions;
+import co.elastic.clients.transport.http.Node;
 import co.elastic.clients.transport.http.TransportHttpClient;
 import co.elastic.clients.util.BinaryData;
 import org.jetbrains.annotations.Nullable;
@@ -69,7 +70,7 @@ public void close() throws IOException {
 
     @Override
     public Response performRequest(
-        String endpointId, @Nullable TransportHttpClient.Node node, Request request, TransportOptions option
+        String endpointId, @Nullable Node node, Request request, TransportOptions option
     ) throws IOException {
         Response response = responses.get(request.path());
 
@@ -82,7 +83,7 @@ public Response performRequest(
 
     @Override
     public CompletableFuture<Response> performRequestAsync(
-        String endpointId, @Nullable TransportHttpClient.Node node, Request request, TransportOptions options
+        String endpointId, @Nullable Node node, Request request, TransportOptions options
     ) {
         CompletableFuture<Response> result = new CompletableFuture<>();
         try {

java-client/src/test/java/co/elastic/clients/transport/endpoints/SimpleEndpointTest.java

@@ -26,6 +26,7 @@
 import co.elastic.clients.transport.ElasticsearchTransport;
 import co.elastic.clients.transport.ElasticsearchTransportBase;
 import co.elastic.clients.transport.TransportOptions;
+import co.elastic.clients.transport.http.Node;
 import co.elastic.clients.transport.http.TransportHttpClient;
 import org.jetbrains.annotations.Nullable;
 import org.junit.jupiter.api.Test;