Package org.opensearch.http.netty4

Class Netty4HttpServerTransport

java.lang.Object

org.opensearch.common.component.AbstractLifecycleComponent

org.opensearch.http.AbstractHttpServerTransport

org.opensearch.http.netty4.Netty4HttpServerTransport

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, LifecycleComponent, Releasable, HttpServerTransport, ReportingService<HttpInfo>

public class Netty4HttpServerTransport
extends AbstractHttpServerTransport

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	Netty4HttpServerTransport.HttpChannelHandler

Nested classes/interfaces inherited from interface org.opensearch.http.HttpServerTransport

HttpServerTransport.Dispatcher

Nested classes/interfaces inherited from interface org.opensearch.node.ReportingService

ReportingService.Info

Field Summary

Fields

Modifier and Type	Field	Description
static io.netty.util.AttributeKey<Netty4HttpChannel>	HTTP_CHANNEL_KEY
static Setting<java.lang.Integer>	SETTING_HTTP_NETTY_MAX_COMPOSITE_BUFFER_COMPONENTS
static Setting<ByteSizeValue>	SETTING_HTTP_NETTY_RECEIVE_PREDICTOR_SIZE
static Setting<java.lang.Integer>	SETTING_HTTP_WORKER_COUNT

Fields inherited from class org.opensearch.http.AbstractHttpServerTransport

bigArrays, corsHandler, dispatcher, handlingSettings, maxContentLength, networkService, port, settings, threadPool

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

lifecycle

Fields inherited from interface org.opensearch.http.HttpServerTransport

HTTP_SERVER_WORKER_THREAD_NAME_PREFIX

Constructor Summary

Constructors

Constructor	Description
Netty4HttpServerTransport(Settings settings, NetworkService networkService, BigArrays bigArrays, ThreadPool threadPool, NamedXContentRegistry xContentRegistry, HttpServerTransport.Dispatcher dispatcher, ClusterSettings clusterSettings, SharedGroupFactory sharedGroupFactory)

Method Summary

Modifier and Type	Method	Description
protected HttpServerChannel	bind(java.net.InetSocketAddress socketAddress)
io.netty.channel.ChannelHandler	configureServerChannelHandler()
protected io.netty.channel.ChannelInboundHandlerAdapter	createDecompressor()	Extension point that allows a NetworkPlugin to override the default netty HttpContentDecompressor and supply a custom decompressor.
protected io.netty.channel.ChannelInboundHandlerAdapter	createHeaderVerifier()	Extension point that allows a NetworkPlugin to extend the netty pipeline and inspect headers after request decoding
protected void	doStart()
void	onException(HttpChannel channel, java.lang.Exception cause)
Settings	settings()
protected void	stopInternal()

Methods inherited from class org.opensearch.http.AbstractHttpServerTransport

bindServer, boundAddress, doClose, doStop, incomingRequest, info, onServerException, serverAcceptedChannel, stats

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

addLifecycleListener, close, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.common.component.LifecycleComponent

addLifecycleListener, lifecycleState, removeLifecycleListener, start, stop

Methods inherited from interface org.opensearch.common.lease.Releasable

close

Field Detail

SETTING_HTTP_NETTY_MAX_COMPOSITE_BUFFER_COMPONENTS

public static Setting<java.lang.Integer> SETTING_HTTP_NETTY_MAX_COMPOSITE_BUFFER_COMPONENTS

SETTING_HTTP_WORKER_COUNT

public static final Setting<java.lang.Integer> SETTING_HTTP_WORKER_COUNT

SETTING_HTTP_NETTY_RECEIVE_PREDICTOR_SIZE

public static final Setting<ByteSizeValue> SETTING_HTTP_NETTY_RECEIVE_PREDICTOR_SIZE

HTTP_CHANNEL_KEY

public static final io.netty.util.AttributeKey<Netty4HttpChannel> HTTP_CHANNEL_KEY

Constructor Detail

Netty4HttpServerTransport

public Netty4HttpServerTransport(Settings settings,
                                 NetworkService networkService,
                                 BigArrays bigArrays,
                                 ThreadPool threadPool,
                                 NamedXContentRegistry xContentRegistry,
                                 HttpServerTransport.Dispatcher dispatcher,
                                 ClusterSettings clusterSettings,
                                 SharedGroupFactory sharedGroupFactory)

Method Detail

settings

public Settings settings()

doStart

protected void doStart()

Specified by:

doStart in class AbstractLifecycleComponent

bind

protected HttpServerChannel bind(java.net.InetSocketAddress socketAddress)
                          throws java.lang.Exception

Specified by:

bind in class AbstractHttpServerTransport

Throws:

java.lang.Exception

stopInternal

protected void stopInternal()

Specified by:

stopInternal in class AbstractHttpServerTransport

onException

public void onException(HttpChannel channel,
                        java.lang.Exception cause)

Overrides:

onException in class AbstractHttpServerTransport

configureServerChannelHandler

public io.netty.channel.ChannelHandler configureServerChannelHandler()

createHeaderVerifier

protected io.netty.channel.ChannelInboundHandlerAdapter createHeaderVerifier()

Extension point that allows a NetworkPlugin to extend the netty pipeline and inspect headers after request decoding

createDecompressor

protected io.netty.channel.ChannelInboundHandlerAdapter createDecompressor()

Extension point that allows a NetworkPlugin to override the default netty HttpContentDecompressor and supply a custom decompressor. Used in instances to conditionally decompress depending on the outcome from header verification