Package org.elasticsearch.rest

Interface RestChannel

All Known Implementing Classes:

AbstractRestChannel, DefaultRestChannel

public interface RestChannel

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

Method Summary

Modifier and Type	Method	Description
BytesStreamOutput	bytesOutput()
boolean	detailedErrorsEnabled()
XContentBuilder	newBuilder()
XContentBuilder	newBuilder(XContentType xContentType, boolean useFiltering)
XContentBuilder	newBuilder(XContentType xContentType, XContentType responseContentType, boolean useFiltering)
XContentBuilder	newErrorBuilder()
void	releaseOutputBuffer()	Releases the current output buffer for this channel.
RestRequest	request()
void	sendResponse(RestResponse response)

Method Details

newBuilder

XContentBuilder newBuilder()
                    throws IOException

Throws:

IOException

newErrorBuilder

XContentBuilder newErrorBuilder()
                         throws IOException

Throws:

IOException

newBuilder

XContentBuilder newBuilder(@Nullable
 XContentType xContentType,
 boolean useFiltering)
                    throws IOException

Throws:

IOException

newBuilder

XContentBuilder newBuilder(@Nullable
 XContentType xContentType,
 @Nullable
 XContentType responseContentType,
 boolean useFiltering)
                    throws IOException

Throws:

IOException

bytesOutput

BytesStreamOutput bytesOutput()

releaseOutputBuffer

void releaseOutputBuffer()

Releases the current output buffer for this channel. Must be called after the buffer derived from bytesOutput() is no longer needed.

request

RestRequest request()

detailedErrorsEnabled

boolean detailedErrorsEnabled()

Returns:

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

sendResponse

void sendResponse(RestResponse response)