Skip to content

armgit / solr

Public Imported from GitHub
0

Apache Solr open-source search software

SOLR-17682: Rename BinaryResponseWriter to JavaBinResponseWriter (#3267)

David Smiley7bf7379d6c75
diff --git a/solr/CHANGES.txt b/solr/CHANGES.txt
index 0b785ae4fa0..66adcaf6291 100644
--- a/solr/CHANGES.txt
+++ b/solr/CHANGES.txt
@@ -158,7 +158,8 @@ Other Changes
* SOLR-17682: QueryResponseWriter: refactor the hierarchy. Base abstraction is now byte oriented,
thus BinaryQueryResponseWriter is gone. Added TextQueryResponseWriter for the text ones.
- Stopped using RawResponseWriter when not needed. (David Smiley)
+ Stopped using RawResponseWriter when not needed. Rename BinaryResponseWriter to JavaBinResponseWriter.
+ (David Smiley)
================== 9.9.0 ==================
New Features
diff --git a/solr/core/src/java/org/apache/solr/client/solrj/embedded/EmbeddedSolrServer.java b/solr/core/src/java/org/apache/solr/client/solrj/embedded/EmbeddedSolrServer.java
index 78880867f84..59d1f2c99fa 100644
--- a/solr/core/src/java/org/apache/solr/client/solrj/embedded/EmbeddedSolrServer.java
+++ b/solr/core/src/java/org/apache/solr/client/solrj/embedded/EmbeddedSolrServer.java
@@ -58,7 +58,7 @@ import org.apache.solr.core.SolrCore;
import org.apache.solr.request.SolrQueryRequest;
import org.apache.solr.request.SolrRequestHandler;
import org.apache.solr.request.SolrRequestInfo;
-import org.apache.solr.response.BinaryResponseWriter;
+import org.apache.solr.response.JavaBinResponseWriter;
import org.apache.solr.response.ResultContext;
import org.apache.solr.response.SolrQueryResponse;
import org.apache.solr.servlet.SolrRequestParsers;
@@ -283,7 +283,7 @@ public class EmbeddedSolrServer extends SolrClient {
throw new IllegalArgumentException(
"Only javabin is supported when using a streaming response callback");
var resolver =
- new BinaryResponseWriter.Resolver(req, rsp.getReturnFields()) {
+ new JavaBinResponseWriter.Resolver(req, rsp.getReturnFields()) {
@Override
public void writeResults(ResultContext ctx, JavaBinCodec codec) throws IOException {
// write an empty list...
@@ -356,7 +356,7 @@ public class EmbeddedSolrServer extends SolrClient {
}
private JavaBinCodec createJavaBinCodec(
- final StreamingResponseCallback callback, final BinaryResponseWriter.Resolver resolver) {
+ final StreamingResponseCallback callback, final JavaBinResponseWriter.Resolver resolver) {
return new JavaBinCodec(resolver) {
@Override
diff --git a/solr/core/src/java/org/apache/solr/core/SolrCore.java b/solr/core/src/java/org/apache/solr/core/SolrCore.java
index a1473d0be14..d9a3ce3df15 100644
--- a/solr/core/src/java/org/apache/solr/core/SolrCore.java
+++ b/solr/core/src/java/org/apache/solr/core/SolrCore.java
@@ -121,12 +121,12 @@ import org.apache.solr.pkg.SolrPackageLoader;
import org.apache.solr.request.SolrQueryRequest;
import org.apache.solr.request.SolrRequestHandler;
import org.apache.solr.request.SolrRequestInfo;
-import org.apache.solr.response.BinaryResponseWriter;
import org.apache.solr.response.CSVResponseWriter;
import org.apache.solr.response.CborResponseWriter;
import org.apache.solr.response.GeoJSONResponseWriter;
import org.apache.solr.response.GraphMLResponseWriter;
import org.apache.solr.response.JacksonJsonWriter;
+import org.apache.solr.response.JavaBinResponseWriter;
import org.apache.solr.response.PrometheusResponseWriter;
import org.apache.solr.response.QueryResponseWriter;
import org.apache.solr.response.RawResponseWriter;
@@ -3030,7 +3030,7 @@ public class SolrCore implements SolrInfoBean, Closeable {
m.put("geojson", new GeoJSONResponseWriter());
m.put("graphml", new GraphMLResponseWriter());
m.put("raw", new RawResponseWriter());
- m.put(CommonParams.JAVABIN, new BinaryResponseWriter());
+ m.put(CommonParams.JAVABIN, new JavaBinResponseWriter());
m.put("cbor", new CborResponseWriter());
m.put("csv", new CSVResponseWriter());
m.put("schema.xml", new SchemaXmlResponseWriter());
@@ -3050,8 +3050,8 @@ public class SolrCore implements SolrInfoBean, Closeable {
}
}
- private static BinaryResponseWriter getFileStreamWriter() {
- return new BinaryResponseWriter() {
+ private static JavaBinResponseWriter getFileStreamWriter() {
+ return new JavaBinResponseWriter() {
@Override
public void write(
OutputStream out, SolrQueryRequest req, SolrQueryResponse response, String contentType)
diff --git a/solr/core/src/java/org/apache/solr/handler/admin/SolrInfoMBeanHandler.java b/solr/core/src/java/org/apache/solr/handler/admin/SolrInfoMBeanHandler.java
index fd2aa308ab1..b3269738e0d 100644
--- a/solr/core/src/java/org/apache/solr/handler/admin/SolrInfoMBeanHandler.java
+++ b/solr/core/src/java/org/apache/solr/handler/admin/SolrInfoMBeanHandler.java
@@ -32,7 +32,7 @@ import org.apache.solr.common.util.StrUtils;
import org.apache.solr.core.SolrInfoBean;
import org.apache.solr.handler.RequestHandlerBase;
import org.apache.solr.request.SolrQueryRequest;
-import org.apache.solr.response.BinaryResponseWriter;
+import org.apache.solr.response.JavaBinResponseWriter;
import org.apache.solr.response.SolrQueryResponse;
import org.apache.solr.security.AuthorizationContext;
@@ -72,7 +72,7 @@ public class SolrInfoMBeanHandler extends RequestHandlerBase {
wrap.add("solr-mbeans", cats);
cats =
(NamedList<NamedList<NamedList<Object>>>)
- BinaryResponseWriter.getParsedResponse(req, wrap).get("solr-mbeans");
+ JavaBinResponseWriter.getParsedResponse(req, wrap).get("solr-mbeans");
// Get rid of irrelevant things
normalize(ref);
diff --git a/solr/core/src/java/org/apache/solr/handler/export/ExportWriter.java b/solr/core/src/java/org/apache/solr/handler/export/ExportWriter.java
index 209680aee12..8e4a3da6514 100644
--- a/solr/core/src/java/org/apache/solr/handler/export/ExportWriter.java
+++ b/solr/core/src/java/org/apache/solr/handler/export/ExportWriter.java
@@ -59,9 +59,9 @@ import org.apache.solr.core.SolrCore;
import org.apache.solr.metrics.SolrMetricsContext;
import org.apache.solr.request.SolrQueryRequest;
import org.apache.solr.request.SolrRequestInfo;
-import org.apache.solr.response.BinaryResponseWriter;
import org.apache.solr.response.JSONResponseWriter;
import org.apache.solr.response.JacksonJsonWriter;
+import org.apache.solr.response.JavaBinResponseWriter;
import org.apache.solr.response.QueryResponseWriter;
import org.apache.solr.response.SolrQueryResponse;
import org.apache.solr.schema.BoolField;
@@ -199,7 +199,7 @@ public class ExportWriter implements SolrCore.RawWriter, Closeable {
QueryResponseWriter rw = req.getCore().getResponseWriters().get(wt);
if (rw instanceof JacksonJsonWriter) {
writer = ((JacksonJsonWriter) rw).getWriter(os, req, res);
- } else if (rw instanceof BinaryResponseWriter) {
+ } else if (rw instanceof JavaBinResponseWriter) {
// todo add support for other writers after testing
writer = new JavaBinCodec(os, null);
} else {
diff --git a/solr/core/src/java/org/apache/solr/jersey/MessageBodyWriters.java b/solr/core/src/java/org/apache/solr/jersey/MessageBodyWriters.java
index f73146a864a..62949441c7f 100644
--- a/solr/core/src/java/org/apache/solr/jersey/MessageBodyWriters.java
+++ b/solr/core/src/java/org/apache/solr/jersey/MessageBodyWriters.java
@@ -36,8 +36,8 @@ import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import org.apache.solr.handler.api.V2ApiUtils;
import org.apache.solr.request.SolrQueryRequest;
-import org.apache.solr.response.BinaryResponseWriter;
import org.apache.solr.response.CSVResponseWriter;
+import org.apache.solr.response.JavaBinResponseWriter;
import org.apache.solr.response.QueryResponseWriter;
import org.apache.solr.response.RawResponseWriter;
import org.apache.solr.response.SolrQueryResponse;
@@ -70,7 +70,7 @@ public class MessageBodyWriters {
implements MessageBodyWriter<Object> {
@Override
public QueryResponseWriter createResponseWriter() {
- return new BinaryResponseWriter();
+ return new JavaBinResponseWriter();
}
@Override
diff --git a/solr/core/src/java/org/apache/solr/response/DocsStreamer.java b/solr/core/src/java/org/apache/solr/response/DocsStreamer.java
index 485d9c9a1e8..b42a7140392 100644
--- a/solr/core/src/java/org/apache/solr/response/DocsStreamer.java
+++ b/solr/core/src/java/org/apache/solr/response/DocsStreamer.java
@@ -147,11 +147,11 @@ public class DocsStreamer implements Iterator<SolrDocument> {
// because that doesn't include extra fields needed by transformers
final Set<String> fieldNamesNeeded = fields.getLuceneFieldNames();
- BinaryResponseWriter.MaskCharSeqSolrDocument masked = null;
+ JavaBinResponseWriter.MaskCharSeqSolrDocument masked = null;
final SolrDocument out =
ResultContext.READASBYTES.get() == null
? new SolrDocument()
- : (masked = new BinaryResponseWriter.MaskCharSeqSolrDocument());
+ : (masked = new JavaBinResponseWriter.MaskCharSeqSolrDocument());
// NOTE: it would be tempting to try and optimize this to loop over fieldNamesNeeded when it's
// smaller then the IndexableField[] in the Document -- but that's actually *less* effecient
diff --git a/solr/core/src/java/org/apache/solr/response/BinaryResponseWriter.java b/solr/core/src/java/org/apache/solr/response/JavaBinResponseWriter.java
similarity index 98%
rename from solr/core/src/java/org/apache/solr/response/BinaryResponseWriter.java
rename to solr/core/src/java/org/apache/solr/response/JavaBinResponseWriter.java
index d9f9e799ca7..ebe8bec6de6 100644
--- a/solr/core/src/java/org/apache/solr/response/BinaryResponseWriter.java
+++ b/solr/core/src/java/org/apache/solr/response/JavaBinResponseWriter.java
@@ -43,8 +43,8 @@ import org.apache.solr.search.ReturnFields;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-/** Solr's "javabin" format. TODO rename accordingly. */
-public class BinaryResponseWriter implements QueryResponseWriter {
+/** Solr's "javabin" format. */
+public class JavaBinResponseWriter implements QueryResponseWriter {
// public static boolean useUtf8CharSeq = true;
private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
@@ -173,7 +173,7 @@ public class BinaryResponseWriter implements QueryResponseWriter {
}
};
- new BinaryResponseWriter().write(out, req, rsp);
+ new JavaBinResponseWriter().write(out, req, rsp);
return new BinaryResponseParser().processResponse(out.toInputStream(), null);
} catch (IOException ex) {
diff --git a/solr/core/src/java/org/apache/solr/response/QueryResponseWriter.java b/solr/core/src/java/org/apache/solr/response/QueryResponseWriter.java
index 673543b8e6a..f15feac9f67 100644
--- a/solr/core/src/java/org/apache/solr/response/QueryResponseWriter.java
+++ b/solr/core/src/java/org/apache/solr/response/QueryResponseWriter.java
@@ -45,7 +45,6 @@ import org.apache.solr.util.plugin.NamedListInitializedPlugin;
public interface QueryResponseWriter extends NamedListInitializedPlugin {
public static String CONTENT_TYPE_XML_UTF8 = "application/xml; charset=UTF-8";
public static String CONTENT_TYPE_TEXT_UTF8 = "text/plain; charset=UTF-8";
- public static String CONTENT_TYPE_TEXT_ASCII = "text/plain; charset=US-ASCII";
/**
* Writes the response to the {@link OutputStream}. {@code contentType} is from {@link
diff --git a/solr/core/src/test/org/apache/solr/TestGroupingSearch.java b/solr/core/src/test/org/apache/solr/TestGroupingSearch.java
index 4e8b40f305b..6b877fab528 100644
--- a/solr/core/src/test/org/apache/solr/TestGroupingSearch.java
+++ b/solr/core/src/test/org/apache/solr/TestGroupingSearch.java
@@ -38,7 +38,7 @@ import org.apache.solr.common.util.Utils;
import org.apache.solr.index.LogDocMergePolicyFactory;
import org.apache.solr.request.SolrQueryRequest;
import org.apache.solr.request.SolrRequestInfo;
-import org.apache.solr.response.BinaryResponseWriter;
+import org.apache.solr.response.JavaBinResponseWriter;
import org.apache.solr.response.ResultContext;
import org.apache.solr.response.SolrQueryResponse;
import org.apache.solr.schema.IndexSchema;
@@ -437,7 +437,7 @@ public class TestGroupingSearch extends SolrTestCaseJ4 {
SolrRequestInfo.setRequestInfo(new SolrRequestInfo(request, response));
String handlerName = request.getParams().get(CommonParams.QT);
h.getCore().execute(h.getCore().getRequestHandler(handlerName), request, response);
- BinaryResponseWriter responseWriter = new BinaryResponseWriter();
+ JavaBinResponseWriter responseWriter = new JavaBinResponseWriter();
responseWriter.write(out, request, response);
} finally {
request.close();
diff --git a/solr/core/src/test/org/apache/solr/TestTolerantSearch.java b/solr/core/src/test/org/apache/solr/TestTolerantSearch.java
index c0571affd6c..868954c2a80 100644
--- a/solr/core/src/test/org/apache/solr/TestTolerantSearch.java
+++ b/solr/core/src/test/org/apache/solr/TestTolerantSearch.java
@@ -33,7 +33,7 @@ import org.apache.solr.common.SolrInputDocument;
import org.apache.solr.common.params.ShardParams;
import org.apache.solr.common.util.NamedList;
import org.apache.solr.request.SolrQueryRequest;
-import org.apache.solr.response.BinaryResponseWriter;
+import org.apache.solr.response.JavaBinResponseWriter;
import org.apache.solr.response.SolrQueryResponse;
import org.junit.AfterClass;
import org.junit.BeforeClass;
@@ -247,7 +247,7 @@ public class TestTolerantSearch extends SolrJettyTestBase {
expectThrows(SolrException.class, () -> collection1.query(query));
}
- public static class BadResponseWriter extends BinaryResponseWriter {
+ public static class BadResponseWriter extends JavaBinResponseWriter {
private static boolean failOnGetFields = false;
private static boolean failOnGetTopIds = false;
diff --git a/solr/core/src/test/org/apache/solr/response/TestBinaryResponseWriter.java b/solr/core/src/test/org/apache/solr/response/TestJavaBinResponseWriter.java
similarity index 94%
rename from solr/core/src/test/org/apache/solr/response/TestBinaryResponseWriter.java
rename to solr/core/src/test/org/apache/solr/response/TestJavaBinResponseWriter.java
index 4331c58e1c8..0b46ddfed13 100644
--- a/solr/core/src/test/org/apache/solr/response/TestBinaryResponseWriter.java
+++ b/solr/core/src/test/org/apache/solr/response/TestJavaBinResponseWriter.java
@@ -31,16 +31,16 @@ import org.apache.solr.common.util.JavaBinCodec;
import org.apache.solr.common.util.NamedList;
import org.apache.solr.request.LocalSolrQueryRequest;
import org.apache.solr.request.SolrQueryRequest;
-import org.apache.solr.response.BinaryResponseWriter.Resolver;
+import org.apache.solr.response.JavaBinResponseWriter.Resolver;
import org.apache.solr.search.SolrReturnFields;
import org.junit.BeforeClass;
/**
- * Test for BinaryResponseWriter
+ * Test for JavaBinResponseWriter
*
* @since solr 1.4
*/
-public class TestBinaryResponseWriter extends SolrTestCaseJ4 {
+public class TestJavaBinResponseWriter extends SolrTestCaseJ4 {
@BeforeClass
public static void beforeClass() throws Exception {
@@ -96,13 +96,13 @@ public class TestBinaryResponseWriter extends SolrTestCaseJ4 {
SolrQueryRequest req = req("q", "*:*", "omitHeader", "true");
SolrQueryResponse rsp = h.queryAndResponse(null, req);
- NamedList<Object> res = BinaryResponseWriter.getParsedResponse(req, rsp);
+ NamedList<Object> res = JavaBinResponseWriter.getParsedResponse(req, rsp);
assertNull(res.get("responseHeader"));
req.close();
req = req("q", "*:*");
rsp = h.queryAndResponse(null, req);
- res = BinaryResponseWriter.getParsedResponse(req, rsp);
+ res = JavaBinResponseWriter.getParsedResponse(req, rsp);
assertNotNull(res.get("responseHeader"));
req.close();
}