org.elasticsearch.rest

Class AbstractRestChannel

java.lang.Object

org.elasticsearch.rest.AbstractRestChannel

All Implemented Interfaces:

RestChannel

Direct Known Subclasses:

NettyHttpChannel

public abstract class AbstractRestChannel
extends Object
implements RestChannel

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	detailedErrorsEnabled
protected RestRequest	request

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRestChannel(RestRequest request, boolean detailedErrorsEnabled)

Method Summary

Methods

Modifier and Type	Method and Description
BytesStreamOutput	bytesOutput() A channel level bytes output that can be reused.
boolean	detailedErrorsEnabled()
XContentBuilder	newBuilder()
XContentBuilder	newBuilder(BytesReference autoDetectSource, boolean useFiltering)
protected BytesStreamOutput	newBytesOutput()
XContentBuilder	newErrorBuilder()
RestRequest	request()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.rest.RestChannel

sendResponse

Field Detail

request

protected final RestRequest request

detailedErrorsEnabled

protected final boolean detailedErrorsEnabled

Constructor Detail

AbstractRestChannel

protected AbstractRestChannel(RestRequest request,
                   boolean detailedErrorsEnabled)

Method Detail

newBuilder

public XContentBuilder newBuilder()
                           throws IOException

Specified by:

newBuilder in interface RestChannel

Throws:

IOException

newErrorBuilder

public XContentBuilder newErrorBuilder()
                                throws IOException

Specified by:

newErrorBuilder in interface RestChannel

Throws:

IOException

newBuilder

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

Specified by:

newBuilder in interface RestChannel

Throws:

IOException

bytesOutput

public final BytesStreamOutput bytesOutput()

A channel level bytes output that can be reused. It gets reset on each call to this method.

Specified by:

bytesOutput in interface RestChannel

newBytesOutput

protected BytesStreamOutput newBytesOutput()

request

public RestRequest request()

Specified by:

request in interface RestChannel

detailedErrorsEnabled

public boolean detailedErrorsEnabled()

Specified by:

detailedErrorsEnabled in interface RestChannel

Returns:

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