Package org.elasticsearch.action

Class NotifyOnceListener<Response>

java.lang.Object
org.elasticsearch.action.NotifyOnceListener<Response>
All Implemented Interfaces:
ActionListener<Response>
Direct Known Subclasses:
StepListener
public abstract class NotifyOnceListener<Response>
extends java.lang.Object
implements ActionListener<Response>
A listener that ensures that only one of onResponse or onFailure is called. And the method the is called is only called once. Subclasses should implement notification logic with innerOnResponse and innerOnFailure.

  • Nested Class Summary

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

    ActionListener.MappedActionListener<Response,​MappedResponse>

  • Constructor Summary

    Constructors
    Constructor Description
    NotifyOnceListener()  

  • Method Summary

    Modifier and Type Method Description
    protected abstract void innerOnFailure​(java.lang.Exception e)  
    protected abstract void innerOnResponse​(Response response)  
    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.

    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

    • NotifyOnceListener

      public NotifyOnceListener()

  • Method Details

    • innerOnResponse

      protected abstract void innerOnResponse​(Response response)

    • innerOnFailure

      protected abstract void innerOnFailure​(java.lang.Exception e)

    • 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>

    • 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>