com.yahoo.processing.handler

Class ProcessingResponse

java.lang.Object

com.yahoo.container.jdisc.HttpResponse

com.yahoo.container.jdisc.AsyncHttpResponse

com.yahoo.processing.handler.ProcessingResponse

public class ProcessingResponse
extends AsyncHttpResponse

A response from running a request through processing. This response is just a wrapper of the knowhow needed to render the Response from processing.

Since:

5.1.12

Author:

bratseth, Steinar Knutsen

Field Summary

Fields

Modifier and Type	Field and Description
private com.yahoo.processing.execution.Execution	execution
private boolean	explicitStatusSet True if the return status has been set explicitly and should not be further changed
private com.yahoo.processing.Request	processingRequest
private com.yahoo.processing.Response	processingResponse
private Renderer	renderer

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

DEFAULT_CHARACTER_ENCODING, DEFAULT_MIME_TYPE

Constructor Summary

Constructors

Constructor and Description
ProcessingResponse(int status, com.yahoo.processing.Request processingRequest, com.yahoo.processing.Response processingResponse, Renderer renderer, Executor renderingExecutor, com.yahoo.processing.execution.Execution execution)

Method Summary

Modifier and Type	Method and Description
private void	addHeadersAndStatusFrom(com.yahoo.processing.response.DataList<com.yahoo.processing.response.Data> dataList) This sets header and status from special Data items used for the purpose.
private Set<com.yahoo.processing.request.ErrorMessage>	addTo(Set<com.yahoo.processing.request.ErrorMessage> allErrors, List<com.yahoo.processing.request.ErrorMessage> errors)
void	complete() Complete creation of this response.
private List<com.yahoo.processing.request.ErrorMessage>	flattenErrors(com.yahoo.processing.Response processingResponse)
private Set<com.yahoo.processing.request.ErrorMessage>	flattenErrors(Set<com.yahoo.processing.request.ErrorMessage> errors, com.yahoo.processing.response.Data data)
String	getCharacterEncoding() The name of the encoding for the response contents, if applicable.
String	getContentType() The MIME type of the response contents or null.
private int	getHttpResponseStatus(boolean isSuccess, com.yahoo.processing.Request request, com.yahoo.processing.request.ErrorMessage mainError, List<com.yahoo.processing.request.ErrorMessage> errors)
Iterable<com.yahoo.processing.execution.Execution.Trace.LogValue>	getLogValues()
private boolean	isBenchmarking(com.yahoo.processing.Request request)
void	render(OutputStream stream, com.yahoo.jdisc.handler.ContentChannel channel, com.yahoo.jdisc.handler.CompletionHandler completionHandler) Render to output asynchronously.

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

render

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

getJdiscResponse, getStatus, headers, populateAccessLogEntry, setStatus

Methods inherited from class java.lang.Object

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

Field Detail

processingRequest

private final com.yahoo.processing.Request processingRequest

processingResponse

private final com.yahoo.processing.Response processingResponse

execution

private final com.yahoo.processing.execution.Execution execution

renderer

private final Renderer renderer

explicitStatusSet

private boolean explicitStatusSet

True if the return status has been set explicitly and should not be further changed

Constructor Detail

ProcessingResponse

public ProcessingResponse(int status,
                          com.yahoo.processing.Request processingRequest,
                          com.yahoo.processing.Response processingResponse,
                          Renderer renderer,
                          Executor renderingExecutor,
                          com.yahoo.processing.execution.Execution execution)

Method Detail

render

public void render(OutputStream stream,
                   com.yahoo.jdisc.handler.ContentChannel channel,
                   com.yahoo.jdisc.handler.CompletionHandler completionHandler)
            throws IOException

Description copied from class: AsyncHttpResponse

Render to output asynchronously. The output stream will not be closed when this return. The implementation is responsible for closing the output (using the provided channel and completion handler) when (async) rendering is completed.

Specified by:

render in class AsyncHttpResponse

Parameters:

stream - the stream to which content should be rendered

channel - the channel which must be closed on completion

completionHandler - the completion handler to submit when closing the channel, may be null

Throws:

IOException

getContentType

public String getContentType()

Description copied from class: HttpResponse

The MIME type of the response contents or null. If null is returned, no content type header is added to the HTTP response.

Overrides:

getContentType in class HttpResponse

Returns:

by default HttpResponse.DEFAULT_MIME_TYPE

getCharacterEncoding

public String getCharacterEncoding()

Description copied from class: HttpResponse

The name of the encoding for the response contents, if applicable. Return null if character set is not applicable to the response in question (e.g. binary formats). If null is returned, not "charset" element is added to the content type header.

Overrides:

getCharacterEncoding in class HttpResponse

Returns:

by default HttpResponse.DEFAULT_CHARACTER_ENCODING

complete

public void complete()

Description copied from class: HttpResponse

Complete creation of this response. This is called by the container once just before writing the response header back to the caller, so this is the last moment at which status and headers can be determined. This default implementation does nothing.

Overrides:

complete in class HttpResponse

addHeadersAndStatusFrom

private void addHeadersAndStatusFrom(com.yahoo.processing.response.DataList<com.yahoo.processing.response.Data> dataList)

This sets header and status from special Data items used for the purpose. Do both at once to avoid traversing the data tree twice.

flattenErrors

private List<com.yahoo.processing.request.ErrorMessage> flattenErrors(com.yahoo.processing.Response processingResponse)

flattenErrors

private Set<com.yahoo.processing.request.ErrorMessage> flattenErrors(Set<com.yahoo.processing.request.ErrorMessage> errors,
                                                                     com.yahoo.processing.response.Data data)

addTo

private Set<com.yahoo.processing.request.ErrorMessage> addTo(Set<com.yahoo.processing.request.ErrorMessage> allErrors,
                                                             List<com.yahoo.processing.request.ErrorMessage> errors)

getHttpResponseStatus

private int getHttpResponseStatus(boolean isSuccess,
                                  com.yahoo.processing.Request request,
                                  com.yahoo.processing.request.ErrorMessage mainError,
                                  List<com.yahoo.processing.request.ErrorMessage> errors)

isBenchmarking

private boolean isBenchmarking(com.yahoo.processing.Request request)

getLogValues

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

Overrides:

getLogValues in class HttpResponse