org.elasticsearch.rest

Class RestController

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.common.component.AbstractLifecycleComponent<RestController>

org.elasticsearch.rest.RestController

All Implemented Interfaces:

AutoCloseable, LifecycleComponent<RestController>, Releasable

public class RestController
extends AbstractLifecycleComponent<RestController>

Field Summary

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

lifecycle

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

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
RestController(Settings settings)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canTripCircuitBreaker(RestRequest request)
void	dispatchRequest(RestRequest request, RestChannel channel)
protected void	doClose()
protected void	doStart()
protected void	doStop()
RestFilterChain	filterChain(RestFilter executionFilter) Returns a filter chain with the final filter being the provided filter.
RestFilterChain	filterChainOrNull(RestFilter executionFilter) Returns a filter chain (if needed) to execute.
void	registerFilter(RestFilter preProcessor) Registers a pre processor to be executed before the rest request is actually handled.
void	registerHandler(RestRequest.Method method, String path, RestHandler handler) Registers a rest handler to be executed when the provided method and path match the request.
void	registerRelevantHeaders(String... headers) Controls which REST headers get copied over from a RestRequest to its corresponding TransportRequest(s).
com.google.common.collect.ImmutableSet<String>	relevantHeaders() Returns the REST headers that get copied over from a RestRequest to its corresponding TransportRequest(s).
void	sendErrorResponse(RestRequest request, RestChannel channel, Throwable e)

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

addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

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

Constructor Detail

RestController

@Inject
public RestController(Settings settings)

Method Detail

doStart

protected void doStart()

Specified by:

doStart in class AbstractLifecycleComponent<RestController>

doStop

protected void doStop()

Specified by:

doStop in class AbstractLifecycleComponent<RestController>

doClose

protected void doClose()

Specified by:

doClose in class AbstractLifecycleComponent<RestController>

registerRelevantHeaders

public void registerRelevantHeaders(String... headers)

Controls which REST headers get copied over from a RestRequest to its corresponding TransportRequest(s). By default no headers get copied but it is possible to extend this behaviour via plugins by calling this method.

relevantHeaders

public com.google.common.collect.ImmutableSet<String> relevantHeaders()

Returns the REST headers that get copied over from a RestRequest to its corresponding TransportRequest(s). By default no headers get copied but it is possible to extend this behaviour via plugins by calling registerRelevantHeaders(String...).

registerFilter

public void registerFilter(RestFilter preProcessor)

Registers a pre processor to be executed before the rest request is actually handled.

registerHandler

public void registerHandler(RestRequest.Method method,
                   String path,
                   RestHandler handler)

Registers a rest handler to be executed when the provided method and path match the request.

filterChainOrNull

@Nullable
public RestFilterChain filterChainOrNull(RestFilter executionFilter)

Returns a filter chain (if needed) to execute. If this method returns null, simply execute as usual.

filterChain

public RestFilterChain filterChain(RestFilter executionFilter)

Returns a filter chain with the final filter being the provided filter.

canTripCircuitBreaker

public boolean canTripCircuitBreaker(RestRequest request)

Parameters:

request - The current request. Must not be null.

Returns:

true iff the circuit breaker limit must be enforced for processing this request.

dispatchRequest

public void dispatchRequest(RestRequest request,
                   RestChannel channel)
                     throws Exception

Throws:

Exception

sendErrorResponse

public void sendErrorResponse(RestRequest request,
                     RestChannel channel,
                     Throwable e)