588 - [FEATURE] serialize requests to JSON

CHANGELOG.md

@@ -12,6 +12,7 @@ This section is for maintaining a changelog for all breaking changes for the cli
 ### Added
 - Document HTTP/2 support ([#330](https://github.com/opensearch-project/opensearch-java/pull/330))
 - Add support for phase_took & search_pipeline request params ([#1036](https://github.com/opensearch-project/opensearch-java/pull/1036))
+- Add an interface PlainJsonSerializable inherit from JsonpSerializable with a default method streamlining serialization ([#1064](https://github.com/opensearch-project/opensearch-java/pull/1064))
 
 ### Dependencies
 

java-client/src/main/java/org/opensearch/client/json/JsonpUtils.java

@@ -32,9 +32,11 @@
 
 package org.opensearch.client.json;
 
+import jakarta.json.JsonException;
 import jakarta.json.JsonObject;
 import jakarta.json.JsonString;
 import jakarta.json.JsonValue;
+import jakarta.json.spi.JsonProvider;
 import jakarta.json.stream.JsonGenerator;
 import jakarta.json.stream.JsonLocation;
 import jakarta.json.stream.JsonParser;
@@ -59,6 +61,39 @@ public class JsonpUtils {
      *         JSON when advancing to next state.
      * @throws java.util.NoSuchElementException if there are no more parsing states.
      */
+
+    static final JsonProvider DEFAULT_PROVIDER = provider();
+
+    static JsonProvider provider() {
+        return JsonProvider.provider();
+    }
+
+    static final JsonpMapper DEFAULT_JSONP_MAPPER = new JsonpMapperBase() {
+        @Override
+        public JsonProvider jsonProvider() {
+            return DEFAULT_PROVIDER;
+        }
+
+        @Override
+        public <T> void serialize(T value, JsonGenerator generator) {
+            if (value instanceof JsonpSerializable) {
+                ((JsonpSerializable) value).serialize(generator, this);
+                return;
+            }
+
+            throw new JsonException(
+                "Cannot find a serializer for type " + value.getClass().getName() + ". Consider using a full-featured JsonpMapper."
+            );
+        }
+
+        @Override
+        protected <T> JsonpDeserializer<T> getDefaultDeserializer(Class<T> clazz) {
+            throw new JsonException(
+                "Cannot find a default deserializer for type " + clazz.getName() + ". Consider using a full-featured JsonpMapper."
+            );
+        }
+    };
+
     public static JsonParser.Event expectNextEvent(JsonParser parser, JsonParser.Event expected) {
         JsonParser.Event event = parser.next();
         expectEvent(parser, expected, event);

java-client/src/main/java/org/opensearch/client/json/PlainJsonSerializable.java

@@ -0,0 +1,37 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
+package org.opensearch.client.json;
+
+import jakarta.json.stream.JsonGenerator;
+import java.io.IOException;
+import java.io.StringWriter;
+import java.io.UncheckedIOException;
+
+public interface PlainJsonSerializable extends JsonpSerializable {
+
+    /**
+     * A default method which returns string representation for the instances of classes
+     * implementing JsonpSerializable interface.<br>
+     * Usage : Eg for SearchRequest.class<pre>{@code SearchRequest implements PlainJsonSerializable{..}
+     * SearchRequest searchRequest = SearchRequest.of(request -> request...);
+     * String searchRequestString = searchRequest.writeValueAsString();}</pre>  <br>
+     *
+     */
+    default String toJsonString() {
+        try (StringWriter writer = new StringWriter()) {
+            try (JsonGenerator generator = JsonpUtils.DEFAULT_PROVIDER.createGenerator(writer)) {
+                serialize(generator, JsonpUtils.DEFAULT_JSONP_MAPPER);
+            }
+            return writer.toString();
+        } catch (IOException ex) {
+            throw new UncheckedIOException(ex);
+        }
+    }
+
+}

java-client/src/main/java/org/opensearch/client/opensearch/_types/AcknowledgedResponseBase.java

@@ -35,14 +35,14 @@
 import jakarta.json.stream.JsonGenerator;
 import org.opensearch.client.json.JsonpDeserializer;
 import org.opensearch.client.json.JsonpMapper;
-import org.opensearch.client.json.JsonpSerializable;
 import org.opensearch.client.json.ObjectDeserializer;
+import org.opensearch.client.json.PlainJsonSerializable;
 import org.opensearch.client.util.ApiTypeHelper;
 import org.opensearch.client.util.ObjectBuilderBase;
 
 // typedef: _types.AcknowledgedResponseBase
 
-public abstract class AcknowledgedResponseBase implements JsonpSerializable {
+public abstract class AcknowledgedResponseBase implements PlainJsonSerializable {
     private final boolean acknowledged;
 
     // ---------------------------------------------------------------------------------------------

java-client/src/main/java/org/opensearch/client/opensearch/_types/BaseNode.java

@@ -38,14 +38,14 @@
 import javax.annotation.Nullable;
 import org.opensearch.client.json.JsonpDeserializer;
 import org.opensearch.client.json.JsonpMapper;
-import org.opensearch.client.json.JsonpSerializable;
 import org.opensearch.client.json.ObjectDeserializer;
+import org.opensearch.client.json.PlainJsonSerializable;
 import org.opensearch.client.util.ApiTypeHelper;
 import org.opensearch.client.util.ObjectBuilderBase;
 
 // typedef: _spec_utils.BaseNode
 
-public abstract class BaseNode implements JsonpSerializable {
+public abstract class BaseNode implements PlainJsonSerializable {
     private final Map<String, String> attributes;
 
     private final String host;

java-client/src/main/java/org/opensearch/client/opensearch/_types/BulkIndexByScrollFailure.java

@@ -37,17 +37,17 @@
 import org.opensearch.client.json.JsonpDeserializable;
 import org.opensearch.client.json.JsonpDeserializer;
 import org.opensearch.client.json.JsonpMapper;
-import org.opensearch.client.json.JsonpSerializable;
 import org.opensearch.client.json.ObjectBuilderDeserializer;
 import org.opensearch.client.json.ObjectDeserializer;
+import org.opensearch.client.json.PlainJsonSerializable;
 import org.opensearch.client.util.ApiTypeHelper;
 import org.opensearch.client.util.ObjectBuilder;
 import org.opensearch.client.util.ObjectBuilderBase;
 
 // typedef: _types.BulkIndexByScrollFailure
 
 @JsonpDeserializable
-public class BulkIndexByScrollFailure implements JsonpSerializable {
+public class BulkIndexByScrollFailure implements PlainJsonSerializable {
     private final ErrorCause cause;
 
     private final String id;

java-client/src/main/java/org/opensearch/client/opensearch/_types/BulkStats.java

@@ -38,17 +38,17 @@
 import org.opensearch.client.json.JsonpDeserializable;
 import org.opensearch.client.json.JsonpDeserializer;
 import org.opensearch.client.json.JsonpMapper;
-import org.opensearch.client.json.JsonpSerializable;
 import org.opensearch.client.json.ObjectBuilderDeserializer;
 import org.opensearch.client.json.ObjectDeserializer;
+import org.opensearch.client.json.PlainJsonSerializable;
 import org.opensearch.client.util.ApiTypeHelper;
 import org.opensearch.client.util.ObjectBuilder;
 import org.opensearch.client.util.ObjectBuilderBase;
 
 // typedef: _types.BulkStats
 
 @JsonpDeserializable
-public class BulkStats implements JsonpSerializable {
+public class BulkStats implements PlainJsonSerializable {
     private final long totalOperations;
 
     @Nullable

java-client/src/main/java/org/opensearch/client/opensearch/_types/ClusterStatistics.java

@@ -37,17 +37,17 @@
 import org.opensearch.client.json.JsonpDeserializable;
 import org.opensearch.client.json.JsonpDeserializer;
 import org.opensearch.client.json.JsonpMapper;
-import org.opensearch.client.json.JsonpSerializable;
 import org.opensearch.client.json.ObjectBuilderDeserializer;
 import org.opensearch.client.json.ObjectDeserializer;
+import org.opensearch.client.json.PlainJsonSerializable;
 import org.opensearch.client.util.ApiTypeHelper;
 import org.opensearch.client.util.ObjectBuilder;
 import org.opensearch.client.util.ObjectBuilderBase;
 
 // typedef: _types.ClusterStatistics
 
 @JsonpDeserializable
-public class ClusterStatistics implements JsonpSerializable {
+public class ClusterStatistics implements PlainJsonSerializable {
     private final int skipped;
 
     private final int successful;

java-client/src/main/java/org/opensearch/client/opensearch/_types/CompletionStats.java

@@ -39,17 +39,17 @@
 import org.opensearch.client.json.JsonpDeserializable;
 import org.opensearch.client.json.JsonpDeserializer;
 import org.opensearch.client.json.JsonpMapper;
-import org.opensearch.client.json.JsonpSerializable;
 import org.opensearch.client.json.ObjectBuilderDeserializer;
 import org.opensearch.client.json.ObjectDeserializer;
+import org.opensearch.client.json.PlainJsonSerializable;
 import org.opensearch.client.util.ApiTypeHelper;
 import org.opensearch.client.util.ObjectBuilder;
 import org.opensearch.client.util.ObjectBuilderBase;
 
 // typedef: _types.CompletionStats
 
 @JsonpDeserializable
-public class CompletionStats implements JsonpSerializable {
+public class CompletionStats implements PlainJsonSerializable {
     private final long sizeInBytes;
 
     @Nullable

java-client/src/main/java/org/opensearch/client/opensearch/_types/CoordsGeoBounds.java

@@ -37,17 +37,17 @@
 import org.opensearch.client.json.JsonpDeserializable;
 import org.opensearch.client.json.JsonpDeserializer;
 import org.opensearch.client.json.JsonpMapper;
-import org.opensearch.client.json.JsonpSerializable;
 import org.opensearch.client.json.ObjectBuilderDeserializer;
 import org.opensearch.client.json.ObjectDeserializer;
+import org.opensearch.client.json.PlainJsonSerializable;
 import org.opensearch.client.util.ApiTypeHelper;
 import org.opensearch.client.util.ObjectBuilder;
 import org.opensearch.client.util.ObjectBuilderBase;
 
 // typedef: _types.CoordsGeoBounds
 
 @JsonpDeserializable
-public class CoordsGeoBounds implements JsonpSerializable {
+public class CoordsGeoBounds implements PlainJsonSerializable {
     private final double top;
 
     private final double bottom;

java-client/src/main/java/org/opensearch/client/opensearch/_types/DocStats.java

@@ -37,17 +37,17 @@
 import org.opensearch.client.json.JsonpDeserializable;
 import org.opensearch.client.json.JsonpDeserializer;
 import org.opensearch.client.json.JsonpMapper;
-import org.opensearch.client.json.JsonpSerializable;
 import org.opensearch.client.json.ObjectBuilderDeserializer;
 import org.opensearch.client.json.ObjectDeserializer;
+import org.opensearch.client.json.PlainJsonSerializable;
 import org.opensearch.client.util.ApiTypeHelper;
 import org.opensearch.client.util.ObjectBuilder;
 import org.opensearch.client.util.ObjectBuilderBase;
 
 // typedef: _types.DocStats
 
 @JsonpDeserializable
-public class DocStats implements JsonpSerializable {
+public class DocStats implements PlainJsonSerializable {
     private final long count;
 
     private final long deleted;

java-client/src/main/java/org/opensearch/client/opensearch/_types/EmptyObject.java

@@ -36,15 +36,15 @@
 import org.opensearch.client.json.JsonpDeserializable;
 import org.opensearch.client.json.JsonpDeserializer;
 import org.opensearch.client.json.JsonpMapper;
-import org.opensearch.client.json.JsonpSerializable;
+import org.opensearch.client.json.PlainJsonSerializable;
 import org.opensearch.client.util.ObjectBuilder;
 
 /**
  * For empty Class assignments
  *
  */
 @JsonpDeserializable
-public class EmptyObject implements JsonpSerializable {
+public class EmptyObject implements PlainJsonSerializable {
 
     public static final class Builder implements ObjectBuilder<EmptyObject> {
         @Override

java-client/src/main/java/org/opensearch/client/opensearch/_types/EmptyTransform.java

@@ -36,11 +36,11 @@
 import org.opensearch.client.json.JsonpDeserializable;
 import org.opensearch.client.json.JsonpDeserializer;
 import org.opensearch.client.json.JsonpMapper;
-import org.opensearch.client.json.JsonpSerializable;
+import org.opensearch.client.json.PlainJsonSerializable;
 import org.opensearch.client.util.ObjectBuilder;
 
 @JsonpDeserializable
-public class EmptyTransform implements JsonpSerializable {
+public class EmptyTransform implements PlainJsonSerializable {
 
     public static final class Builder implements ObjectBuilder<EmptyTransform> {
         @Override

java-client/src/main/java/org/opensearch/client/opensearch/_types/ErrorCause.java

@@ -42,9 +42,9 @@
 import org.opensearch.client.json.JsonpDeserializable;
 import org.opensearch.client.json.JsonpDeserializer;
 import org.opensearch.client.json.JsonpMapper;
-import org.opensearch.client.json.JsonpSerializable;
 import org.opensearch.client.json.ObjectBuilderDeserializer;
 import org.opensearch.client.json.ObjectDeserializer;
+import org.opensearch.client.json.PlainJsonSerializable;
 import org.opensearch.client.util.ApiTypeHelper;
 import org.opensearch.client.util.ObjectBuilder;
 import org.opensearch.client.util.ObjectBuilderBase;
@@ -57,7 +57,7 @@
  * on the error type.
  */
 @JsonpDeserializable
-public class ErrorCause implements JsonpSerializable {
+public class ErrorCause implements PlainJsonSerializable {
     private final Map<String, JsonData> metadata;
 
     private final String type;

java-client/src/main/java/org/opensearch/client/opensearch/_types/ErrorResponse.java

@@ -37,9 +37,9 @@
 import org.opensearch.client.json.JsonpDeserializable;
 import org.opensearch.client.json.JsonpDeserializer;
 import org.opensearch.client.json.JsonpMapper;
-import org.opensearch.client.json.JsonpSerializable;
 import org.opensearch.client.json.ObjectBuilderDeserializer;
 import org.opensearch.client.json.ObjectDeserializer;
+import org.opensearch.client.json.PlainJsonSerializable;
 import org.opensearch.client.json.UnionDeserializer;
 import org.opensearch.client.util.ApiTypeHelper;
 import org.opensearch.client.util.ObjectBuilder;
@@ -53,7 +53,7 @@
  *
  */
 @JsonpDeserializable
-public class ErrorResponse implements JsonpSerializable {
+public class ErrorResponse implements PlainJsonSerializable {
 
     private enum Kind {
         OBJECT,

java-client/src/main/java/org/opensearch/client/opensearch/_types/FieldMemoryUsage.java

@@ -38,17 +38,17 @@
 import org.opensearch.client.json.JsonpDeserializable;
 import org.opensearch.client.json.JsonpDeserializer;
 import org.opensearch.client.json.JsonpMapper;
-import org.opensearch.client.json.JsonpSerializable;
 import org.opensearch.client.json.ObjectBuilderDeserializer;
 import org.opensearch.client.json.ObjectDeserializer;
+import org.opensearch.client.json.PlainJsonSerializable;
 import org.opensearch.client.util.ApiTypeHelper;
 import org.opensearch.client.util.ObjectBuilder;
 import org.opensearch.client.util.ObjectBuilderBase;
 
 // typedef: _types.FieldMemoryUsage
 
 @JsonpDeserializable
-public class FieldMemoryUsage implements JsonpSerializable {
+public class FieldMemoryUsage implements PlainJsonSerializable {
     @Nullable
     private final String memorySize;
 

java-client/src/main/java/org/opensearch/client/opensearch/_types/FieldSizeUsage.java

@@ -38,17 +38,17 @@
 import org.opensearch.client.json.JsonpDeserializable;
 import org.opensearch.client.json.JsonpDeserializer;
 import org.opensearch.client.json.JsonpMapper;
-import org.opensearch.client.json.JsonpSerializable;
 import org.opensearch.client.json.ObjectBuilderDeserializer;
 import org.opensearch.client.json.ObjectDeserializer;
+import org.opensearch.client.json.PlainJsonSerializable;
 import org.opensearch.client.util.ApiTypeHelper;
 import org.opensearch.client.util.ObjectBuilder;
 import org.opensearch.client.util.ObjectBuilderBase;
 
 // typedef: _types.FieldSizeUsage
 
 @JsonpDeserializable
-public class FieldSizeUsage implements JsonpSerializable {
+public class FieldSizeUsage implements PlainJsonSerializable {
     @Nullable
     private final String size;
 

java-client/src/main/java/org/opensearch/client/opensearch/_types/FieldSort.java

@@ -38,9 +38,9 @@
 import org.opensearch.client.json.JsonpDeserializable;
 import org.opensearch.client.json.JsonpDeserializer;
 import org.opensearch.client.json.JsonpMapper;
-import org.opensearch.client.json.JsonpSerializable;
 import org.opensearch.client.json.ObjectBuilderDeserializer;
 import org.opensearch.client.json.ObjectDeserializer;
+import org.opensearch.client.json.PlainJsonSerializable;
 import org.opensearch.client.opensearch._types.mapping.FieldType;
 import org.opensearch.client.util.ApiTypeHelper;
 import org.opensearch.client.util.ObjectBuilder;
@@ -49,7 +49,7 @@
 // typedef: _types.FieldSort
 
 @JsonpDeserializable
-public class FieldSort implements JsonpSerializable {
+public class FieldSort implements PlainJsonSerializable {
     // Single key dictionary
     private final String field;