Package org.elasticsearch.rest.action

Class RestActionListener<Response>

java.lang.Object
org.elasticsearch.rest.action.RestActionListener<Response>
All Implemented Interfaces:
ActionListener<Response>
Direct Known Subclasses:
DispatchingRestToXContentListener, RestResponseListener
public abstract class RestActionListener<Response>
extends java.lang.Object
implements ActionListener<Response>
An action listener that requires processResponse(Object) to be implemented and will automatically handle failures.

  • Nested Class Summary

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

    ActionListener.MappedActionListener<Response,​MappedResponse>

  • Field Summary

    Fields
    Modifier and Type Field Description
    protected RestChannel channel  

  • Constructor Summary

    Constructors
    Modifier Constructor Description
    protected RestActionListener​(RestChannel channel)  

  • Method Summary

    Modifier and Type Method Description
    void onFailure​(java.lang.Exception e)
    A failure caused by an exception at some phase of the task.
    void onResponse​(Response response)
    Handle action response.
    protected abstract void processResponse​(Response response)  

    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

  • Field Details

  • Constructor Details

    • RestActionListener

      protected RestActionListener​(RestChannel channel)

  • Method Details

    • onResponse

      public final void onResponse​(Response response)
      Description copied from interface: ActionListener
      Handle action response. This response may constitute a failure or a success but it is up to the listener to make that decision.
      Specified by:
      onResponse in interface ActionListener<Response>

    • processResponse

      protected abstract void processResponse​(Response response) throws java.lang.Exception
      Throws:
      java.lang.Exception

    • onFailure

      public final void onFailure​(java.lang.Exception e)
      Description copied from interface: ActionListener
      A failure caused by an exception at some phase of the task.
      Specified by:
      onFailure in interface ActionListener<Response>