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, RestCreateIndexAction, RestCreateSnapshotAction, RestDeleteAction, RestDeleteIndexAction, RestDeleteIndexTemplateAction, RestDeletePipelineAction, RestDeleteRepositoryAction, RestDeleteSnapshotAction, RestDeleteStoredScriptAction, RestExplainAction, RestFieldCapabilitiesAction, RestFielddataAction, RestFlushAction, RestForceMergeAction, RestGetAction, RestGetAliasesAction, RestGetFieldMappingAction, RestGetIndexTemplateAction, RestGetIndicesAction, RestGetMappingAction, RestGetPipelineAction, RestGetRepositoriesAction, RestGetSettingsAction, RestGetSnapshotsAction, RestGetSourceAction, RestGetStoredScriptAction, RestGetTaskAction, RestHealthAction, RestIndexAction, RestIndexDeleteAliasesAction, RestIndexPutAliasAction, RestIndicesAction, RestIndicesAliasesAction, RestIndicesSegmentsAction, RestIndicesShardStoresAction, RestIndicesStatsAction, RestListTasksAction, RestMainAction, RestMasterAction, RestMultiGetAction, RestMultiSearchAction, RestMultiTermVectorsAction, RestNodeAttrsAction, RestNodesAction, RestNodesHotThreadsAction, RestNodesInfoAction, RestNodesStatsAction, RestNodesUsageAction, RestOpenIndexAction, RestPendingClusterTasksAction, RestPendingClusterTasksAction, RestPluginsAction, 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

Method Summary

Modifier and Type	Method	Description
default boolean	canTripCircuitBreaker()
void	handleRequest(RestRequest request, RestChannel channel, NodeClient client)	Handles a rest request.
default boolean	supportsContentStream()	Indicates if the RestHandler supports content as a stream.

Method Detail

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.