org.elasticsearch.action.support

Class ActionFilter.Simple

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.action.support.ActionFilter.Simple

All Implemented Interfaces:

ActionFilter

Enclosing interface:

ActionFilter

public abstract static class ActionFilter.Simple
extends AbstractComponent
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

Field Summary

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Simple(Settings settings)

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	apply(String 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.
protected abstract boolean	apply(String action, ActionResponse response, 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 response by calling the given listener.
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

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

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.support.ActionFilter

order

Constructor Detail

Simple

protected Simple(Settings settings)

Method Detail

apply

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

apply

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

Description copied from interface: ActionFilter

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

Specified by:

apply in interface ActionFilter

apply

protected abstract boolean apply(String action,
                                 ActionResponse response,
                                 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 response by calling the given listener.