Module org.elasticsearch.server

Package org.elasticsearch.rest.action

Class RestBuilderListener<Response>

java.lang.Object

org.elasticsearch.rest.action.RestActionListener<Response>

org.elasticsearch.rest.action.RestResponseListener<Response>

org.elasticsearch.rest.action.RestBuilderListener<Response>

All Implemented Interfaces:

ActionListener<Response>

Direct Known Subclasses:

RestActions.NodesResponseRestListener, RestToXContentListener

public abstract class RestBuilderListener<Response>
extends RestResponseListener<Response>

A REST action listener that builds an XContentBuilder based response.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.action.ActionListener

ActionListener.Delegating<Response,DelegateResponse>, ActionListener.DelegatingActionListener<T>, ActionListener.DelegatingFailureActionListener<T,R>, ActionListener.MappedActionListener<Response,MappedResponse>, ActionListener.RunAfterActionListener<T>, ActionListener.RunBeforeActionListener<T>

Field Summary

Fields inherited from class org.elasticsearch.rest.action.RestActionListener

channel

Fields inherited from interface org.elasticsearch.action.ActionListener

NOOP

Constructor Summary

Constructors

Constructor	Description
RestBuilderListener(RestChannel channel)

Method Summary

Modifier and Type	Method	Description
final RestResponse	buildResponse(Response response)	Builds the response to send back through the channel.
abstract RestResponse	buildResponse(Response response, XContentBuilder builder)	Builds a response to send back over the channel.

Methods inherited from class org.elasticsearch.rest.action.RestResponseListener

processResponse

Methods inherited from class org.elasticsearch.rest.action.RestActionListener

ensureOpen, onFailure, onResponse

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.action.ActionListener

delegateFailure, delegateResponse, map

Constructor Details

RestBuilderListener

public RestBuilderListener(RestChannel channel)

Method Details

buildResponse

public final RestResponse buildResponse(Response response)
                                 throws Exception

Description copied from class: RestResponseListener

Builds the response to send back through the channel.

Specified by:

buildResponse in class RestResponseListener<Response>

Throws:

Exception

buildResponse

public abstract RestResponse buildResponse(Response response,
 XContentBuilder builder)
                                    throws Exception

Builds a response to send back over the channel. Implementors should ensure that they close the provided XContentBuilder using the XContentBuilder.close() method.

Throws:

Exception