Common MessageWriter abstraction

Author: jack-berg

docs/apidiffs/current_vs_latest/opentelemetry-exporter-common.txt

@@ -9,23 +9,17 @@ Comparing source compatibility of opentelemetry-exporter-common-1.58.0-SNAPSHOT.
 	+++  CLASS FILE FORMAT VERSION: 52.0 <- n.a.
 	+++  NEW SUPERCLASS: java.lang.Object
 	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) io.opentelemetry.exporter.compressor.Compressor getInstance()
-+++  NEW INTERFACE: PUBLIC(+) ABSTRACT(+) io.opentelemetry.exporter.grpc.GrpcMessageWriter  (not serializable)
-	+++  CLASS FILE FORMAT VERSION: 52.0 <- n.a.
-	+++  NEW SUPERCLASS: java.lang.Object
-	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) int getContentLength()
-	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) void writeMessage(java.io.OutputStream)
-		+++  NEW EXCEPTION: java.io.IOException
 +++  NEW INTERFACE: PUBLIC(+) ABSTRACT(+) io.opentelemetry.exporter.grpc.GrpcResponse  (not serializable)
 	+++  CLASS FILE FORMAT VERSION: 52.0 <- n.a.
 	+++  NEW SUPERCLASS: java.lang.Object
-	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) byte[] getResponseMessage()
+	+++  NEW METHOD: PUBLIC(+) byte[] getResponseMessage()
 	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) io.opentelemetry.exporter.grpc.GrpcStatusCode getStatusCode()
 	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) java.lang.String getStatusDescription()
 		+++  NEW ANNOTATION: javax.annotation.Nullable
 +++  NEW INTERFACE: PUBLIC(+) ABSTRACT(+) io.opentelemetry.exporter.grpc.GrpcSender  (not serializable)
 	+++  CLASS FILE FORMAT VERSION: 52.0 <- n.a.
 	+++  NEW SUPERCLASS: java.lang.Object
-	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) void send(io.opentelemetry.exporter.grpc.GrpcMessageWriter, java.util.function.Consumer<io.opentelemetry.exporter.grpc.GrpcResponse>, java.util.function.Consumer<java.lang.Throwable>)
+	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) void send(io.opentelemetry.exporter.marshal.MessageWriter, java.util.function.Consumer<io.opentelemetry.exporter.grpc.GrpcResponse>, java.util.function.Consumer<java.lang.Throwable>)
 	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) io.opentelemetry.sdk.common.CompletableResultCode shutdown()
 +++  NEW INTERFACE: PUBLIC(+) ABSTRACT(+) io.opentelemetry.exporter.grpc.GrpcSenderConfig  (not serializable)
 	+++  CLASS FILE FORMAT VERSION: 52.0 <- n.a.
@@ -76,22 +70,16 @@ Comparing source compatibility of opentelemetry-exporter-common-1.58.0-SNAPSHOT.
 	+++  NEW METHOD: PUBLIC(+) int getValue()
 	+++  NEW METHOD: PUBLIC(+) STATIC(+) io.opentelemetry.exporter.grpc.GrpcStatusCode valueOf(java.lang.String)
 	+++  NEW METHOD: PUBLIC(+) STATIC(+) io.opentelemetry.exporter.grpc.GrpcStatusCode[] values()
-+++  NEW INTERFACE: PUBLIC(+) ABSTRACT(+) io.opentelemetry.exporter.http.HttpRequestBodyWriter  (not serializable)
-	+++  CLASS FILE FORMAT VERSION: 52.0 <- n.a.
-	+++  NEW SUPERCLASS: java.lang.Object
-	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) int contentLength()
-	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) void writeRequestBody(java.io.OutputStream)
-		+++  NEW EXCEPTION: java.io.IOException
 +++  NEW INTERFACE: PUBLIC(+) ABSTRACT(+) io.opentelemetry.exporter.http.HttpResponse  (not serializable)
 	+++  CLASS FILE FORMAT VERSION: 52.0 <- n.a.
 	+++  NEW SUPERCLASS: java.lang.Object
-	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) byte[] getResponseBody()
+	+++  NEW METHOD: PUBLIC(+) byte[] getResponseBody()
 	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) int getStatusCode()
 	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) java.lang.String getStatusMessage()
 +++  NEW INTERFACE: PUBLIC(+) ABSTRACT(+) io.opentelemetry.exporter.http.HttpSender  (not serializable)
 	+++  CLASS FILE FORMAT VERSION: 52.0 <- n.a.
 	+++  NEW SUPERCLASS: java.lang.Object
-	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) void send(io.opentelemetry.exporter.http.HttpRequestBodyWriter, java.util.function.Consumer<io.opentelemetry.exporter.http.HttpResponse>, java.util.function.Consumer<java.lang.Throwable>)
+	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) void send(io.opentelemetry.exporter.marshal.MessageWriter, java.util.function.Consumer<io.opentelemetry.exporter.http.HttpResponse>, java.util.function.Consumer<java.lang.Throwable>)
 	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) io.opentelemetry.sdk.common.CompletableResultCode shutdown()
 +++  NEW INTERFACE: PUBLIC(+) ABSTRACT(+) io.opentelemetry.exporter.http.HttpSenderConfig  (not serializable)
 	+++  CLASS FILE FORMAT VERSION: 52.0 <- n.a.
@@ -117,3 +105,9 @@ Comparing source compatibility of opentelemetry-exporter-common-1.58.0-SNAPSHOT.
 	+++  CLASS FILE FORMAT VERSION: 52.0 <- n.a.
 	+++  NEW SUPERCLASS: java.lang.Object
 	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) io.opentelemetry.exporter.http.HttpSender createSender(io.opentelemetry.exporter.http.HttpSenderConfig)
++++  NEW INTERFACE: PUBLIC(+) ABSTRACT(+) io.opentelemetry.exporter.marshal.MessageWriter  (not serializable)
+	+++  CLASS FILE FORMAT VERSION: 52.0 <- n.a.
+	+++  NEW SUPERCLASS: java.lang.Object
+	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) int getContentLength()
+	+++  NEW METHOD: PUBLIC(+) ABSTRACT(+) void writeMessage(java.io.OutputStream)
+		+++  NEW EXCEPTION: java.io.IOException

exporters/common/src/main/java/io/opentelemetry/exporter/grpc/GrpcMessageWriter.java

@@ -5,14 +5,15 @@
 
 package io.opentelemetry.exporter.grpc;
 
+import io.opentelemetry.exporter.marshal.MessageWriter;
 import java.util.function.Consumer;
 import javax.annotation.Nullable;
 import javax.annotation.concurrent.Immutable;
 
 /**
  * A gRPC response.
  *
- * @see GrpcSender#send(GrpcMessageWriter, Consumer, Consumer)
+ * @see GrpcSender#send(MessageWriter, Consumer, Consumer)
  */
 @Immutable
 public interface GrpcResponse {
@@ -26,5 +27,7 @@ public interface GrpcResponse {
 
   /** The gRPC response message bytes. */
   @SuppressWarnings("mutable")
-  byte[] getResponseMessage();
+  default byte[] getResponseMessage() {
+    return new byte[0];
+  }
 }

exporters/common/src/main/java/io/opentelemetry/exporter/grpc/GrpcResponse.java

@@ -5,6 +5,7 @@
 
 package io.opentelemetry.exporter.grpc;
 
+import io.opentelemetry.exporter.marshal.MessageWriter;
 import io.opentelemetry.sdk.common.CompletableResultCode;
 import java.util.function.Consumer;
 
@@ -31,9 +32,7 @@ public interface GrpcSender {
    * @param onError the callback to invoke when the gRPC call could not be executed
    */
   void send(
-      GrpcMessageWriter messageWriter,
-      Consumer<GrpcResponse> onResponse,
-      Consumer<Throwable> onError);
+      MessageWriter messageWriter, Consumer<GrpcResponse> onResponse, Consumer<Throwable> onError);
 
   /** Shutdown the sender. */
   CompletableResultCode shutdown();

exporters/common/src/main/java/io/opentelemetry/exporter/grpc/GrpcSender.java

@@ -6,6 +6,7 @@
 package io.opentelemetry.exporter.grpc;
 
 import io.opentelemetry.exporter.compressor.Compressor;
+import io.opentelemetry.exporter.marshal.MessageWriter;
 import io.opentelemetry.sdk.common.export.RetryPolicy;
 import java.io.OutputStream;
 import java.net.URI;
@@ -41,8 +42,8 @@ public interface GrpcSenderConfig {
   /**
    * The compressor, or {@code null} if no compression is used. If present, {@link
    * Compressor#compress(OutputStream)} must be applied to {@link
-   * GrpcMessageWriter#writeMessage(OutputStream)} when {@link GrpcSender#send(GrpcMessageWriter,
-   * Consumer, Consumer)} is called and {@link Compressor#getEncoding()} must be set as the {@code
+   * MessageWriter#writeMessage(OutputStream)} when {@link GrpcSender#send(MessageWriter, Consumer,
+   * Consumer)} is called and {@link Compressor#getEncoding()} must be set as the {@code
    * grpc-encoding}.
    */
   @Nullable

exporters/common/src/main/java/io/opentelemetry/exporter/grpc/GrpcSenderConfig.java

@@ -5,13 +5,14 @@
 
 package io.opentelemetry.exporter.http;
 
+import io.opentelemetry.exporter.marshal.MessageWriter;
 import java.util.function.Consumer;
 import javax.annotation.concurrent.Immutable;
 
 /**
  * A HTTP response.
  *
- * @see HttpSender#send(HttpRequestBodyWriter, Consumer, Consumer)
+ * @see HttpSender#send(MessageWriter, Consumer, Consumer)
  */
 @Immutable
 public interface HttpResponse {
@@ -23,5 +24,8 @@ public interface HttpResponse {
   String getStatusMessage();
 
   /** The HTTP response body bytes. */
-  byte[] getResponseBody();
+  @SuppressWarnings("mutable")
+  default byte[] getResponseBody() {
+    return new byte[0];
+  }
 }

exporters/common/src/main/java/io/opentelemetry/exporter/http/HttpRequestBodyWriter.java

@@ -5,6 +5,7 @@
 
 package io.opentelemetry.exporter.http;
 
+import io.opentelemetry.exporter.marshal.MessageWriter;
 import io.opentelemetry.sdk.common.CompletableResultCode;
 import java.util.function.Consumer;
 
@@ -26,14 +27,12 @@ public interface HttpSender {
    * called when the request could not be executed due to cancellation, connectivity problems, or
    * timeout.
    *
-   * @param requestBodyWriter the request body writer
+   * @param messageWriter the request body message writer
    * @param onResponse the callback to invoke with the HTTP response
    * @param onError the callback to invoke when the HTTP request could not be executed
    */
   void send(
-      HttpRequestBodyWriter requestBodyWriter,
-      Consumer<HttpResponse> onResponse,
-      Consumer<Throwable> onError);
+      MessageWriter messageWriter, Consumer<HttpResponse> onResponse, Consumer<Throwable> onError);
 
   /** Shutdown the sender. */
   CompletableResultCode shutdown();

exporters/common/src/main/java/io/opentelemetry/exporter/http/HttpResponse.java

@@ -6,6 +6,7 @@
 package io.opentelemetry.exporter.http;
 
 import io.opentelemetry.exporter.compressor.Compressor;
+import io.opentelemetry.exporter.marshal.MessageWriter;
 import io.opentelemetry.sdk.common.export.ProxyOptions;
 import io.opentelemetry.sdk.common.export.RetryPolicy;
 import java.io.OutputStream;
@@ -36,9 +37,9 @@ public interface HttpSenderConfig {
   /**
    * The compressor, or {@code null} if no compression is used. If present, {@link
    * Compressor#compress(OutputStream)} must be applied to {@link
-   * HttpRequestBodyWriter#writeRequestBody(OutputStream)} when {@link
-   * HttpSender#send(HttpRequestBodyWriter, Consumer, Consumer)} is called and {@link
-   * Compressor#getEncoding()} must be set as the {@code Content-Encoding} header.
+   * MessageWriter#writeMessage(OutputStream)} when {@link HttpSender#send(MessageWriter, Consumer,
+   * Consumer)} is called and {@link Compressor#getEncoding()} must be set as the {@code
+   * Content-Encoding} header.
    */
   @Nullable
   Compressor getCompressor();

exporters/common/src/main/java/io/opentelemetry/exporter/http/HttpSender.java

@@ -67,7 +67,7 @@ public CompletableResultCode export(Marshaler exportRequest, int numItems) {
     CompletableResultCode result = new CompletableResultCode();
 
     grpcSender.send(
-        exportRequest.toGrpcRequestBodyWriter(),
+        exportRequest.toMessageWriter(false),
         grpcResponse -> onResponse(result, metricRecording, grpcResponse),
         throwable -> onError(result, metricRecording, throwable));