org.elasticsearch.rest

Interface RestChannel

All Known Implementing Classes:

AbstractRestChannel, NettyHttpChannel

public interface RestChannel

A channel used to construct bytes / builder based outputs, and send responses.

Method Summary

Methods

Modifier and Type	Method and Description
BytesStreamOutput	bytesOutput()
boolean	detailedErrorsEnabled()
XContentBuilder	newBuilder()
XContentBuilder	newBuilder(BytesReference autoDetectSource, boolean useFiltering)
XContentBuilder	newErrorBuilder()
RestRequest	request()
void	sendResponse(RestResponse response)

Method Detail

newBuilder

XContentBuilder newBuilder()
                           throws IOException

Throws:

IOException

newErrorBuilder

XContentBuilder newErrorBuilder()
                                throws IOException

Throws:

IOException

newBuilder

XContentBuilder newBuilder(@Nullable
                         BytesReference autoDetectSource,
                         boolean useFiltering)
                           throws IOException

Throws:

IOException

bytesOutput

BytesStreamOutput bytesOutput()

request

RestRequest request()

detailedErrorsEnabled

boolean detailedErrorsEnabled()

Returns:

true iff an error response should contain additional details like exception traces.

sendResponse

void sendResponse(RestResponse response)