com.yahoo.search.handler

Class HttpSearchResponse

java.lang.Object

com.yahoo.container.jdisc.HttpResponse

com.yahoo.container.jdisc.AsyncHttpResponse

com.yahoo.container.jdisc.ExtendedResponse

com.yahoo.search.handler.HttpSearchResponse

public class HttpSearchResponse
extends com.yahoo.container.jdisc.ExtendedResponse

Wrap the result of a query as an HTTP response.

Author:

Steinar Knutsen

Field Summary

Fields

Modifier and Type	Field and Description
private com.yahoo.container.logging.HitCounts	hitCounts
private Query	query
private com.yahoo.processing.rendering.Renderer<Result>	rendererCopy
private Result	result
private com.yahoo.container.handler.Timing	timing

Fields inherited from class com.yahoo.container.jdisc.HttpResponse

DEFAULT_CHARACTER_ENCODING, DEFAULT_MIME_TYPE

Constructor Summary

Constructors

Constructor and Description
HttpSearchResponse(int status, Result result, Query query, com.yahoo.processing.rendering.Renderer renderer)

Method Summary

Modifier and Type	Method and Description
String	getCharacterEncoding() Returns expected character encoding of this response
String	getContentType() Returns MIME type of this response
com.yahoo.container.handler.Coverage	getCoverage()
com.yahoo.container.logging.HitCounts	getHitCounts()
Iterable<com.yahoo.processing.execution.Execution.Trace.LogValue>	getLogValues()
String	getParsedQuery()
Query	getQuery() Returns the query wrapped by this
Result	getResult() Returns the result wrapped by this
com.yahoo.container.handler.Timing	getTiming()
void	populateAccessLogEntry(com.yahoo.container.logging.AccessLogEntry accessLogEntry)
(package private) static void	populateAccessLogEntry(com.yahoo.container.logging.AccessLogEntry jdiscRequestAccessLogEntry, com.yahoo.container.logging.HitCounts hitCounts)
private static void	populateHeaders(com.yahoo.jdisc.HeaderFields outputHeaders, com.yahoo.collections.ListMap<String,String> searchHeaders) Copy custom HTTP headers from the search result over to the HTTP response.
void	render(OutputStream output, com.yahoo.jdisc.handler.ContentChannel networkChannel, com.yahoo.jdisc.handler.CompletionHandler handler)
com.google.common.util.concurrent.ListenableFuture<Boolean>	waitableRender(OutputStream stream)
static com.google.common.util.concurrent.ListenableFuture<Boolean>	waitableRender(Result result, Query query, com.yahoo.processing.rendering.Renderer<Result> renderer, OutputStream stream)

Methods inherited from class com.yahoo.container.jdisc.ExtendedResponse

getUser

Methods inherited from class com.yahoo.container.jdisc.AsyncHttpResponse

render

Methods inherited from class com.yahoo.container.jdisc.HttpResponse

complete, getJdiscResponse, getStatus, headers, setStatus

Methods inherited from class java.lang.Object

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

Field Detail

result

private final Result result

query

private final Query query

rendererCopy

private final com.yahoo.processing.rendering.Renderer<Result> rendererCopy

timing

private final com.yahoo.container.handler.Timing timing

hitCounts

private final com.yahoo.container.logging.HitCounts hitCounts

Constructor Detail

HttpSearchResponse

public HttpSearchResponse(int status,
                          Result result,
                          Query query,
                          com.yahoo.processing.rendering.Renderer renderer)

Method Detail

populateHeaders

private static void populateHeaders(com.yahoo.jdisc.HeaderFields outputHeaders,
                                    com.yahoo.collections.ListMap<String,String> searchHeaders)

Copy custom HTTP headers from the search result over to the HTTP response.

Parameters:

outputHeaders - the headers which will be sent to a client

searchHeaders - the headers from the search result, or null

waitableRender

public com.google.common.util.concurrent.ListenableFuture<Boolean> waitableRender(OutputStream stream)
                                                                           throws IOException

Throws:

IOException

waitableRender

public static com.google.common.util.concurrent.ListenableFuture<Boolean> waitableRender(Result result,
                                                                                         Query query,
                                                                                         com.yahoo.processing.rendering.Renderer<Result> renderer,
                                                                                         OutputStream stream)
                                                                                  throws IOException

Throws:

IOException

render

public void render(OutputStream output,
                   com.yahoo.jdisc.handler.ContentChannel networkChannel,
                   com.yahoo.jdisc.handler.CompletionHandler handler)
            throws IOException

Specified by:

render in class com.yahoo.container.jdisc.ExtendedResponse

Throws:

IOException

populateAccessLogEntry

public void populateAccessLogEntry(com.yahoo.container.logging.AccessLogEntry accessLogEntry)

Overrides:

populateAccessLogEntry in class com.yahoo.container.jdisc.HttpResponse

populateAccessLogEntry

static void populateAccessLogEntry(com.yahoo.container.logging.AccessLogEntry jdiscRequestAccessLogEntry,
                                   com.yahoo.container.logging.HitCounts hitCounts)

getParsedQuery

public String getParsedQuery()

Overrides:

getParsedQuery in class com.yahoo.container.jdisc.ExtendedResponse

getTiming

public com.yahoo.container.handler.Timing getTiming()

Overrides:

getTiming in class com.yahoo.container.jdisc.ExtendedResponse

getCoverage

public com.yahoo.container.handler.Coverage getCoverage()

Overrides:

getCoverage in class com.yahoo.container.jdisc.ExtendedResponse

getHitCounts

public com.yahoo.container.logging.HitCounts getHitCounts()

Overrides:

getHitCounts in class com.yahoo.container.jdisc.ExtendedResponse

getContentType

public String getContentType()

Returns MIME type of this response

Overrides:

getContentType in class com.yahoo.container.jdisc.HttpResponse

getCharacterEncoding

public String getCharacterEncoding()

Returns expected character encoding of this response

Overrides:

getCharacterEncoding in class com.yahoo.container.jdisc.HttpResponse

getQuery

public Query getQuery()

Returns the query wrapped by this

getResult

public Result getResult()

Returns the result wrapped by this

getLogValues

public Iterable<com.yahoo.processing.execution.Execution.Trace.LogValue> getLogValues()

Overrides:

getLogValues in class com.yahoo.container.jdisc.HttpResponse