Module org.elasticsearch.server

Package org.elasticsearch.http

Interface HttpRequest

All Superinterfaces:

HttpPreRequest

public interface HttpRequest
extends HttpPreRequest

A basic http request abstraction. Http modules needs to implement this interface to integrate with the server package's rest handling. This interface exposes the request's content as well as methods to be used to generate a response.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	HttpRequest.HttpVersion

Method Summary

Modifier and Type	Method	Description
HttpBody	body()
HttpResponse	createResponse(RestStatus status, BytesReference content)	Create an http response from this request and the supplied status and content.
HttpResponse	createResponse(RestStatus status, ChunkedRestResponseBodyPart firstBodyPart)
Exception	getInboundException()
boolean	hasContent()
HttpRequest.HttpVersion	protocolVersion()
void	release()	Release any resources associated with this request.
HttpRequest	removeHeader(String header)
void	setBody(HttpBody body)
List<String>	strictCookies()

Methods inherited from interface org.elasticsearch.http.HttpPreRequest

getHeaders, header, method, rawPath, uri

Method Details

body

HttpBody body()

setBody

void setBody(HttpBody body)

strictCookies

List<String> strictCookies()

protocolVersion

HttpRequest.HttpVersion protocolVersion()

removeHeader

HttpRequest removeHeader(String header)

hasContent

boolean hasContent()

createResponse

HttpResponse createResponse(RestStatus status,
 BytesReference content)

Create an http response from this request and the supplied status and content.

createResponse

HttpResponse createResponse(RestStatus status,
 ChunkedRestResponseBodyPart firstBodyPart)

getInboundException

@Nullable
Exception getInboundException()

release

void release()

Release any resources associated with this request. Implementations should be idempotent. The behavior of body() after this method has been invoked is undefined and implementation specific.