org.elasticsearch.rest
Class RestFilter

java.lang.Object
  org.elasticsearch.rest.RestFilter

All Implemented Interfaces:

CloseableComponent

public abstract class RestFilter
extends Object
implements CloseableComponent

A filter allowing to filter rest operations.

Constructor Summary

RestFilter()

Method Summary

void	close()
int	order() Optionally, the order of the filter.
abstract void	process(RestRequest request, RestChannel channel, RestFilterChain filterChain) Process the rest request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RestFilter

public RestFilter()

Method Detail

order

public int order()

Optionally, the order of the filter. Execution is done from lowest value to highest. It is a good practice to allow to configure this for the relevant filter.

close

public void close()
           throws ElasticSearchException

Specified by:

close in interface CloseableComponent

Throws:

ElasticSearchException

process

public abstract void process(RestRequest request,
                             RestChannel channel,
                             RestFilterChain filterChain)

Process the rest request. Using the channel to send a response, or the filter chain to continue processing the request.