Rename streamContent/Separator to bulkContent/Separator (elastic#111716)

Rename `xContent.streamSeparator()` and
`RestHandler.supportsStreamContent()` to `xContent.bulkSeparator()` and
`RestHandler.supportsBulkContent()`.

I want to reserve use of "supportsStreamContent" for current work in
HTTP layer to [support incremental content
handling](elastic#111438) besides
fully aggregated byte buffers. `supportsStreamContent` would indicate
that handler can parse chunks of http content as they arrive.

libs/x-content/impl/src/main/java/org/elasticsearch/xcontent/provider/cbor/CborXContentImpl.java

@@ -63,8 +63,8 @@ public XContentType type() {
     }
 
     @Override
-    public byte streamSeparator() {
-        throw new XContentParseException("cbor does not support stream parsing...");
+    public byte bulkSeparator() {
+        throw new XContentParseException("cbor does not support bulk parsing...");
     }
 
     @Override

libs/x-content/impl/src/main/java/org/elasticsearch/xcontent/provider/json/JsonXContentImpl.java

@@ -65,7 +65,7 @@ public XContentType type() {
     }
 
     @Override
-    public byte streamSeparator() {
+    public byte bulkSeparator() {
         return '\n';
     }
 

libs/x-content/impl/src/main/java/org/elasticsearch/xcontent/provider/smile/SmileXContentImpl.java

@@ -65,7 +65,7 @@ public XContentType type() {
     }
 
     @Override
-    public byte streamSeparator() {
+    public byte bulkSeparator() {
         return (byte) 0xFF;
     }
 

libs/x-content/impl/src/main/java/org/elasticsearch/xcontent/provider/yaml/YamlXContentImpl.java

@@ -61,8 +61,8 @@ public XContentType type() {
     }
 
     @Override
-    public byte streamSeparator() {
-        throw new UnsupportedOperationException("yaml does not support stream parsing...");
+    public byte bulkSeparator() {
+        throw new UnsupportedOperationException("yaml does not support bulk parsing...");
     }
 
     @Override

libs/x-content/src/main/java/org/elasticsearch/xcontent/XContent.java

@@ -24,7 +24,7 @@ public interface XContent {
      */
     XContentType type();
 
-    byte streamSeparator();
+    byte bulkSeparator();
 
     @Deprecated
     boolean detectContent(byte[] bytes, int offset, int length);

modules/lang-mustache/src/main/java/org/elasticsearch/script/mustache/MultiSearchTemplateRequest.java

@@ -142,12 +142,12 @@ public static byte[] writeMultiLineFormat(MultiSearchTemplateRequest multiSearch
                 MultiSearchRequest.writeSearchRequestParams(searchRequest, xContentBuilder);
                 BytesReference.bytes(xContentBuilder).writeTo(output);
             }
-            output.write(xContent.streamSeparator());
+            output.write(xContent.bulkSeparator());
             try (XContentBuilder xContentBuilder = XContentBuilder.builder(xContent)) {
                 templateRequest.toXContent(xContentBuilder, ToXContent.EMPTY_PARAMS);
                 BytesReference.bytes(xContentBuilder).writeTo(output);
             }
-            output.write(xContent.streamSeparator());
+            output.write(xContent.bulkSeparator());
         }
         return output.toByteArray();
     }

modules/lang-mustache/src/main/java/org/elasticsearch/script/mustache/RestMultiSearchTemplateAction.java

@@ -94,7 +94,7 @@ public static MultiSearchTemplateRequest parseRequest(RestRequest restRequest, b
     }
 
     @Override
-    public boolean supportsContentStream() {
+    public boolean supportsBulkContent() {
         return true;
     }
 

server/src/main/java/org/elasticsearch/action/bulk/BulkRequestParser.java

@@ -139,7 +139,7 @@ public void parse(
         XContent xContent = xContentType.xContent();
         int line = 0;
         int from = 0;
-        byte marker = xContent.streamSeparator();
+        byte marker = xContent.bulkSeparator();
         // Bulk requests can contain a lot of repeated strings for the index, pipeline and routing parameters. This map is used to
         // deduplicate duplicate strings parsed for these parameters. While it does not prevent instantiating the duplicate strings, it
         // reduces their lifetime to the lifetime of this parse call instead of the lifetime of the full bulk request.

server/src/main/java/org/elasticsearch/action/search/MultiSearchRequest.java

@@ -206,7 +206,7 @@ public static void readMultiLineFormat(
         TriFunction<String, Object, SearchRequest, Boolean> extraParamParser
     ) throws IOException {
         int from = 0;
-        byte marker = xContent.streamSeparator();
+        byte marker = xContent.bulkSeparator();
         while (true) {
             int nextMarker = findNextMarker(marker, from, data);
             if (nextMarker == -1) {
@@ -343,7 +343,7 @@ public static byte[] writeMultiLineFormat(MultiSearchRequest multiSearchRequest,
                 writeSearchRequestParams(request, xContentBuilder);
                 BytesReference.bytes(xContentBuilder).writeTo(output);
             }
-            output.write(xContent.streamSeparator());
+            output.write(xContent.bulkSeparator());
             try (XContentBuilder xContentBuilder = XContentBuilder.builder(xContent)) {
                 if (request.source() != null) {
                     request.source().toXContent(xContentBuilder, ToXContent.EMPTY_PARAMS);
@@ -353,7 +353,7 @@ public static byte[] writeMultiLineFormat(MultiSearchRequest multiSearchRequest,
                 }
                 BytesReference.bytes(xContentBuilder).writeTo(output);
             }
-            output.write(xContent.streamSeparator());
+            output.write(xContent.bulkSeparator());
         }
         return output.toByteArray();
     }

server/src/main/java/org/elasticsearch/rest/FilterRestHandler.java

@@ -48,8 +48,8 @@ public boolean allowsUnsafeBuffers() {
     }
 
     @Override
-    public boolean supportsContentStream() {
-        return delegate.supportsContentStream();
+    public boolean supportsBulkContent() {
+        return delegate.supportsBulkContent();
     }
 
     @Override

server/src/main/java/org/elasticsearch/rest/RestController.java

@@ -432,7 +432,7 @@ private void dispatchRequest(
             }
             final XContentType xContentType = request.getXContentType();
             // TODO consider refactoring to handler.supportsContentStream(xContentType). It is only used with JSON and SMILE
-            if (handler.supportsContentStream()
+            if (handler.supportsBulkContent()
                 && XContentType.JSON != xContentType.canonical()
                 && XContentType.SMILE != xContentType.canonical()) {
                 channel.sendResponse(

server/src/main/java/org/elasticsearch/rest/RestHandler.java

@@ -39,11 +39,11 @@ default boolean canTripCircuitBreaker() {
     }
 
     /**
-     * Indicates if the RestHandler supports content as a stream. A stream would be multiple objects delineated by
-     * {@link XContent#streamSeparator()}. If a handler returns true this will affect the types of content that can be sent to
-     * this endpoint.
+     * Indicates if the RestHandler supports bulk content. A bulk request contains multiple objects
+     * delineated by {@link XContent#bulkSeparator()}. If a handler returns true this will affect
+     * the types of content that can be sent to this endpoint.
      */
-    default boolean supportsContentStream() {
+    default boolean supportsBulkContent() {
         return false;
     }
 

server/src/main/java/org/elasticsearch/rest/action/document/RestBulkAction.java

@@ -101,7 +101,7 @@ public RestChannelConsumer prepareRequest(final RestRequest request, final NodeC
     }
 
     @Override
-    public boolean supportsContentStream() {
+    public boolean supportsBulkContent() {
         return true;
     }
 

server/src/main/java/org/elasticsearch/rest/action/search/RestMultiSearchAction.java

@@ -209,7 +209,7 @@ public static void parseMultiLineRequest(
     }
 
     @Override
-    public boolean supportsContentStream() {
+    public boolean supportsBulkContent() {
         return true;
     }
 

server/src/test/java/org/elasticsearch/action/bulk/BulkRequestTests.java

@@ -290,13 +290,13 @@ public void testSmileIsSupported() throws IOException {
                 builder.endObject();
                 builder.endObject();
             }
-            out.write(xContentType.xContent().streamSeparator());
+            out.write(xContentType.xContent().bulkSeparator());
             try (XContentBuilder builder = XContentFactory.contentBuilder(xContentType, out)) {
                 builder.startObject();
                 builder.field("field", "value");
                 builder.endObject();
             }
-            out.write(xContentType.xContent().streamSeparator());
+            out.write(xContentType.xContent().bulkSeparator());
             data = out.bytes();
         }
 
@@ -327,7 +327,7 @@ public void testToValidateUpsertRequestAndCASInBulkRequest() throws IOException
                 builder.endObject();
                 builder.endObject();
             }
-            out.write(xContentType.xContent().streamSeparator());
+            out.write(xContentType.xContent().bulkSeparator());
             try (XContentBuilder builder = XContentFactory.contentBuilder(xContentType, out)) {
                 builder.startObject();
                 builder.startObject("doc").endObject();
@@ -338,7 +338,7 @@ public void testToValidateUpsertRequestAndCASInBulkRequest() throws IOException
                 builder.field("upsert", values);
                 builder.endObject();
             }
-            out.write(xContentType.xContent().streamSeparator());
+            out.write(xContentType.xContent().bulkSeparator());
             data = out.bytes();
         }
         BulkRequest bulkRequest = new BulkRequest();

server/src/test/java/org/elasticsearch/rest/DeprecationRestHandlerTests.java

@@ -155,17 +155,17 @@ public void testInvalidHeaderValueEmpty() {
         expectThrows(IllegalArgumentException.class, () -> DeprecationRestHandler.requireValidHeader(blank));
     }
 
-    public void testSupportsContentStreamTrue() {
-        when(handler.supportsContentStream()).thenReturn(true);
+    public void testSupportsBulkContentTrue() {
+        when(handler.supportsBulkContent()).thenReturn(true);
         assertTrue(
-            new DeprecationRestHandler(handler, METHOD, PATH, null, deprecationMessage, deprecationLogger, false).supportsContentStream()
+            new DeprecationRestHandler(handler, METHOD, PATH, null, deprecationMessage, deprecationLogger, false).supportsBulkContent()
         );
     }
 
-    public void testSupportsContentStreamFalse() {
-        when(handler.supportsContentStream()).thenReturn(false);
+    public void testSupportsBulkContentFalse() {
+        when(handler.supportsBulkContent()).thenReturn(false);
         assertFalse(
-            new DeprecationRestHandler(handler, METHOD, PATH, null, deprecationMessage, deprecationLogger, false).supportsContentStream()
+            new DeprecationRestHandler(handler, METHOD, PATH, null, deprecationMessage, deprecationLogger, false).supportsBulkContent()
         );
     }
 

server/src/test/java/org/elasticsearch/rest/RestControllerTests.java

@@ -598,7 +598,7 @@ public void handleRequest(RestRequest request, RestChannel channel, NodeClient c
             }
 
             @Override
-            public boolean supportsContentStream() {
+            public boolean supportsBulkContent() {
                 return true;
             }
         });
@@ -637,7 +637,7 @@ public void handleRequest(RestRequest request, RestChannel channel, NodeClient c
             }
 
             @Override
-            public boolean supportsContentStream() {
+            public boolean supportsBulkContent() {
                 return true;
             }
         });
@@ -662,7 +662,7 @@ public void handleRequest(RestRequest request, RestChannel channel, NodeClient c
             }
 
             @Override
-            public boolean supportsContentStream() {
+            public boolean supportsBulkContent() {
                 return true;
             }
         });
@@ -688,7 +688,7 @@ public void handleRequest(RestRequest request, RestChannel channel, NodeClient c
             }
 
             @Override
-            public boolean supportsContentStream() {
+            public boolean supportsBulkContent() {
                 return true;
             }
         });
@@ -713,7 +713,7 @@ public void handleRequest(RestRequest request, RestChannel channel, NodeClient c
             }
 
             @Override
-            public boolean supportsContentStream() {
+            public boolean supportsBulkContent() {
                 return true;
             }
         });

test/yaml-rest-runner/src/main/java/org/elasticsearch/test/rest/yaml/ClientYamlTestExecutionContext.java

@@ -200,7 +200,7 @@ private HttpEntity createEntity(List<Map<String, Object>> bodies, Map<String, St
                 for (int i = bytesRef.offset; i < bytesRef.length; i++) {
                     bytes[position++] = bytesRef.bytes[i];
                 }
-                bytes[position++] = xContentType.xContent().streamSeparator();
+                bytes[position++] = xContentType.xContent().bulkSeparator();
             }
             return new ByteArrayEntity(bytes, ContentType.create(xContentType.mediaTypeWithoutParameters(), StandardCharsets.UTF_8));
         }

x-pack/plugin/ml/src/main/java/org/elasticsearch/xpack/ml/job/process/autodetect/writer/JsonDataToProcessWriter.java

@@ -91,7 +91,7 @@ private void writeJsonXContent(CategorizationAnalyzer categorizationAnalyzer, In
 
     private void writeSmileXContent(CategorizationAnalyzer categorizationAnalyzer, InputStream inputStream) throws IOException {
         while (true) {
-            byte[] nextObject = findNextObject(XContentType.SMILE.xContent().streamSeparator(), inputStream);
+            byte[] nextObject = findNextObject(XContentType.SMILE.xContent().bulkSeparator(), inputStream);
             if (nextObject.length == 0) {
                 break;
             }

x-pack/plugin/ml/src/main/java/org/elasticsearch/xpack/ml/job/process/normalizer/output/NormalizerResultHandler.java

@@ -57,7 +57,7 @@ public void process() throws IOException {
     }
 
     private BytesReference parseResults(XContent xContent, BytesReference bytesRef) throws IOException {
-        byte marker = xContent.streamSeparator();
+        byte marker = xContent.bulkSeparator();
         int from = 0;
         while (true) {
             int nextMarker = findNextMarker(marker, bytesRef, from);

x-pack/plugin/ml/src/main/java/org/elasticsearch/xpack/ml/process/logging/CppLogMessageHandler.java

@@ -236,7 +236,7 @@ public String getErrors() {
     }
 
     private BytesReference parseMessages(XContent xContent, BytesReference bytesRef) {
-        byte marker = xContent.streamSeparator();
+        byte marker = xContent.bulkSeparator();
         int from = 0;
         while (true) {
             int nextMarker = findNextMarker(marker, bytesRef, from);

x-pack/plugin/ml/src/main/java/org/elasticsearch/xpack/ml/rest/job/RestPostDataAction.java

@@ -53,7 +53,7 @@ protected RestChannelConsumer prepareRequest(RestRequest restRequest, NodeClient
     }
 
     @Override
-    public boolean supportsContentStream() {
+    public boolean supportsBulkContent() {
         return true;
     }
 }

x-pack/plugin/ml/src/test/java/org/elasticsearch/xpack/ml/job/process/autodetect/writer/JsonDataToProcessWriterTests.java

@@ -373,7 +373,7 @@ public void testWrite_Smile() throws Exception {
         xsonGen.writeStringField("value", "1.0");
         xsonGen.writeEndObject();
         xsonGen.close();
-        xsonOs.writeByte(XContentType.SMILE.xContent().streamSeparator());
+        xsonOs.writeByte(XContentType.SMILE.xContent().bulkSeparator());
 
         xsonGen = XContentFactory.xContent(XContentType.SMILE).createGenerator(xsonOs);
         xsonGen.writeStartObject();
@@ -382,7 +382,7 @@ public void testWrite_Smile() throws Exception {
         xsonGen.writeStringField("value", "2.0");
         xsonGen.writeEndObject();
         xsonGen.flush();
-        xsonOs.writeByte(XContentType.SMILE.xContent().streamSeparator());
+        xsonOs.writeByte(XContentType.SMILE.xContent().bulkSeparator());
 
         InputStream inputStream = new ByteArrayInputStream(BytesReference.toBytes(xsonOs.bytes()));
         JsonDataToProcessWriter writer = createWriter();

x-pack/plugin/monitoring/src/main/java/org/elasticsearch/xpack/monitoring/exporter/http/HttpExportBulk.java

@@ -176,15 +176,15 @@ private void writeDocument(MonitoringDoc doc, OutputStream out) throws IOExcepti
         }
 
         // Adds action metadata line bulk separator
-        out.write(xContent.streamSeparator());
+        out.write(xContent.bulkSeparator());
 
         // Adds the source of the monitoring document
         try (XContentBuilder builder = new XContentBuilder(xContent, out)) {
             doc.toXContent(builder, ToXContent.EMPTY_PARAMS);
         }
 
         // Adds final bulk separator
-        out.write(xContent.streamSeparator());
+        out.write(xContent.bulkSeparator());
 
         logger.trace("http exporter [{}] - added index request [index={}, id={}, monitoring data type={}]", name, index, id, doc.getType());
     }

x-pack/plugin/monitoring/src/main/java/org/elasticsearch/xpack/monitoring/rest/action/RestMonitoringBulkAction.java

@@ -102,7 +102,7 @@ public RestChannelConsumer prepareRequest(RestRequest request, NodeClient client
     }
 
     @Override
-    public boolean supportsContentStream() {
+    public boolean supportsBulkContent() {
         return true;
     }
 

x-pack/plugin/monitoring/src/test/java/org/elasticsearch/xpack/monitoring/action/MonitoringBulkRequestTests.java

@@ -105,16 +105,16 @@ public void testAddRequestContent() throws IOException {
                 builder.endObject();
 
                 builder.flush();
-                content.write(xContentType.xContent().streamSeparator());
+                content.write(xContentType.xContent().bulkSeparator());
 
                 sources[i] = RandomObjects.randomSource(random(), xContentType);
                 BytesRef bytes = sources[i].toBytesRef();
                 content.write(bytes.bytes, bytes.offset, bytes.length);
 
-                content.write(xContentType.xContent().streamSeparator());
+                content.write(xContentType.xContent().bulkSeparator());
             }
 
-            content.write(xContentType.xContent().streamSeparator());
+            content.write(xContentType.xContent().bulkSeparator());
         }
 
         final MonitoredSystem system = randomFrom(MonitoredSystem.values());
@@ -146,7 +146,7 @@ public void testAddRequestContentWithEmptySource() throws IOException {
         final int totalDocs = nbDocs + nbEmptyDocs;
 
         final XContentType xContentType = XContentType.JSON;
-        final byte separator = xContentType.xContent().streamSeparator();
+        final byte separator = xContentType.xContent().bulkSeparator();
 
         final BytesStreamOutput content = new BytesStreamOutput();
         try (XContentBuilder builder = XContentFactory.contentBuilder(xContentType, content)) {
@@ -192,7 +192,7 @@ public void testAddRequestContentWithUnrecognizedIndexName() throws IOException
         final String indexName = randomAlphaOfLength(10);
 
         final XContentType xContentType = XContentType.JSON;
-        final byte separator = xContentType.xContent().streamSeparator();
+        final byte separator = xContentType.xContent().bulkSeparator();
 
         final BytesStreamOutput content = new BytesStreamOutput();
         try (XContentBuilder builder = XContentFactory.contentBuilder(xContentType, content)) {