Package org.apache.solr.response

Class CborResponseWriter

java.lang.Object

org.apache.solr.response.CborResponseWriter

All Implemented Interfaces:

QueryResponseWriter, NamedListInitializedPlugin

public class CborResponseWriter
extends Object
implements QueryResponseWriter

A response writer impl that can write results in CBOR (cbor.io) format when wt=cbor. It uses the jackson library to write the stream out

Field Summary

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

CONTENT_TYPE_TEXT_UTF8, CONTENT_TYPE_XML_UTF8

Constructor Summary

Constructors

Constructor	Description
CborResponseWriter()

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 req, 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

CborResponseWriter

public CborResponseWriter()

Method Details

write

public void write(OutputStream out,
 SolrQueryRequest req,
 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.