Module org.elasticsearch.server

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
BytesStream	bytesOutput()
boolean	detailedErrorsEnabled()
XContentBuilder	newBuilder()
XContentBuilder	newBuilder(XContentType xContentType, boolean useFiltering)
XContentBuilder	newBuilder(XContentType xContentType, XContentType responseContentType, boolean useFiltering)
XContentBuilder	newErrorBuilder()
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

BytesStream 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)