java.lang.Object

org.elasticsearch.rest.BaseRestHandler.Wrapper

All Implemented Interfaces:: RestHandler

Enclosing class:: BaseRestHandler

public static class BaseRestHandler.Wrapper
extends BaseRestHandler

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.rest.BaseRestHandler
BaseRestHandler.RestChannelConsumer, BaseRestHandler.Wrapper

Nested classes/interfaces inherited from interface org.elasticsearch.rest.RestHandler
RestHandler.DeprecatedRoute, RestHandler.ReplacedRoute, RestHandler.Route
Field Summary

Fields

Modifier and Type Field Description

protected BaseRestHandler delegate

Fields inherited from class org.elasticsearch.rest.BaseRestHandler
DEFAULT_INCLUDE_TYPE_NAME_POLICY, INCLUDE_TYPE_NAME_PARAMETER, logger, MULTI_ALLOW_EXPLICIT_INDEX
Constructor Summary

Constructors

Constructor Description

Wrapper(BaseRestHandler delegate)

Method Summary

Modifier and Type	Method	Description
`boolean`	`allowsUnsafeBuffers()`	Indicates if the RestHandler supports working with pooled buffers.
`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.
`java.lang.String`	`getName()`
`protected BaseRestHandler.RestChannelConsumer`	`prepareRequest(RestRequest request, NodeClient client)`	Prepare the request for execution.
`java.util.List<RestHandler.ReplacedRoute>`	`replacedRoutes()`	A list of routes handled by this RestHandler that have had their `path` and/or `method` changed.
`protected java.util.Set<java.lang.String>`	`responseParams()`	Parameters used for controlling the response and thus might not be consumed during preparation of the request execution in `BaseRestHandler.prepareRequest(RestRequest, NodeClient)`.
`java.util.List<RestHandler.Route>`	`routes()`	The list of `RestHandler.Route`s that this RestHandler is responsible for handling.
`boolean`	`supportsContentStream()`	Indicates if the RestHandler supports content as a stream.

Methods inherited from class org.elasticsearch.rest.BaseRestHandler

getUsageCount, handleRequest, unrecognized

Methods inherited from class java.lang.Object

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

Field Details
- delegate
  
  protected final BaseRestHandler delegate
Constructor Details
- Wrapper
  
  public Wrapper(BaseRestHandler delegate)
Method Details
- getName
  
  public java.lang.String getName()
  
  Specified by:
  
  getName in class BaseRestHandler
  
  Returns:
  
  the name of this handler. The name should be human readable and should describe the action that will performed when this API is called. This name is used in the response to the RestNodesUsageAction.
- routes
  
  public java.util.List<RestHandler.Route> routes()
  
  Description copied from class: BaseRestHandler
  
  The list of RestHandler.Routes that this RestHandler is responsible for handling.
  
  Specified by:
  
  routes in interface RestHandler
  
  Specified by:
  
  routes in class BaseRestHandler
- 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().
- 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.
- prepareRequest
  
  protected BaseRestHandler.RestChannelConsumer prepareRequest(RestRequest request, NodeClient client) throws java.io.IOException
  
  Description copied from class: BaseRestHandler
  
  Prepare the request for execution. Implementations should consume all request params before returning the runnable for actual execution. Unconsumed params will immediately terminate execution of the request. However, some params are only used in processing the response; implementations can override BaseRestHandler.responseParams() to indicate such params.
  
  Specified by:
  
  prepareRequest in class BaseRestHandler
  
  Parameters:
  
  request - the request to execute
  
  client - client for executing actions on the local node
  
  Returns:
  
  the action to execute
  
  Throws:
  
  java.io.IOException - if an I/O exception occurred parsing the request and preparing for execution
- responseParams
  
  protected java.util.Set<java.lang.String> responseParams()
  
  Description copied from class: BaseRestHandler
  
  Parameters used for controlling the response and thus might not be consumed during preparation of the request execution in BaseRestHandler.prepareRequest(RestRequest, NodeClient).
  
  Overrides:
  
  responseParams in class BaseRestHandler
  
  Returns:
  
  a set of parameters used to control the response and thus should not trip strict URL parameter checks.
- canTripCircuitBreaker
  
  public boolean canTripCircuitBreaker()
- 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.
- 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).
  
  Returns:
  
  true iff the handler supports requests that make use of pooled buffers

Class BaseRestHandler.Wrapper

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.rest.BaseRestHandler

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

Field Summary

Fields inherited from class org.elasticsearch.rest.BaseRestHandler

Constructor Summary

Method Summary

Methods inherited from class org.elasticsearch.rest.BaseRestHandler

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details