org.elasticsearch.rest

Class BaseRestHandler

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.rest.BaseRestHandler

All Implemented Interfaces:

RestHandler

Direct Known Subclasses:

AbstractCatAction, RestAliasesExistAction, RestAnalyzeAction, RestBulkAction, RestCancelTasksAction, RestCatAction, RestClearIndicesCacheAction, RestClearScrollAction, RestCloseIndexAction, RestClusterGetSettingsAction, RestClusterHealthAction, RestClusterRerouteAction, RestClusterSearchShardsAction, RestClusterStateAction, RestClusterStatsAction, RestClusterUpdateSettingsAction, RestCountAction, RestCreateIndexAction, RestCreateSnapshotAction, RestDeleteAction, RestDeleteIndexAction, RestDeleteIndexedScriptAction, RestDeleteIndexTemplateAction, RestDeleteRepositoryAction, RestDeleteSnapshotAction, RestDeleteWarmerAction, RestExistsAction, RestExplainAction, RestFieldStatsAction, RestFlushAction, RestForceMergeAction, RestGetAction, RestGetAliasesAction, RestGetFieldMappingAction, RestGetIndexedScriptAction, RestGetIndexTemplateAction, RestGetIndicesAction, RestGetIndicesAliasesAction, RestGetMappingAction, RestGetRepositoriesAction, RestGetSettingsAction, RestGetSnapshotsAction, RestGetSourceAction, RestGetWarmerAction, RestHeadAction, RestHeadIndexTemplateAction, RestIndexAction, RestIndexDeleteAliasesAction, RestIndexPutAliasAction, RestIndicesAliasesAction, RestIndicesExistsAction, RestIndicesSegmentsAction, RestIndicesShardStoresAction, RestIndicesStatsAction, RestListTasksAction, RestMainAction, RestMultiGetAction, RestMultiPercolateAction, RestMultiSearchAction, RestMultiTermVectorsAction, RestNodesHotThreadsAction, RestNodesInfoAction, RestNodesStatsAction, RestOpenIndexAction, RestPendingClusterTasksAction, RestPercolateAction, RestPutIndexedScriptAction, RestPutIndexTemplateAction, RestPutMappingAction, RestPutRepositoryAction, RestPutWarmerAction, RestRecoveryAction, RestRefreshAction, RestRenderSearchTemplateAction, RestRestoreSnapshotAction, RestSearchAction, RestSearchScrollAction, RestSnapshotsStatusAction, RestSuggestAction, RestSyncedFlushAction, RestTermVectorsAction, RestTypesExistsAction, RestUpdateAction, RestUpdateSettingsAction, RestUpgradeAction, RestValidateQueryAction, RestVerifyRepositoryAction

public abstract class BaseRestHandler
extends AbstractComponent
implements RestHandler

Base handler for REST requests.

This handler makes sure that the headers & context of the handled requests are copied over to the transport requests executed by the associated client. While the context is fully copied over, not all the headers are copied, but a selected few. It is possible to control what headers are copied over by registering them using RestController.registerRelevantHeaders(String...)

Field Summary

Fields

Modifier and Type	Field and Description
protected ParseFieldMatcher	parseFieldMatcher

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseRestHandler(Settings settings, RestController controller, Client client)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canTripCircuitBreaker()
void	handleRequest(RestRequest request, RestChannel channel)
protected abstract void	handleRequest(RestRequest request, RestChannel channel, Client client)

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Field Detail

parseFieldMatcher

protected final ParseFieldMatcher parseFieldMatcher

Constructor Detail

BaseRestHandler

protected BaseRestHandler(Settings settings,
               RestController controller,
               Client client)

Method Detail

handleRequest

public final void handleRequest(RestRequest request,
                 RestChannel channel)
                         throws Exception

Specified by:

handleRequest in interface RestHandler

Throws:

Exception

handleRequest

protected abstract void handleRequest(RestRequest request,
                 RestChannel channel,
                 Client client)
                               throws Exception

Throws:

Exception

canTripCircuitBreaker

public boolean canTripCircuitBreaker()

Specified by:

canTripCircuitBreaker in interface RestHandler