Package org.elasticsearch.rest

Class FilterRestHandler

java.lang.Object

org.elasticsearch.rest.FilterRestHandler

All Implemented Interfaces:

RestHandler

Direct Known Subclasses:

DeprecationRestHandler

public abstract class FilterRestHandler
extends Object
implements RestHandler

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.rest.RestHandler

RestHandler.Route

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FilterRestHandler(RestHandler delegate)

Method Summary

Modifier and Type	Method	Description
boolean	allowsUnsafeBuffers()	Indicates if the RestHandler supports working with pooled buffers.
boolean	allowSystemIndexAccessByDefault()	Controls whether requests handled by this class are allowed to to access system indices by default.
boolean	canTripCircuitBreaker()
RestHandler	getConcreteRestHandler()	Returns the concrete RestHandler for this RestHandler.
protected RestHandler	getDelegate()
List<RestHandler.Route>	routes()	The list of RestHandler.Routes that this RestHandler is responsible for handling.
boolean	supportsContentStream()	Indicates if the RestHandler supports content as a stream.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.rest.RestHandler

handleRequest

Constructor Details

FilterRestHandler

protected FilterRestHandler(RestHandler delegate)

Method Details

getDelegate

protected RestHandler getDelegate()

getConcreteRestHandler

public RestHandler getConcreteRestHandler()

Description copied from interface: RestHandler

Returns the concrete RestHandler for this RestHandler. That is, if this is a delegating RestHandler it returns the delegate. Otherwise it returns itself.

Specified by:

getConcreteRestHandler in interface RestHandler

Returns:

The underlying RestHandler

routes

public List<RestHandler.Route> routes()

Description copied from interface: RestHandler

The list of RestHandler.Routes that this RestHandler is responsible for handling.

Specified by:

routes in interface RestHandler

allowSystemIndexAccessByDefault

public boolean allowSystemIndexAccessByDefault()

Description copied from interface: RestHandler

Controls whether requests handled by this class are allowed to to access system indices by default.

Specified by:

allowSystemIndexAccessByDefault in interface RestHandler

Returns:

true if requests handled by this class should be allowed to access system indices.

canTripCircuitBreaker

public boolean canTripCircuitBreaker()

Specified by:

canTripCircuitBreaker in interface RestHandler

allowsUnsafeBuffers

public boolean allowsUnsafeBuffers()

Description copied from interface: RestHandler

Indicates if the RestHandler supports working with pooled buffers. If the request handler will not escape the return RestRequest.content() or any buffers extracted from it then there is no need to make a copies of any pooled buffers in the RestRequest instance before passing a request to this handler. If this instance does not support pooled/unsafe buffers RestRequest.ensureSafeBuffers() should be called on any request before passing it to RestHandler.handleRequest(org.elasticsearch.rest.RestRequest, org.elasticsearch.rest.RestChannel, org.elasticsearch.client.node.NodeClient).

Specified by:

allowsUnsafeBuffers in interface RestHandler

Returns:

true iff the handler supports requests that make use of pooled buffers

supportsContentStream

public boolean supportsContentStream()

Description copied from interface: RestHandler

Indicates if the RestHandler supports content as a stream. A stream would be multiple objects delineated by XContent.streamSeparator(). If a handler returns true this will affect the types of content that can be sent to this endpoint.

Specified by:

supportsContentStream in interface RestHandler