Package org.elasticsearch.action.support

Class ActionFilter.Simple

org.elasticsearch.action.support.ActionFilter.Simple
All Implemented Interfaces:
ActionFilter
Enclosing interface:
ActionFilter
public abstract static class ActionFilter.Simple extends implements ActionFilter
A simple base class for injectable action filters that spares the implementation from handling the filter chain. This base class should serve any action filter implementations that doesn't require to apply async filtering logic.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.elasticsearch.action.support.ActionFilter

    ActionFilter.Simple

  • Constructor Summary

    Constructors
    Constructor
    Description
    Simple()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected abstract boolean
     action, ActionRequest request, ActionListener<?> listener)
    Applies this filter and returns true if the execution chain should proceed, or false if it should be aborted since the filter already handled the request and called the given listener.
    <Request extends ActionRequest,​ Response extends ActionResponse>
    void
    apply​(Task task,  action, Request request, ActionListener<Response> listener, ActionFilterChain<Request,​Response> chain)
    Enables filtering the execution of an action on the request side, either by sending a response through the ActionListener or by continuing the execution through the given chain

    Methods inherited from class java.lang.

    , , , , , , , , , ,

    Methods inherited from interface org.elasticsearch.action.support.ActionFilter

    order

  • Constructor Details

    • Simple

      public Simple()

  • Method Details

    • apply

      public final <Request extends ActionRequest,​ Response extends ActionResponse> void apply​(Task task,  action, Request request, ActionListener<Response> listener, ActionFilterChain<Request,​Response> chain)
      Description copied from interface: ActionFilter
      Enables filtering the execution of an action on the request side, either by sending a response through the ActionListener or by continuing the execution through the given chain
      Specified by:
      apply in interface ActionFilter

    • apply

      protected abstract boolean apply​( action, ActionRequest request, ActionListener<?> listener)
      Applies this filter and returns true if the execution chain should proceed, or false if it should be aborted since the filter already handled the request and called the given listener.