HttpServerConfiguration (micronaut 3.4.0 API)

java.lang.Object
- io.micronaut.http.server.HttpServerConfiguration

All Implemented Interfaces:: ServerContextPathProvider

Direct Known Subclasses:: NettyHttpServerConfiguration

@ConfigurationProperties(value="micronaut.server",
                         cliPrefix="")
public class HttpServerConfiguration
extends Object
implements ServerContextPathProvider

A base ConfigurationProperties for servers.

Since:: 1.0
Author:: Graeme Rocher

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`HttpServerConfiguration.CorsConfiguration` Configuration for CORS.
`static class`	`HttpServerConfiguration.HostResolutionConfiguration` Configuration for host resolution with the `HttpHostResolver`.
`static class`	`HttpServerConfiguration.HttpLocaleResolutionConfigurationProperties` Configuration for locale resolution used by `HttpLocaleResolver`.
`static class`	`HttpServerConfiguration.MultipartConfiguration` Configuration for multipart handling.

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_DATEHEADER` The default date header.
`static boolean`	`DEFAULT_DUAL_PROTOCOL` The default value for enabling dual protocol (http/https).
`static boolean`	`DEFAULT_HTTP_TO_HTTPS_REDIRECT` The default value for redirect HTTP to HTTPS when using dual protocal.
`static long`	`DEFAULT_IDLE_TIME_MINUTES` The default idle time.
`static boolean`	`DEFAULT_LOG_HANDLED_EXCEPTIONS` The default value for log handled exceptions.
`static long`	`DEFAULT_MAX_REQUEST_SIZE` The default max request size.
`static int`	`DEFAULT_PORT` The default port value.
`static int`	`DEFAULT_RANDOM_PORT` The default value random port.
`static long`	`DEFAULT_READ_IDLE_TIME_MINUTES` The default read idle time in minutes.
`static long`	`DEFAULT_WRITE_IDLE_TIME_MINUTES` The default write idle time in minutes.
`static String`	`PREFIX` The prefix used for configuration.

Constructor Summary

Constructors
Constructor and Description

HttpServerConfiguration()
Default constructor.

HttpServerConfiguration(ApplicationConfiguration applicationConfiguration)

Constructors
Constructor and Description
`HttpServerConfiguration()` Default constructor.
`HttpServerConfiguration(ApplicationConfiguration applicationConfiguration)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ApplicationConfiguration`	`getApplicationConfiguration()`
`String`	`getClientAddressHeader()`
`String`	`getContextPath()`
`HttpServerConfiguration.CorsConfiguration`	`getCors()`
`Charset`	`getDefaultCharset()`
`Optional<String>`	`getHost()`
`HttpServerConfiguration.HostResolutionConfiguration`	`getHostResolution()`
`HttpVersion`	`getHttpVersion()` The HTTP version to use.
`Duration`	`getIdleTimeout()`
`HttpLocaleResolutionConfiguration`	`getLocaleResolution()`
`long`	`getMaxRequestSize()`
`HttpServerConfiguration.MultipartConfiguration`	`getMultipart()`
`Optional<Integer>`	`getPort()`
`Duration`	`getReadIdleTimeout()`
`Optional<Integer>`	`getReadTimeout()`
`Optional<String>`	`getServerHeader()`
`ThreadSelection`	`getThreadSelection()`
`Duration`	`getWriteIdleTimeout()`
`boolean`	`isDateHeader()`
`boolean`	`isDualProtocol()`
`boolean`	`isHttpToHttpsRedirect()`
`boolean`	`isLogHandledExceptions()`
`void`	`setClientAddressHeader(String clientAddressHeader)`
`void`	`setContextPath(String contextPath)` Sets the context path for the web server.
`void`	`setCors(HttpServerConfiguration.CorsConfiguration cors)` Sets the cors configuration.
`void`	`setDateHeader(boolean dateHeader)` Sets whether a date header should be sent back.
`void`	`setDefaultCharset(Charset defaultCharset)`
`void`	`setDualProtocol(boolean dualProtocol)`
`void`	`setHost(String host)` Sets the host to bind to.
`void`	`setHostResolution(HttpServerConfiguration.HostResolutionConfiguration hostResolution)`
`void`	`setHttpToHttpsRedirect(boolean httpToHttpsRedirect)`
`void`	`setHttpVersion(HttpVersion httpVersion)` Sets the HTTP version to use.
`void`	`setIdleTimeout(Duration idleTimeout)` Sets the idle time of connections for the server.
`void`	`setLocaleResolution(HttpServerConfiguration.HttpLocaleResolutionConfigurationProperties localeResolution)`
`void`	`setLogHandledExceptions(boolean logHandledExceptions)` Sets whether exceptions handled by either an error route or exception handler should still be logged.
`void`	`setMaxRequestSize(long maxRequestSize)` Sets the maximum request size.
`void`	`setMultipart(HttpServerConfiguration.MultipartConfiguration multipart)` Sets the multipart configuration.
`void`	`setPort(int port)` Sets the port to bind to.
`void`	`setReadIdleTimeout(Duration readIdleTimeout)` Sets the amount of time a connection can remain idle without any reads occurring.
`void`	`setReadTimeout(Integer readTimeout)` Sets the default read timeout.
`void`	`setServerHeader(String serverHeader)` Sets the name of the server header.
`void`	`setThreadSelection(ThreadSelection threadSelection)` Sets the `ThreadSelection` model to use for the server.
`void`	`setWriteIdleTimeout(Duration writeIdleTimeout)` Sets the amount of time a connection can remain idle without any writes occurring.

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

- Field Detail
  - DEFAULT_PORT
```
public static final int DEFAULT_PORT
```
    The default port value.
    
    See Also:
    
    Constant Field Values
  - PREFIX
```
public static final String PREFIX
```
    The prefix used for configuration.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RANDOM_PORT
```
public static final int DEFAULT_RANDOM_PORT
```
    The default value random port.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_REQUEST_SIZE
```
public static final long DEFAULT_MAX_REQUEST_SIZE
```
    The default max request size.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_READ_IDLE_TIME_MINUTES
```
public static final long DEFAULT_READ_IDLE_TIME_MINUTES
```
    The default read idle time in minutes.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_WRITE_IDLE_TIME_MINUTES
```
public static final long DEFAULT_WRITE_IDLE_TIME_MINUTES
```
    The default write idle time in minutes.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DATEHEADER
```
public static final boolean DEFAULT_DATEHEADER
```
    The default date header.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_IDLE_TIME_MINUTES
```
public static final long DEFAULT_IDLE_TIME_MINUTES
```
    The default idle time.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LOG_HANDLED_EXCEPTIONS
```
public static final boolean DEFAULT_LOG_HANDLED_EXCEPTIONS
```
    The default value for log handled exceptions.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DUAL_PROTOCOL
```
public static final boolean DEFAULT_DUAL_PROTOCOL
```
    The default value for enabling dual protocol (http/https).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_HTTP_TO_HTTPS_REDIRECT
```
public static final boolean DEFAULT_HTTP_TO_HTTPS_REDIRECT
```
    The default value for redirect HTTP to HTTPS when using dual protocal.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HttpServerConfiguration
```
public HttpServerConfiguration()
```
    Default constructor.
  - HttpServerConfiguration
```
@Inject
public HttpServerConfiguration(ApplicationConfiguration applicationConfiguration)
```
    Parameters:
    
    applicationConfiguration - The application configuration
- Method Detail
  - getHttpVersion
```
public HttpVersion getHttpVersion()
```
    The HTTP version to use. Defaults to HttpVersion.HTTP_1_1.
    
    Returns:
    
    The http version
  - setHttpVersion
```
public void setHttpVersion(HttpVersion httpVersion)
```
    Sets the HTTP version to use. Defaults to HttpVersion.HTTP_1_1.
    
    Parameters:
    
    httpVersion - The http version
  - getThreadSelection
```
@NonNull
public ThreadSelection getThreadSelection()
```
    Returns:
    
    The ThreadSelection model to use for the server.
  - setThreadSelection
```
public void setThreadSelection(ThreadSelection threadSelection)
```
    Sets the ThreadSelection model to use for the server.
    
    Parameters:
    
    threadSelection - The thread selection model
  - getApplicationConfiguration
```
public ApplicationConfiguration getApplicationConfiguration()
```
    Returns:
    
    The application configuration instance
  - getDefaultCharset
```
public Charset getDefaultCharset()
```
    Returns:
    
    The default charset to use
  - getPort
```
public Optional<Integer> getPort()
```
    Returns:
    
    The default server port
  - getHost
```
public Optional<String> getHost()
```
    Returns:
    
    The default host
  - getReadTimeout
```
public Optional<Integer> getReadTimeout()
```
    Returns:
    
    The read timeout setting for the server
  - getMultipart
```
public HttpServerConfiguration.MultipartConfiguration getMultipart()
```
    Returns:
    
    Configuration for multipart / file uploads
  - getCors
```
public HttpServerConfiguration.CorsConfiguration getCors()
```
    Returns:
    
    Configuration for CORS
  - getMaxRequestSize
```
public long getMaxRequestSize()
```
    Returns:
    
    The maximum request body size
  - getReadIdleTimeout
```
public Duration getReadIdleTimeout()
```
    Returns:
    
    The default amount of time to allow read operation connections to remain idle
  - getWriteIdleTimeout
```
public Duration getWriteIdleTimeout()
```
    Returns:
    
    The default amount of time to allow write operation connections to remain idle
  - getIdleTimeout
```
public Duration getIdleTimeout()
```
    Returns:
    
    The time to allow an idle connection for
  - getServerHeader
```
public Optional<String> getServerHeader()
```
    Returns:
    
    The optional server header value
  - isDateHeader
```
public boolean isDateHeader()
```
    Returns:
    
    True if the date header should be set
  - isLogHandledExceptions
```
public boolean isLogHandledExceptions()
```
    Returns:
    
    True if exceptions handled by either an error route or exception handler should be logged
  - getHostResolution
```
@Nullable
public HttpServerConfiguration.HostResolutionConfiguration getHostResolution()
```
    Returns:
    
    The host resolution configuration
  - getLocaleResolution
```
@Nullable
public HttpLocaleResolutionConfiguration getLocaleResolution()
```
    Returns:
    
    The host resolution configuration
  - getClientAddressHeader
```
public String getClientAddressHeader()
```
    Returns:
    
    Which header stores the original client
  - getContextPath
```
public String getContextPath()
```
    Specified by:
    
    getContextPath in interface ServerContextPathProvider
    
    Returns:
    
    the context path for the web server
  - isDualProtocol
```
public boolean isDualProtocol()
```
    Returns:
    
    if dual protocol has been enabled or not
  - isHttpToHttpsRedirect
```
public boolean isHttpToHttpsRedirect()
```
    Returns:
    
    if redirection from HTTP to HTTPS is enabled or not
  - setDefaultCharset
```
public void setDefaultCharset(Charset defaultCharset)
```
    Parameters:
    
    defaultCharset - The default charset to use
  - setPort
```
public void setPort(int port)
```
    Sets the port to bind to. Default value (-1)
    
    Parameters:
    
    port - The port
  - setHost
```
public void setHost(String host)
```
    Sets the host to bind to.
    
    Parameters:
    
    host - The host
  - setReadTimeout
```
public void setReadTimeout(Integer readTimeout)
```
    Sets the default read timeout.
    
    Parameters:
    
    readTimeout - The read timeout
  - setServerHeader
```
public void setServerHeader(String serverHeader)
```
    Sets the name of the server header.
    
    Parameters:
    
    serverHeader - The server header
  - setMaxRequestSize
```
public void setMaxRequestSize(@ReadableBytes
                              long maxRequestSize)
```
    Sets the maximum request size. Default value (10485760L => // 10MB)
    
    Parameters:
    
    maxRequestSize - The max request size
  - setReadIdleTimeout
```
public void setReadIdleTimeout(Duration readIdleTimeout)
```
    Sets the amount of time a connection can remain idle without any reads occurring. Default value (5L minutes).
    
    Parameters:
    
    readIdleTimeout - The read idle time
  - setWriteIdleTimeout
```
public void setWriteIdleTimeout(Duration writeIdleTimeout)
```
    Sets the amount of time a connection can remain idle without any writes occurring. Default value (5L minutes).
    
    Parameters:
    
    writeIdleTimeout - The write idle time
  - setIdleTimeout
```
public void setIdleTimeout(Duration idleTimeout)
```
    Sets the idle time of connections for the server. Default value (5L minutes).
    
    Parameters:
    
    idleTimeout - The idle time
  - setMultipart
```
public void setMultipart(HttpServerConfiguration.MultipartConfiguration multipart)
```
    Sets the multipart configuration.
    
    Parameters:
    
    multipart - The multipart configuration
  - setCors
```
public void setCors(HttpServerConfiguration.CorsConfiguration cors)
```
    Sets the cors configuration.
    
    Parameters:
    
    cors - The cors configuration
  - setDateHeader
```
public void setDateHeader(boolean dateHeader)
```
    Sets whether a date header should be sent back. Default value (true).
    
    Parameters:
    
    dateHeader - True if a date header should be sent.
  - setLogHandledExceptions
```
public void setLogHandledExceptions(boolean logHandledExceptions)
```
    Sets whether exceptions handled by either an error route or exception handler should still be logged. Default value ().
    
    Parameters:
    
    logHandledExceptions - True if exceptions should be logged
  - setHostResolution
```
public void setHostResolution(HttpServerConfiguration.HostResolutionConfiguration hostResolution)
```
    Parameters:
    
    hostResolution - The host resolution configuration
  - setLocaleResolution
```
public void setLocaleResolution(HttpServerConfiguration.HttpLocaleResolutionConfigurationProperties localeResolution)
```
    Parameters:
    
    localeResolution - The locale resolution configuration
  - setClientAddressHeader
```
public void setClientAddressHeader(String clientAddressHeader)
```
    Parameters:
    
    clientAddressHeader - The header that stores the original client address
  - setContextPath
```
public void setContextPath(String contextPath)
```
    Sets the context path for the web server.
    
    Parameters:
    
    contextPath - the context path for the web server
  - setDualProtocol
```
public void setDualProtocol(boolean dualProtocol)
```
    Parameters:
    
    dualProtocol - the dual protocol (http/https) configuration. Default value (false).
  - setHttpToHttpsRedirect
```
public void setHttpToHttpsRedirect(boolean httpToHttpsRedirect)
```
    Parameters:
    
    httpToHttpsRedirect - Set to true to enable redirecting all http requests to the same URL but with https instead. This should only be used when dualProtocol is enabled. Default value (false). This feature uses the host resolution capabilities to determine the host to redirect to.

Class HttpServerConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_PORT

PREFIX

DEFAULT_RANDOM_PORT

DEFAULT_MAX_REQUEST_SIZE

DEFAULT_READ_IDLE_TIME_MINUTES

DEFAULT_WRITE_IDLE_TIME_MINUTES

DEFAULT_DATEHEADER

DEFAULT_IDLE_TIME_MINUTES

DEFAULT_LOG_HANDLED_EXCEPTIONS

DEFAULT_DUAL_PROTOCOL

DEFAULT_HTTP_TO_HTTPS_REDIRECT

Constructor Detail

HttpServerConfiguration

HttpServerConfiguration

Method Detail

getHttpVersion

setHttpVersion

getThreadSelection

setThreadSelection

getApplicationConfiguration

getDefaultCharset

getPort

getHost

getReadTimeout

getMultipart

getCors

getMaxRequestSize

getReadIdleTimeout

getWriteIdleTimeout

getIdleTimeout

getServerHeader

isDateHeader

isLogHandledExceptions

getHostResolution

getLocaleResolution

getClientAddressHeader

getContextPath

isDualProtocol

isHttpToHttpsRedirect

setDefaultCharset

setPort

setHost

setReadTimeout

setServerHeader

setMaxRequestSize

setReadIdleTimeout

setWriteIdleTimeout

setIdleTimeout

setMultipart

setCors

setDateHeader

setLogHandledExceptions

setHostResolution

setLocaleResolution

setClientAddressHeader

setContextPath

setDualProtocol

setHttpToHttpsRedirect