org.elasticsearch.action.support

Interface ActionFilter

All Known Implementing Classes:

ActionFilter.Simple

public interface ActionFilter

A filter allowing to filter transport actions

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ActionFilter.Simple A simple base class for injectable action filters that spares the implementation from handling the filter chain.

Method Summary

Methods

Modifier and Type	Method and Description
void	apply(String action, ActionResponse response, ActionListener listener, ActionFilterChain chain) Enables filtering the execution of an action on the response side, either by sending a response through the ActionListener or by continuing the execution through the given chain
void	apply(Task task, String action, ActionRequest request, ActionListener listener, ActionFilterChain 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
int	order() The position of the filter in the chain.

Method Detail

order

int order()

The position of the filter in the chain. Execution is done from lowest order to highest.

apply

void apply(Task task,
         String action,
         ActionRequest request,
         ActionListener listener,
         ActionFilterChain 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

apply

void apply(String action,
         ActionResponse response,
         ActionListener listener,
         ActionFilterChain chain)

Enables filtering the execution of an action on the response side, either by sending a response through the ActionListener or by continuing the execution through the given chain