Module org.elasticsearch.server

Package org.elasticsearch.rest.action.cat

Class AbstractCatAction

java.lang.Object

org.elasticsearch.rest.BaseRestHandler

org.elasticsearch.rest.action.cat.AbstractCatAction

All Implemented Interfaces:

RestHandler

Direct Known Subclasses:

RestAliasAction, RestAllocationAction, RestCatComponentTemplateAction, RestCatRecoveryAction, RestCountAction, RestFielddataAction, RestHealthAction, RestIndicesAction, RestMasterAction, RestNodeAttrsAction, RestNodesAction, RestPendingClusterTasksAction, RestPluginsAction, RestRepositoriesAction, RestSegmentsAction, RestShardsAction, RestSnapshotAction, RestTasksAction, RestTemplatesAction, RestThreadPoolAction

public abstract class AbstractCatAction
extends BaseRestHandler

Nested Class Summary

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

BaseRestHandler.RestChannelConsumer

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

RestHandler.Route

Field Summary

Fields inherited from class org.elasticsearch.rest.BaseRestHandler

DEFAULT_INCLUDE_TYPE_NAME_POLICY, INCLUDE_TYPE_NAME_PARAMETER, MULTI_ALLOW_EXPLICIT_INDEX

Constructor Summary

Constructors

Constructor	Description
AbstractCatAction()

Method Summary

Modifier and Type	Method	Description
protected abstract BaseRestHandler.RestChannelConsumer	doCatRequest(RestRequest request, NodeClient client)
protected abstract void	documentation(StringBuilder sb)
protected abstract Table	getTableWithHeader(RestRequest request)
BaseRestHandler.RestChannelConsumer	prepareRequest(RestRequest request, NodeClient client)	Prepare the request for execution.
protected Set<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).

Methods inherited from class org.elasticsearch.rest.BaseRestHandler

getName, getUsageCount, handleRequest, mediaTypesValid, responseParams, routes, unrecognized

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.rest.RestHandler

allowsUnsafeBuffers, allowSystemIndexAccessByDefault, canTripCircuitBreaker, supportsContentStream

Constructor Details

AbstractCatAction

public AbstractCatAction()

Method Details

doCatRequest

protected abstract BaseRestHandler.RestChannelConsumer doCatRequest(RestRequest request,
 NodeClient client)

documentation

protected abstract void documentation(StringBuilder sb)

getTableWithHeader

protected abstract Table getTableWithHeader(RestRequest request)

prepareRequest

public BaseRestHandler.RestChannelConsumer prepareRequest(RestRequest request,
 NodeClient client)
                                                   throws 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:

IOException - if an I/O exception occurred parsing the request and preparing for execution

responseParams

protected Set<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.