Package org.opensearch.rest

Class RestHandler.Wrapper

java.lang.Object

org.opensearch.rest.RestHandler.Wrapper

All Implemented Interfaces:

RestHandler

Enclosing interface:

RestHandler

public static class RestHandler.Wrapper
extends java.lang.Object
implements RestHandler

Nested Class Summary

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

RestHandler.DeprecatedRoute, RestHandler.ReplacedRoute, RestHandler.Route, RestHandler.Wrapper

Constructor Summary

Constructors

Constructor	Description
Wrapper(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()
java.util.List<RestHandler.DeprecatedRoute>	deprecatedRoutes()	A list of routes handled by this RestHandler that are deprecated and do not have a direct replacement.
void	handleRequest(RestRequest request, RestChannel channel, NodeClient client)	Handles a rest request.
java.util.List<RestHandler.ReplacedRoute>	replacedRoutes()	A list of routes handled by this RestHandler that have had their path and/or method changed.
java.util.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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Wrapper

public Wrapper(RestHandler delegate)

Method Details

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

handleRequest

public void handleRequest(RestRequest request, RestChannel channel, NodeClient client) throws java.lang.Exception

Description copied from interface: RestHandler

Handles a rest request.

Specified by:

handleRequest in interface RestHandler

Parameters:

request - The request to handle

channel - The channel to write the request response to

client - A client to use to make internal requests on behalf of the original request

Throws:

java.lang.Exception

canTripCircuitBreaker

public boolean canTripCircuitBreaker()

Specified by:

canTripCircuitBreaker in interface RestHandler

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

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.opensearch.rest.RestRequest, org.opensearch.rest.RestChannel, org.opensearch.client.node.NodeClient).

Specified by:

allowsUnsafeBuffers in interface RestHandler

Returns:

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

routes

public java.util.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

deprecatedRoutes

public java.util.List<RestHandler.DeprecatedRoute> deprecatedRoutes()

Description copied from interface: RestHandler

A list of routes handled by this RestHandler that are deprecated and do not have a direct replacement. If changing the path or method of a route, use RestHandler.replacedRoutes().

Specified by:

deprecatedRoutes in interface RestHandler

replacedRoutes

public java.util.List<RestHandler.ReplacedRoute> replacedRoutes()

Description copied from interface: RestHandler

A list of routes handled by this RestHandler that have had their path and/or method changed. The pre-existing route will be registered as deprecated alongside the updated route.

Specified by:

replacedRoutes 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.