Add support for nd-json, path fragment encoding, tests & bugfixes

Author: swallez

config/checkstyle/checkstyle.xml

@@ -39,12 +39,14 @@
     <!-- Checks Java files and forbids empty Javadoc comments. -->
     <!-- Although you can use the "JavadocStyle" rule for this, it considers Javadoc -->
     <!-- that only contains a "@return" line to be empty. -->
+    <!--
     <module name="RegexpMultiline">
         <property name="id" value="EmptyJavadoc" />
         <property name="format" value="\/\*[\s\*]*\*\/" />
         <property name="fileExtensions" value="java" />
         <property name="message" value="Empty javadoc comments are forbidden" />
     </module>
+    -->
 
     <!-- Its our official line length! See checkstyle_suppressions.xml for the files that don't pass this. For now we
       suppress the check there but enforce it everywhere else. This prevents the list from getting longer even if it is

java-client/build.gradle.kts

@@ -107,13 +107,15 @@ publishing {
 }
 
 dependencies {
-    val elasticsearchVersion = "7.12.0"
+    val elasticsearchVersion = "7.15.0"
     val jacksonVersion = "2.12.0"
 
     // Apache 2.0
+    // https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current/java-rest-low.html
     implementation("org.elasticsearch.client", "elasticsearch-rest-client", elasticsearchVersion)
 
     // Apache 2.0
+    // https://search.maven.org/artifact/com.google.code.findbugs/jsr305
     implementation("com.google.code.findbugs:jsr305:3.0.2")
 
     // EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
@@ -131,20 +133,26 @@ dependencies {
     testImplementation("jakarta.json.bind", "jakarta.json.bind-api", "2.0.0")
 
     // Apache 2.0
+    // https://github.com/FasterXML/jackson
     compileOnly("com.fasterxml.jackson.core", "jackson-core", jacksonVersion)
     compileOnly("com.fasterxml.jackson.core", "jackson-databind", jacksonVersion)
     testImplementation("com.fasterxml.jackson.core", "jackson-core", jacksonVersion)
     testImplementation("com.fasterxml.jackson.core", "jackson-databind", jacksonVersion)
-    testImplementation("io.github.classgraph:classgraph:4.8.116")
 
     // EPL-2.0 OR BSD-3-Clause
     // https://eclipse-ee4j.github.io/yasson/
     testImplementation("org.eclipse", "yasson", "2.0.2")
 
-    // Eclipse 1.0
+    // EPL-1.0
+    // https://junit.org/junit4/
     testImplementation("junit", "junit" , "4.12")
 
     // MIT
+    // https://github.com/classgraph/classgraph
+    testImplementation("io.github.classgraph:classgraph:4.8.116")
+
+    // MIT
+    // https://www.testcontainers.org/
     testImplementation("org.testcontainers", "testcontainers", "1.15.3")
     testImplementation("org.testcontainers", "elasticsearch", "1.15.3")
 }

java-client/src/main/java/co/elastic/clients/base/BooleanEndpoint.java

@@ -0,0 +1,49 @@
+/*
+ * 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.base;
+
+import co.elastic.clients.json.JsonpDeserializer;
+
+import java.util.Map;
+import java.util.function.Function;
+
+public class BooleanEndpoint<RequestT> extends SimpleEndpoint<RequestT, BooleanResponse> {
+
+    public BooleanEndpoint(
+        Function<RequestT, String> method,
+        Function<RequestT, String> requestUrl,
+        Function<RequestT,
+            Map<String, String>> queryParameters,
+        Function<RequestT, Map<String, String>> headers,
+        boolean hasRequestBody, // always true
+        JsonpDeserializer<BooleanResponse> responseParser // always null
+    ) {
+        super(method, requestUrl, queryParameters, headers, hasRequestBody, responseParser);
+    }
+
+    @Override
+    public boolean isError(int statusCode) {
+        return statusCode >= 500;
+    }
+
+    public boolean getResult(int statusCode) {
+        return statusCode < 400;
+    }
+}

java-client/src/main/java/co/elastic/clients/base/AdditionalProperties.java renamed to java-client/src/main/java/co/elastic/clients/base/DictionaryResponse.java

@@ -33,8 +33,11 @@
 import java.util.HashMap;
 import java.util.Map;
 
-public abstract class AdditionalProperties<TKey, TValue> implements JsonpSerializable {
-    private final Map<String, TValue> value;
+/**
+ * Base class for dictionary responses, i.e. a series of key/value pairs.
+ */
+public abstract class DictionaryResponse<TKey, TValue> implements JsonpSerializable {
+    private final Map<String, TValue> result;
 
     @Nullable
     private final JsonpSerializer<TKey> tKeySerializer;
@@ -44,19 +47,26 @@ public abstract class AdditionalProperties<TKey, TValue> implements JsonpSeriali
 
     // ---------------------------------------------------------------------------------------------
 
-    protected AdditionalProperties(AbstractBuilder<TKey, TValue, ?> builder) {
+    protected DictionaryResponse(AbstractBuilder<TKey, TValue, ?> builder) {
 
-        this.value = builder.value;
+        this.result = builder.result;
         this.tKeySerializer = builder.tKeySerializer;
         this.tValueSerializer = builder.tValueSerializer;
 
     }
 
     /**
-     * Returns the map of additional properties.
+     * Returns the response as a map.
+     */
+    public Map<String, TValue> result() {
+        return this.result == null ? Collections.emptyMap() : result;
+    }
+
+    /**
+     *
      */
-    public Map<String, TValue> value() {
-        return this.value != null ? value : Collections.emptyMap();
+    public TValue get(String key) {
+        return this.result == null ? null : result.get(key);
     }
 
     /**
@@ -69,14 +79,14 @@ public void serialize(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     protected void toJsonpInternal(JsonGenerator generator, JsonpMapper mapper) {
-        for (Map.Entry<String, TValue> item0 : this.value.entrySet()) {
+        for (Map.Entry<String, TValue> item0 : this.result.entrySet()) {
             generator.writeKey(item0.getKey());
             JsonpUtils.serialize(item0.getValue(), generator, tValueSerializer, mapper);
         }
     }
 
     protected abstract static class AbstractBuilder<TKey, TValue, BuilderT extends AbstractBuilder<TKey, TValue, BuilderT>> {
-        private Map<String, TValue> value;
+        private Map<String, TValue> result;
 
         @Nullable
         private JsonpSerializer<TKey> tKeySerializer;
@@ -85,23 +95,21 @@ protected abstract static class AbstractBuilder<TKey, TValue, BuilderT extends A
         private JsonpSerializer<TValue> tValueSerializer;
 
         /**
-         * Response value.
-         *
-         * API name: {@code value}
+         * Response result.
          */
-        public BuilderT value(Map<String, TValue> value) {
-            this.value = value;
+        public BuilderT result(Map<String, TValue> value) {
+            this.result = value;
             return self();
         }
 
         /**
-         * Add a key/value to {@link #value(Map)}, creating the map if needed.
+         * Add a key/value to {@link #result(Map)}, creating the map if needed.
          */
-        public BuilderT putValue(String key, TValue value) {
-            if (this.value == null) {
-                this.value = new HashMap<>();
+        public BuilderT putResult(String key, TValue value) {
+            if (this.result == null) {
+                this.result = new HashMap<>();
             }
-            this.value.put(key, value);
+            this.result.put(key, value);
             return self();
         }
 
@@ -130,14 +138,14 @@ public BuilderT tValueSerializer(@Nullable JsonpSerializer<TValue> value) {
     }
 
     // ---------------------------------------------------------------------------------------------
-    protected static <TKey, TValue, BuilderT extends AbstractBuilder<TKey, TValue, BuilderT>> void setupAdditionalPropertiesDeserializer(
+    protected static <TKey, TValue, BuilderT extends AbstractBuilder<TKey, TValue, BuilderT>> void setupDictionaryResponseDeserializer(
         DelegatingDeserializer<BuilderT> op, JsonpDeserializer<TKey> tKeyParser,
         JsonpDeserializer<TValue> tValueParser) {
 
         @SuppressWarnings("unckecked")
         ObjectDeserializer<BuilderT> op1 = (ObjectDeserializer<BuilderT>)op;
         op1.setUnknownFieldHandler((builder, name, parser, params) -> {
-            builder.putValue(name, tValueParser.deserialize(parser, params));
+            builder.putResult(name, tValueParser.deserialize(parser, params));
         });
     }
 }

java-client/src/main/java/co/elastic/clients/base/ElasticsearchCatRequest.java

@@ -0,0 +1,26 @@
+/*
+ * 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.base;
+
+/**
+ * Marker interface for Elasticsearch cat requests.
+ */
+public interface ElasticsearchCatRequest {
+}

java-client/src/main/java/co/elastic/clients/base/ElasticsearchCommonRequest.java

@@ -0,0 +1,28 @@
+/*
+ * 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.base;
+
+/**
+ * Marker interface for Elasticsearch standard requests that accept common parameters.
+ *
+ * @see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html">Documentation</a>
+ */
+public interface ElasticsearchCommonRequest {
+}