Package org.apache.solr.response

Class JacksonJsonWriter

java.lang.Object

org.apache.solr.response.JacksonJsonWriter

All Implemented Interfaces:

QueryResponseWriter, TextQueryResponseWriter, NamedListInitializedPlugin

public class JacksonJsonWriter
extends Object
implements TextQueryResponseWriter

A JSON ResponseWriter that uses jackson.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JacksonJsonWriter.WriterImpl

Nested classes/interfaces inherited from interface org.apache.solr.response.TextQueryResponseWriter

TextQueryResponseWriter.NonFlushingStream

Field Summary

Fields

Modifier and Type	Field	Description
protected final com.fasterxml.jackson.core.JsonFactory	jsonfactory
protected static final com.fasterxml.jackson.core.util.DefaultPrettyPrinter.Indenter	LARGE_ARRAY_IDENTIFIER
protected static final com.fasterxml.jackson.core.util.DefaultPrettyPrinter	pretty
protected static final com.fasterxml.jackson.core.util.DefaultPrettyPrinter.Indenter	SMALL_ARRAY_IDENTIFIER

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

CONTENT_TYPE_TEXT_UTF8, CONTENT_TYPE_XML_UTF8

Constructor Summary

Constructors

Constructor	Description
JacksonJsonWriter()

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.
org.apache.solr.common.PushWriter	getWriter(OutputStream out, SolrQueryRequest request, SolrQueryResponse response)
void	write(OutputStream out, SolrQueryRequest request, SolrQueryResponse response, String contentType)	Writes the response to the OutputStream.
void	write(Writer writer, SolrQueryRequest request, SolrQueryResponse response)	Write a SolrQueryResponse in a textual manner.

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

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

writeToString

Field Details

SMALL_ARRAY_IDENTIFIER

protected static final com.fasterxml.jackson.core.util.DefaultPrettyPrinter.Indenter SMALL_ARRAY_IDENTIFIER

LARGE_ARRAY_IDENTIFIER

protected static final com.fasterxml.jackson.core.util.DefaultPrettyPrinter.Indenter LARGE_ARRAY_IDENTIFIER

jsonfactory

protected final com.fasterxml.jackson.core.JsonFactory jsonfactory

pretty

protected static final com.fasterxml.jackson.core.util.DefaultPrettyPrinter pretty

Constructor Details

JacksonJsonWriter

public JacksonJsonWriter()

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

Specified by:

write in interface TextQueryResponseWriter

Throws:

IOException

write

public void write(Writer writer,
 SolrQueryRequest request,
 SolrQueryResponse response)
           throws IOException

Description copied from interface: TextQueryResponseWriter

Write a SolrQueryResponse in a textual manner.

Information about the request (in particular: formatting options) may be obtained from req but the dominant source of information should be rsp.

There are no mandatory actions that write must perform. An empty write implementation would fulfill all interface obligations.

Specified by:

write in interface TextQueryResponseWriter

Throws:

IOException

getWriter

public org.apache.solr.common.PushWriter getWriter(OutputStream out,
 SolrQueryRequest request,
 SolrQueryResponse response)
                                            throws IOException

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.