Package org.elasticsearch.rest

Interface RestHandler

All Known Implementing Classes:

AbstractCatAction, BaseRestHandler, DeprecationRestHandler, RestAddVotingConfigExclusionAction, RestAliasAction, RestAllocationAction, RestAnalyzeAction, RestBulkAction, RestCancelTasksAction, RestCatAction, RestCatRecoveryAction, RestCleanupRepositoryAction, RestClearIndicesCacheAction, RestClearScrollAction, RestClearVotingConfigExclusionsAction, RestCloseIndexAction, RestClusterAllocationExplainAction, RestClusterGetSettingsAction, RestClusterHealthAction, RestClusterRerouteAction, RestClusterSearchShardsAction, RestClusterStateAction, RestClusterStatsAction, RestClusterUpdateSettingsAction, RestCountAction, RestCountAction, RestCreateDataStreamAction, RestCreateIndexAction, RestCreateSnapshotAction, RestDeleteAction, RestDeleteComponentTemplateAction, RestDeleteDataStreamAction, RestDeleteIndexAction, RestDeleteIndexTemplateAction, RestDeletePipelineAction, RestDeleteRepositoryAction, RestDeleteSnapshotAction, RestDeleteStoredScriptAction, RestExplainAction, RestFieldCapabilitiesAction, RestFielddataAction, RestFlushAction, RestForceMergeAction, RestGetAction, RestGetAliasesAction, RestGetComponentTemplateAction, RestGetDataStreamsAction, RestGetFieldMappingAction, RestGetIndexTemplateAction, RestGetIndicesAction, RestGetMappingAction, RestGetPipelineAction, RestGetRepositoriesAction, RestGetScriptContextAction, RestGetScriptLanguageAction, RestGetSettingsAction, RestGetSnapshotsAction, RestGetSourceAction, RestGetStoredScriptAction, RestGetTaskAction, RestHealthAction, RestIndexAction, RestIndexAction.AutoIdHandler, RestIndexAction.CreateHandler, RestIndexDeleteAliasesAction, RestIndexPutAliasAction, RestIndicesAction, RestIndicesAliasesAction, RestIndicesSegmentsAction, RestIndicesShardStoresAction, RestIndicesStatsAction, RestListTasksAction, RestMainAction, RestMasterAction, RestMultiGetAction, RestMultiSearchAction, RestMultiTermVectorsAction, RestNodeAttrsAction, RestNodesAction, RestNodesHotThreadsAction, RestNodesInfoAction, RestNodesStatsAction, RestNodesUsageAction, RestOpenIndexAction, RestPendingClusterTasksAction, RestPendingClusterTasksAction, RestPluginsAction, RestPutComponentTemplateAction, RestPutIndexTemplateAction, RestPutMappingAction, RestPutPipelineAction, RestPutRepositoryAction, RestPutStoredScriptAction, RestRecoveryAction, RestRefreshAction, RestReloadSecureSettingsAction, RestRemoteClusterInfoAction, RestRepositoriesAction, RestResizeHandler, RestResizeHandler.RestCloneIndexAction, RestResizeHandler.RestShrinkIndexAction, RestResizeHandler.RestSplitIndexAction, RestRestoreSnapshotAction, RestRolloverIndexAction, RestSearchAction, RestSearchScrollAction, RestSegmentsAction, RestShardsAction, RestSimulatePipelineAction, RestSnapshotAction, RestSnapshotsStatusAction, RestSyncedFlushAction, RestTasksAction, RestTemplatesAction, RestTermVectorsAction, RestThreadPoolAction, RestUpdateAction, RestUpdateSettingsAction, RestUpgradeAction, RestUpgradeStatusAction, RestValidateQueryAction, RestVerifyRepositoryAction

public interface RestHandler

Handler for REST requests

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	RestHandler.DeprecatedRoute	Represents an API that has been deprecated and is slated for removal.
static class	RestHandler.ReplacedRoute	Represents an API that has had its path or method changed.
static class	RestHandler.Route

Method Summary

Modifier and Type	Method	Description
default boolean	allowsUnsafeBuffers()	Indicates if the RestHandler supports working with pooled buffers.
default boolean	canTripCircuitBreaker()
default 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.
default java.util.List<RestHandler.ReplacedRoute>	replacedRoutes()	A list of routes handled by this RestHandler that have had their path and/or method changed.
default java.util.List<RestHandler.Route>	routes()	The list of RestHandler.Routes that this RestHandler is responsible for handling.
default boolean	supportsContentStream()	Indicates if the RestHandler supports content as a stream.

Method Details

handleRequest

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

Handles a rest request.

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

default boolean canTripCircuitBreaker()

supportsContentStream

default boolean supportsContentStream()

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

default boolean allowsUnsafeBuffers()

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

routes

default java.util.List<RestHandler.Route> routes()

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

deprecatedRoutes

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

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

replacedRoutes

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

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.