org.elasticsearch.rest.RestChannel Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation
Show all versions of elasticsearch Show documentation
Elasticsearch subproject :server
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
package org.elasticsearch.rest;
import org.elasticsearch.common.io.stream.BytesStream;
import org.elasticsearch.core.Nullable;
import org.elasticsearch.xcontent.XContentBuilder;
import org.elasticsearch.xcontent.XContentType;
import java.io.IOException;
/**
* A channel used to construct bytes / builder based outputs, and send responses.
*/
public interface RestChannel {
XContentBuilder newBuilder() throws IOException;
XContentBuilder newErrorBuilder() throws IOException;
XContentBuilder newBuilder(@Nullable XContentType xContentType, boolean useFiltering) throws IOException;
XContentBuilder newBuilder(@Nullable XContentType xContentType, @Nullable XContentType responseContentType, boolean useFiltering)
throws IOException;
BytesStream bytesOutput();
RestRequest request();
/**
* @return true iff an error response should contain additional details like exception traces.
*/
boolean detailedErrorsEnabled();
void sendResponse(RestResponse response);
}