Package org.elasticsearch.rest
Class FilterRestHandler
java.lang.Object
org.elasticsearch.rest.FilterRestHandler
- All Implemented Interfaces:
RestHandler
- Direct Known Subclasses:
DeprecationRestHandler
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.rest.RestHandler
RestHandler.Route
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Indicates if the RestHandler supports working with pooled buffers.boolean
Controls whether requests handled by this class are allowed to to access system indices by default.boolean
Returns the concrete RestHandler for this RestHandler.protected RestHandler
routes()
The list ofRestHandler.Route
s that this RestHandler is responsible for handling.boolean
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
-
-
Method Details
-
getDelegate
-
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 interfaceRestHandler
- Returns:
- The underlying RestHandler
-
routes
Description copied from interface:RestHandler
The list ofRestHandler.Route
s that this RestHandler is responsible for handling.- Specified by:
routes
in interfaceRestHandler
-
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 interfaceRestHandler
- Returns:
true
if requests handled by this class should be allowed to access system indices.
-
canTripCircuitBreaker
public boolean canTripCircuitBreaker()- Specified by:
canTripCircuitBreaker
in interfaceRestHandler
-
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 returnRestRequest.content()
or any buffers extracted from it then there is no need to make a copies of any pooled buffers in theRestRequest
instance before passing a request to this handler. If this instance does not support pooled/unsafe buffersRestRequest.ensureSafeBuffers()
should be called on any request before passing it toRestHandler.handleRequest(org.elasticsearch.rest.RestRequest, org.elasticsearch.rest.RestChannel, org.elasticsearch.client.node.NodeClient)
.- Specified by:
allowsUnsafeBuffers
in interfaceRestHandler
- 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 byXContent.streamSeparator()
. If a handler returns true this will affect the types of content that can be sent to this endpoint.- Specified by:
supportsContentStream
in interfaceRestHandler
-