NettyHttpServerConfiguration (javadoc 2.0.3 API)

java.lang.Object
- io.micronaut.http.server.HttpServerConfiguration
- - io.micronaut.http.server.netty.configuration.NettyHttpServerConfiguration

All Implemented Interfaces:: ServerContextPathProvider

@ConfigurationProperties(value="netty")
 @Replaces(value=HttpServerConfiguration.class)
public class NettyHttpServerConfiguration
extends HttpServerConfiguration

Allows configuring Netty within NettyHttpServer.

Since:: 1.0
Author:: Graeme Rocher

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`NettyHttpServerConfiguration.AccessLogger` Access logger configuration.
`static class`	`NettyHttpServerConfiguration.EventLoopConfig` Abstract class for configuring the Netty event loop.
`static class`	`NettyHttpServerConfiguration.Http2Settings` Http2 settings.
`static class`	`NettyHttpServerConfiguration.Parent` Configuration for Netty parent.
`static class`	`NettyHttpServerConfiguration.Worker` Configuration for Netty worker.

Nested classes/interfaces inherited from class io.micronaut.http.server.HttpServerConfiguration
HttpServerConfiguration.CorsConfiguration, HttpServerConfiguration.HostResolutionConfiguration, HttpServerConfiguration.MultipartConfiguration

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_CHUNKSUPPORTED` The default chunk supported value.
`static int`	`DEFAULT_COMPRESSIONLEVEL` The default compression level.
`static int`	`DEFAULT_COMPRESSIONTHRESHOLD` The default compression threshold.
`static int`	`DEFAULT_INITIALBUFFERSIZE` The default initial buffer size value.
`static int`	`DEFAULT_MAXCHUNKSIZE` The default max chunk size.
`static int`	`DEFAULT_MAXHEADERSIZE` The default max header size.
`static int`	`DEFAULT_MAXINITIALLINELENGTH` The default max initial line length.
`static boolean`	`DEFAULT_USE_NATIVE_TRANSPORT` The default use netty's native transport flag.
`static boolean`	`DEFAULT_VALIDATEHEADERS` The default validate headers value.

Fields inherited from class io.micronaut.http.server.HttpServerConfiguration
DEFAULT_DATEHEADER, DEFAULT_DUAL_PROTOCOL, DEFAULT_IDLE_TIME_MINUTES, DEFAULT_LOG_HANDLED_EXCEPTIONS, DEFAULT_MAX_REQUEST_SIZE, DEFAULT_PORT, DEFAULT_RANDOM_PORT, DEFAULT_READ_IDLE_TIME_MINUTES, DEFAULT_WRITE_IDLE_TIME_MINUTES, PREFIX

Constructor Summary

Constructors
Constructor and Description
`NettyHttpServerConfiguration()` Default empty constructor.
`NettyHttpServerConfiguration(ApplicationConfiguration applicationConfiguration)`
`NettyHttpServerConfiguration(ApplicationConfiguration applicationConfiguration, java.util.List<ChannelPipelineListener> pipelineCustomizers)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NettyHttpServerConfiguration.AccessLogger`	`getAccessLogger()` Returns the AccessLogger configuration.
`java.util.Map<io.netty.channel.ChannelOption,java.lang.Object>`	`getChildOptions()`
`int`	`getCompressionLevel()` The default compression level.
`int`	`getCompressionThreshold()` The default compression threshold.
`java.lang.String`	`getFallbackProtocol()`
`NettyHttpServerConfiguration.Http2Settings`	`getHttp2()` Returns the Http2Settings.
`int`	`getInitialBufferSize()` The initial buffer size.
`java.util.Optional<io.netty.handler.logging.LogLevel>`	`getLogLevel()` The server `LogLevel` to enable.
`int`	`getMaxChunkSize()` The maximum chunk size.
`int`	`getMaxHeaderSize()` The maximum size of an individual HTTP setter.
`int`	`getMaxInitialLineLength()` The maximum length of the initial HTTP request line.
`java.util.Map<io.netty.channel.ChannelOption,java.lang.Object>`	`getOptions()`
`NettyHttpServerConfiguration.Parent`	`getParent()`
`java.util.List<ChannelPipelineListener>`	`getPipelineCustomizers()`
`NettyHttpServerConfiguration.Worker`	`getWorker()`
`boolean`	`isChunkedSupported()` Whether chunked requests are supported.
`boolean`	`isUseNativeTransport()` Whether to use netty's native transport (epoll or kqueue) if available.
`boolean`	`isValidateHeaders()` Whether to validate headers.
`void`	`setAccessLogger(NettyHttpServerConfiguration.AccessLogger accessLogger)` Sets the AccessLogger configuration.
`void`	`setChildOptions(java.util.Map<io.netty.channel.ChannelOption,java.lang.Object> childOptions)` Sets the Netty child worker options.
`void`	`setChunkedSupported(boolean chunkedSupported)` Sets whether chunked transfer encoding is supported.
`void`	`setCompressionLevel(int compressionLevel)` Sets the compression level (0-9).
`void`	`setCompressionThreshold(int compressionThreshold)` Sets the minimum size of a request body must be in order to be compressed.
`void`	`setFallbackProtocol(java.lang.String fallbackProtocol)` Sets the fallback protocol to use when negotiating via ALPN.
`void`	`setHttp2(NettyHttpServerConfiguration.Http2Settings http2)` Sets the Http2Settings.
`void`	`setInitialBufferSize(int initialBufferSize)` Sets the initial buffer size.
`void`	`setLogLevel(io.netty.handler.logging.LogLevel logLevel)` Sets the Netty log level.
`void`	`setMaxChunkSize(int maxChunkSize)` Sets the maximum size of any single request chunk.
`void`	`setMaxHeaderSize(int maxHeaderSize)` Sets the maximum size of any one header.
`void`	`setMaxInitialLineLength(int maxInitialLineLength)` Sets the maximum initial line length for the HTTP request.
`void`	`setOptions(java.util.Map<io.netty.channel.ChannelOption,java.lang.Object> options)` Sets the channel options.
`void`	`setParent(NettyHttpServerConfiguration.Parent parent)` Sets the parent event loop configuration.
`void`	`setUseNativeTransport(boolean useNativeTransport)` Sets whether to use netty's native transport (epoll or kqueue) if available .
`void`	`setValidateHeaders(boolean validateHeaders)` Sets whether to validate incoming headers.
`void`	`setWorker(NettyHttpServerConfiguration.Worker worker)` Sets the worker event loop configuration.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_USE_NATIVE_TRANSPORT
```
public static final boolean DEFAULT_USE_NATIVE_TRANSPORT
```
    The default use netty's native transport flag.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAXINITIALLINELENGTH
```
public static final int DEFAULT_MAXINITIALLINELENGTH
```
    The default max initial line length.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAXHEADERSIZE
```
public static final int DEFAULT_MAXHEADERSIZE
```
    The default max header size.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAXCHUNKSIZE
```
public static final int DEFAULT_MAXCHUNKSIZE
```
    The default max chunk size.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CHUNKSUPPORTED
```
public static final boolean DEFAULT_CHUNKSUPPORTED
```
    The default chunk supported value.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_VALIDATEHEADERS
```
public static final boolean DEFAULT_VALIDATEHEADERS
```
    The default validate headers value.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_INITIALBUFFERSIZE
```
public static final int DEFAULT_INITIALBUFFERSIZE
```
    The default initial buffer size value.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_COMPRESSIONTHRESHOLD
```
public static final int DEFAULT_COMPRESSIONTHRESHOLD
```
    The default compression threshold.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_COMPRESSIONLEVEL
```
public static final int DEFAULT_COMPRESSIONLEVEL
```
    The default compression level.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - NettyHttpServerConfiguration
```
public NettyHttpServerConfiguration()
```
    Default empty constructor.
  - NettyHttpServerConfiguration
```
public NettyHttpServerConfiguration(ApplicationConfiguration applicationConfiguration)
```
    Parameters:
    
    applicationConfiguration - The application configuration
  - NettyHttpServerConfiguration
```
@Inject
public NettyHttpServerConfiguration(ApplicationConfiguration applicationConfiguration,
                                            java.util.List<ChannelPipelineListener> pipelineCustomizers)
```
    Parameters:
    
    applicationConfiguration - The application configuration
    
    pipelineCustomizers - A list of pipeline customizers
- Method Detail
  - getAccessLogger
```
public NettyHttpServerConfiguration.AccessLogger getAccessLogger()
```
    Returns the AccessLogger configuration.
    
    Returns:
    
    The AccessLogger configuration.
  - setAccessLogger
```
public void setAccessLogger(NettyHttpServerConfiguration.AccessLogger accessLogger)
```
    Sets the AccessLogger configuration.
    
    Parameters:
    
    accessLogger - The configuration .
  - getHttp2
```
public NettyHttpServerConfiguration.Http2Settings getHttp2()
```
    Returns the Http2Settings.
    
    Returns:
    
    The Http2Settings.
  - setHttp2
```
public void setHttp2(NettyHttpServerConfiguration.Http2Settings http2)
```
    Sets the Http2Settings.
    
    Parameters:
    
    http2 - The Http2Settings.
  - getPipelineCustomizers
```
public java.util.List<ChannelPipelineListener> getPipelineCustomizers()
```
    Returns:
    
    The pipeline customizers
  - getFallbackProtocol
```
public java.lang.String getFallbackProtocol()
```
    Returns:
    
    The fallback protocol to use when negotiating via ALPN
    
    See Also:
    
    ApplicationProtocolNames
  - setFallbackProtocol
```
public void setFallbackProtocol(java.lang.String fallbackProtocol)
```
    Sets the fallback protocol to use when negotiating via ALPN.
    
    Parameters:
    
    fallbackProtocol - The fallback protocol to use when negotiating via ALPN
    
    See Also:
    
    ApplicationProtocolNames
  - getLogLevel
```
public java.util.Optional<io.netty.handler.logging.LogLevel> getLogLevel()
```
    The server LogLevel to enable.
    
    Returns:
    
    The server LogLevel to enable
  - getMaxInitialLineLength
```
public int getMaxInitialLineLength()
```
    The maximum length of the initial HTTP request line. Defaults to 4096.
    
    Returns:
    
    The maximum length of the initial HTTP request line
  - getMaxHeaderSize
```
public int getMaxHeaderSize()
```
    The maximum size of an individual HTTP setter. Defaults to 8192.
    
    Returns:
    
    The maximum size of an individual HTTP setter
  - getMaxChunkSize
```
public int getMaxChunkSize()
```
    The maximum chunk size. Defaults to 8192.
    
    Returns:
    
    The maximum chunk size
  - isChunkedSupported
```
public boolean isChunkedSupported()
```
    Whether chunked requests are supported.
    
    Returns:
    
    Whether chunked requests are supported.
  - isUseNativeTransport
```
public boolean isUseNativeTransport()
```
    Whether to use netty's native transport (epoll or kqueue) if available.
    
    Returns:
    
    To use netty's native transport (epoll or kqueue) if available.
  - isValidateHeaders
```
public boolean isValidateHeaders()
```
    Whether to validate headers.
    
    Returns:
    
    Whether to validate headers
  - getInitialBufferSize
```
public int getInitialBufferSize()
```
    The initial buffer size. Defaults to 128.
    
    Returns:
    
    The initial buffer size.
  - getCompressionThreshold
```
public int getCompressionThreshold()
```
    The default compression threshold. Defaults to 1024.
    
    Returns:
    
    The compression threshold.
  - getCompressionLevel
```
public int getCompressionLevel()
```
    The default compression level. Default value (6).
    
    Returns:
    
    The compression level.
  - getChildOptions
```
public java.util.Map<io.netty.channel.ChannelOption,java.lang.Object> getChildOptions()
```
    Returns:
    
    The Netty child channel options.
    
    See Also:
    
    ServerBootstrap.childOptions()
  - getOptions
```
public java.util.Map<io.netty.channel.ChannelOption,java.lang.Object> getOptions()
```
    Returns:
    
    The Netty channel options.
    
    See Also:
    
    AbstractBootstrap.options()
  - getWorker
```
public NettyHttpServerConfiguration.Worker getWorker()
```
    Returns:
    
    Configuration for the worker EventLoopGroup
  - getParent
```
public NettyHttpServerConfiguration.Parent getParent()
```
    Returns:
    
    Configuration for the parent EventLoopGroup
  - setChildOptions
```
public void setChildOptions(java.util.Map<io.netty.channel.ChannelOption,java.lang.Object> childOptions)
```
    Sets the Netty child worker options.
    
    Parameters:
    
    childOptions - The options
  - setOptions
```
public void setOptions(java.util.Map<io.netty.channel.ChannelOption,java.lang.Object> options)
```
    Sets the channel options.
    
    Parameters:
    
    options - The channel options
  - setWorker
```
public void setWorker(NettyHttpServerConfiguration.Worker worker)
```
    Sets the worker event loop configuration.
    
    Parameters:
    
    worker - The worker config
  - setParent
```
public void setParent(NettyHttpServerConfiguration.Parent parent)
```
    Sets the parent event loop configuration.
    
    Parameters:
    
    parent - The parent config
  - setMaxInitialLineLength
```
public void setMaxInitialLineLength(@ReadableBytes
                                    int maxInitialLineLength)
```
    Sets the maximum initial line length for the HTTP request. Default value (4096).
    
    Parameters:
    
    maxInitialLineLength - The max length
  - setMaxHeaderSize
```
public void setMaxHeaderSize(@ReadableBytes
                             int maxHeaderSize)
```
    Sets the maximum size of any one header. Default value (8192).
    
    Parameters:
    
    maxHeaderSize - The max header size
  - setMaxChunkSize
```
public void setMaxChunkSize(@ReadableBytes
                            int maxChunkSize)
```
    Sets the maximum size of any single request chunk. Default value (8192).
    
    Parameters:
    
    maxChunkSize - The max chunk size
  - setChunkedSupported
```
public void setChunkedSupported(boolean chunkedSupported)
```
    Sets whether chunked transfer encoding is supported. Default value (true).
    
    Parameters:
    
    chunkedSupported - True if it is supported
  - setUseNativeTransport
```
public void setUseNativeTransport(boolean useNativeTransport)
```
    Sets whether to use netty's native transport (epoll or kqueue) if available . Default value (false).
    
    Parameters:
    
    useNativeTransport - True if netty's native transport should be use if available.
  - setValidateHeaders
```
public void setValidateHeaders(boolean validateHeaders)
```
    Sets whether to validate incoming headers. Default value (true).
    
    Parameters:
    
    validateHeaders - True if headers should be validated.
  - setInitialBufferSize
```
public void setInitialBufferSize(int initialBufferSize)
```
    Sets the initial buffer size. Default value (128).
    
    Parameters:
    
    initialBufferSize - The initial buffer size
  - setLogLevel
```
public void setLogLevel(io.netty.handler.logging.LogLevel logLevel)
```
    Sets the Netty log level.
    
    Parameters:
    
    logLevel - The log level
  - setCompressionThreshold
```
public void setCompressionThreshold(@ReadableBytes
                                    int compressionThreshold)
```
    Sets the minimum size of a request body must be in order to be compressed. Default value (1024).
    
    Parameters:
    
    compressionThreshold - The size request bodies must be in order to be a candidate for compression.
  - setCompressionLevel
```
public void setCompressionLevel(@ReadableBytes
                                int compressionLevel)
```
    Sets the compression level (0-9). Default value (6).
    
    Parameters:
    
    compressionLevel - The compression level.

Class NettyHttpServerConfiguration

Nested Class Summary

Nested classes/interfaces inherited from class io.micronaut.http.server.HttpServerConfiguration

Field Summary

Fields inherited from class io.micronaut.http.server.HttpServerConfiguration

Constructor Summary

Method Summary

Methods inherited from class io.micronaut.http.server.HttpServerConfiguration

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_USE_NATIVE_TRANSPORT

DEFAULT_MAXINITIALLINELENGTH

DEFAULT_MAXHEADERSIZE

DEFAULT_MAXCHUNKSIZE

DEFAULT_CHUNKSUPPORTED

DEFAULT_VALIDATEHEADERS

DEFAULT_INITIALBUFFERSIZE

DEFAULT_COMPRESSIONTHRESHOLD

DEFAULT_COMPRESSIONLEVEL

Constructor Detail

NettyHttpServerConfiguration

NettyHttpServerConfiguration

NettyHttpServerConfiguration

Method Detail

getAccessLogger

setAccessLogger

getHttp2

setHttp2

getPipelineCustomizers

getFallbackProtocol

setFallbackProtocol

getLogLevel

getMaxInitialLineLength

getMaxHeaderSize

getMaxChunkSize

isChunkedSupported

isUseNativeTransport

isValidateHeaders

getInitialBufferSize

getCompressionThreshold

getCompressionLevel

getChildOptions

getOptions

getWorker

getParent

setChildOptions

setOptions

setWorker

setParent

setMaxInitialLineLength

setMaxHeaderSize

setMaxChunkSize

setChunkedSupported

setUseNativeTransport

setValidateHeaders

setInitialBufferSize

setLogLevel

setCompressionThreshold

setCompressionLevel