Package 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 inherited from class com.yahoo.container.jdisc.HttpResponse

DEFAULT_CHARACTER_ENCODING, DEFAULT_MIME_TYPE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static CompletableFuture<Boolean>	asyncRender(Result result, Query query, com.yahoo.processing.rendering.Renderer<Result> renderer, OutputStream stream)
CompletableFuture<Boolean>	asyncRender(OutputStream stream)
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)
void	render(OutputStream output, com.yahoo.jdisc.handler.ContentChannel networkChannel, com.yahoo.jdisc.handler.CompletionHandler handler)
static com.google.common.util.concurrent.ListenableFuture<Boolean>	waitableRender(Result result, Query query, com.yahoo.processing.rendering.Renderer<Result> renderer, OutputStream stream)	Deprecated, for removal: This API element is subject to removal in a future version. Use asyncRender(Result, Query, Renderer, OutputStream) instead
com.google.common.util.concurrent.ListenableFuture<Boolean>	waitableRender(OutputStream stream)	Deprecated, for removal: This API element is subject to removal in a future version. Use asyncRender(OutputStream) instead

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, getRequestType, getStatus, headers, maxPendingBytes, setRequestType, setStatus

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpSearchResponse

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

Method Detail

waitableRender

@Deprecated(forRemoval=true,
            since="7")
public com.google.common.util.concurrent.ListenableFuture<Boolean> waitableRender(OutputStream stream)
                                                                           throws IOException

Deprecated, for removal: This API element is subject to removal in a future version.

Use asyncRender(OutputStream) instead

Throws:

IOException

waitableRender

@Deprecated(forRemoval=true,
            since="7")
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

Deprecated, for removal: This API element is subject to removal in a future version.

Use asyncRender(Result, Query, Renderer, OutputStream) instead

Throws:

IOException

asyncRender

public CompletableFuture<Boolean> asyncRender(OutputStream stream)

asyncRender

public static CompletableFuture<Boolean> asyncRender(Result result,
                                                     Query query,
                                                     com.yahoo.processing.rendering.Renderer<Result> renderer,
                                                     OutputStream stream)

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

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