Package org.apache.solr.response

Class FileStreamResponseWriter

java.lang.Object

org.apache.solr.response.FileStreamResponseWriter

All Implemented Interfaces:

QueryResponseWriter, NamedListInitializedPlugin

public class FileStreamResponseWriter
extends Object
implements QueryResponseWriter

Response writer for file streaming operations, used for replication, exports, and other core Solr operations.

This writer handles streaming of large files (such as index files) by looking for a SolrCore.RawWriter object in the response under the ReplicationAPIBase.FILE_STREAM key. When found, it delegates directly to the raw writer to stream the file content efficiently.

This writer is specifically designed for replication file transfers and provides no fallback behavior - it only works when a proper RawWriter is present in the response.

Field Summary

Fields inherited from interface org.apache.solr.response.QueryResponseWriter

CONTENT_TYPE_OPEN_METRICS, CONTENT_TYPE_PROMETHEUS, CONTENT_TYPE_TEXT_UTF8, CONTENT_TYPE_XML_UTF8

Constructor Summary

Constructors

Constructor	Description
FileStreamResponseWriter()

Method Summary

Modifier and Type	Method	Description
String	getContentType(SolrQueryRequest request, SolrQueryResponse response)	Return the applicable Content Type for a request, this method must be thread safe.
void	write(OutputStream out, SolrQueryRequest request, SolrQueryResponse response, String contentType)	Writes the response to the OutputStream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.solr.util.plugin.NamedListInitializedPlugin

init

Methods inherited from interface org.apache.solr.response.QueryResponseWriter

write, writeToString

Constructor Details

FileStreamResponseWriter

public FileStreamResponseWriter()

Method Details

write

public void write(OutputStream out,
 SolrQueryRequest request,
 SolrQueryResponse response,
 String contentType)
           throws IOException

Description copied from interface: QueryResponseWriter

Writes the response to the OutputStream. contentType is from QueryResponseWriter.getContentType(SolrQueryRequest, SolrQueryResponse), and it's often ignored.

Specified by:

write in interface QueryResponseWriter

Throws:

IOException

getContentType

public String getContentType(SolrQueryRequest request,
 SolrQueryResponse response)

Description copied from interface: QueryResponseWriter

Return the applicable Content Type for a request, this method must be thread safe.

QueryResponseWriter's must implement this method to return a valid HTTP Content-Type header for the request, that will logically correspond with the output produced by the write method.

Specified by:

getContentType in interface QueryResponseWriter

Returns:

a Content-Type string, which may not be null.