Module org.elasticsearch.server

Package org.elasticsearch.rest

Class LoggingChunkedRestResponseBodyPart

java.lang.Object

org.elasticsearch.rest.LoggingChunkedRestResponseBodyPart

All Implemented Interfaces:

ChunkedRestResponseBodyPart

public class LoggingChunkedRestResponseBodyPart
extends Object
implements ChunkedRestResponseBodyPart

Field Summary

Fields inherited from interface org.elasticsearch.rest.ChunkedRestResponseBodyPart

logger

Constructor Summary

Constructors

Constructor	Description
LoggingChunkedRestResponseBodyPart(ChunkedRestResponseBodyPart inner, OutputStream loggerStream)

Method Summary

Modifier and Type	Method	Description
ReleasableBytesReference	encodeChunk(int sizeHint, Recycler<org.apache.lucene.util.BytesRef> recycler)	Serializes approximately as many bytes of the response as request by sizeHint to a ReleasableBytesReference that is created from buffers backed by the given recycler.
void	getNextPart(ActionListener<ChunkedRestResponseBodyPart> listener)	Asynchronously retrieves the next part of the response body.
String	getResponseContentTypeString()
boolean	isLastPart()
boolean	isPartComplete()

Methods inherited from class java.lang.Object

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

Constructor Details

LoggingChunkedRestResponseBodyPart

public LoggingChunkedRestResponseBodyPart(ChunkedRestResponseBodyPart inner,
 OutputStream loggerStream)

Method Details

isPartComplete

public boolean isPartComplete()

Specified by:

isPartComplete in interface ChunkedRestResponseBodyPart

Returns:

true if this body part contains no more chunks and the REST layer should check for a possible continuation by calling ChunkedRestResponseBodyPart.isLastPart(), or false if the REST layer should request another chunk from this body using ChunkedRestResponseBodyPart.encodeChunk(int, org.elasticsearch.common.recycler.Recycler<org.apache.lucene.util.BytesRef>).

isLastPart

public boolean isLastPart()

Specified by:

isLastPart in interface ChunkedRestResponseBodyPart

Returns:

true if this is the last chunked body part in the response, or false if the REST layer should request further chunked bodies by calling ChunkedRestResponseBodyPart.getNextPart(org.elasticsearch.action.ActionListener<org.elasticsearch.rest.ChunkedRestResponseBodyPart>).

getNextPart

public void getNextPart(ActionListener<ChunkedRestResponseBodyPart> listener)

Description copied from interface: ChunkedRestResponseBodyPart

Asynchronously retrieves the next part of the response body. Called if ChunkedRestResponseBodyPart.isLastPart() returns false.

Note that this is called on a transport thread: implementations must take care to dispatch any nontrivial work elsewhere.

Note that the Task corresponding to any invocation of ElasticsearchClient.execute(org.elasticsearch.action.ActionType<Response>, Request) completes as soon as the client action returns its response, so it no longer exists when this method is called and cannot be used to receive cancellation notifications. Instead, if the HTTP channel is closed while sending a response then the REST layer will invoke RestResponse.close(). If the HTTP channel is closed while the REST layer is waiting for a continuation then the RestResponse will not be closed until the continuation listener is completed. Implementations will typically explicitly create a CancellableTask to represent the computation and transmission of the entire RestResponse, and will cancel this task if the RestResponse is closed prematurely.

Specified by:

getNextPart in interface ChunkedRestResponseBodyPart

Parameters:

listener - Listener to complete with the next part of the body. By the point this is called we have already started to send the body of the response, so there's no good ways to handle an exception here. Completing the listener exceptionally will log an error, abort sending the response, and close the HTTP connection.

encodeChunk

public ReleasableBytesReference encodeChunk(int sizeHint,
 Recycler<org.apache.lucene.util.BytesRef> recycler)
                                     throws IOException

Description copied from interface: ChunkedRestResponseBodyPart

Serializes approximately as many bytes of the response as request by sizeHint to a ReleasableBytesReference that is created from buffers backed by the given recycler.

Specified by:

encodeChunk in interface ChunkedRestResponseBodyPart

Parameters:

sizeHint - how many bytes to approximately serialize for the given chunk

recycler - recycler used to acquire buffers

Returns:

serialized chunk

Throws:

IOException - on serialization failure

getResponseContentTypeString

public String getResponseContentTypeString()

Specified by:

getResponseContentTypeString in interface ChunkedRestResponseBodyPart

Returns:

the response Content-Type header value for this response body