org.elasticsearch.rest

クラス RestController

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

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

org.elasticsearch.rest.RestController

すべての実装されたインタフェース:

AutoCloseable, LifecycleComponent<RestController>, Releasable

public class RestController
extends AbstractLifecycleComponent<RestController>

フィールドのサマリー

クラスから継承されたフィールド org.elasticsearch.common.component.AbstractLifecycleComponent

lifecycle

クラスから継承されたフィールド org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
RestController(Settings settings)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
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 execute 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).

クラスから継承されたメソッド org.elasticsearch.common.component.AbstractLifecycleComponent

addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

クラスから継承されたメソッド org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

RestController

@Inject
public RestController(Settings settings)

メソッドの詳細

doStart

protected void doStart()

定義:

doStart クラス内 AbstractLifecycleComponent<RestController>

doStop

protected void doStop()

定義:

doStop クラス内 AbstractLifecycleComponent<RestController>

doClose

protected void doClose()

定義:

doClose クラス内 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 execute 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.

dispatchRequest

public void dispatchRequest(RestRequest request,
                            RestChannel channel)