Package org.elasticsearch.action.support

Class GroupedActionListener<T>

java.lang.Object
org.elasticsearch.action.support.GroupedActionListener<T>
All Implemented Interfaces:
ActionListener<T>
public final class GroupedActionListener<T>
extends java.lang.Object
implements ActionListener<T>
An action listener that delegates its results to another listener once it has received N results (either successes or failures). This allows synchronous tasks to be forked off in a loop with the same listener and respond to a higher level listener once all tasks responded.

  • Nested Class Summary

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

    ActionListener.MappedActionListener<Response,​MappedResponse>

  • Constructor Summary

    Constructors
    Constructor Description
    GroupedActionListener​(ActionListener<java.util.Collection<T>> delegate, int groupSize)
    Creates a new listener

  • 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​(T element)
    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

    • GroupedActionListener

      public GroupedActionListener​(ActionListener<java.util.Collection<T>> delegate, int groupSize)
      Creates a new listener
      Parameters:
      delegate - the delegate listener
      groupSize - the group size

  • Method Details

    • onResponse

      public void onResponse​(T element)
      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<T>

    • onFailure

      public 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<T>