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
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.MappedActionListener<Response,MappedResponse>
-
Field Summary
Fields inherited from class org.elasticsearch.rest.action.RestActionListener
channel
-
Constructor Summary
Constructors Constructor Description RestBuilderListener(RestChannel channel)
-
Method Summary
Modifier and Type Method Description RestResponse
buildResponse(Response response)
Builds the response to send back through the channel.abstract RestResponse
buildResponse(Response response, org.elasticsearch.common.xcontent.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
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
map
-
Constructor Details
-
RestBuilderListener
-
-
Method Details
-
buildResponse
Description copied from class:RestResponseListener
Builds the response to send back through the channel.- Specified by:
buildResponse
in classRestResponseListener<Response>
- Throws:
java.lang.Exception
-
buildResponse
public abstract RestResponse buildResponse(Response response, org.elasticsearch.common.xcontent.XContentBuilder builder) throws java.lang.ExceptionBuilds a response to send back over the channel. Implementors should ensure that they close the providedXContentBuilder
using theXContentBuilder.close()
method.- Throws:
java.lang.Exception
-