Module org.elasticsearch.server

Package org.elasticsearch.rest

Class RestResponse

java.lang.Object

org.elasticsearch.rest.RestResponse

public class RestResponse
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TEXT_CONTENT_TYPE

Constructor Summary

Constructors

Constructor	Description
RestResponse(RestChannel channel, Exception e)
RestResponse(RestChannel channel, RestStatus status, Exception e)
RestResponse(RestStatus status, String content)	Creates a new plain text response.
RestResponse(RestStatus status, String responseMediaType, String content)	Creates a new plain text response.
RestResponse(RestStatus status, String responseMediaType, BytesReference content)
RestResponse(RestStatus status, ChunkedRestResponseBody content)
RestResponse(RestStatus status, XContentBuilder builder)	Creates a new response based on XContentBuilder.

Method Summary

Modifier and Type	Method	Description
void	addHeader(String name, String value)	Add a custom header.
ChunkedRestResponseBody	chunkedContent()
BytesReference	content()
String	contentType()
void	copyHeaders(ElasticsearchException ex)
static ElasticsearchStatusException	errorFromXContent(XContentParser parser)
Map<String,List<String>>	filterHeaders(Map<String,List<String>> headers)
Map<String,List<String>>	getHeaders()	Returns custom headers that have been added.
boolean	isChunked()
protected boolean	skipStackTrace()
RestStatus	status()

Methods inherited from class java.lang.Object

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

Field Details

TEXT_CONTENT_TYPE

public static final String TEXT_CONTENT_TYPE

See Also:

• Constant Field Values

Constructor Details

RestResponse

public RestResponse(RestStatus status,
 XContentBuilder builder)

Creates a new response based on XContentBuilder.

RestResponse

public RestResponse(RestStatus status,
 String content)

Creates a new plain text response.

RestResponse

public RestResponse(RestStatus status,
 String responseMediaType,
 String content)

Creates a new plain text response.

RestResponse

public RestResponse(RestStatus status,
 String responseMediaType,
 BytesReference content)

RestResponse

public RestResponse(RestStatus status,
 ChunkedRestResponseBody content)

RestResponse

public RestResponse(RestChannel channel,
 Exception e)
             throws IOException

Throws:

IOException

RestResponse

public RestResponse(RestChannel channel,
 RestStatus status,
 Exception e)
             throws IOException

Throws:

IOException

Method Details

contentType

public String contentType()

content

@Nullable
public BytesReference content()

chunkedContent

@Nullable
public ChunkedRestResponseBody chunkedContent()

isChunked

public boolean isChunked()

status

public RestStatus status()

skipStackTrace

protected boolean skipStackTrace()

errorFromXContent

public static ElasticsearchStatusException errorFromXContent(XContentParser parser)
                                                      throws IOException

Throws:

IOException

copyHeaders

public void copyHeaders(ElasticsearchException ex)

addHeader

public void addHeader(String name,
 String value)

Add a custom header.

getHeaders

public Map<String,List<String>> getHeaders()

Returns custom headers that have been added. This method should not be used to mutate headers.

filterHeaders

public Map<String,List<String>> filterHeaders(Map<String,List<String>> headers)