Class TomcatConfiguration

java.lang.Object
io.micronaut.http.server.HttpServerConfiguration
io.micronaut.servlet.tomcat.TomcatConfiguration
All Implemented Interfaces:
io.micronaut.core.util.Toggleable, io.micronaut.http.context.ServerContextPathProvider, io.micronaut.scheduling.executor.ThreadSelectionConfiguration
@ConfigurationProperties("tomcat") @Replaces(io.micronaut.http.server.HttpServerConfiguration.class) public class TomcatConfiguration extends io.micronaut.http.server.HttpServerConfiguration implements io.micronaut.core.util.Toggleable
Extends HttpServerConfiguration and allows configuring Tomcat.
Since:
1.0
Author:
graemerocher

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    TomcatConfiguration.AccessLogConfiguration
    The access log configuration.

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

    io.micronaut.http.server.HttpServerConfiguration.CorsConfiguration, io.micronaut.http.server.HttpServerConfiguration.FileTypeHandlerConfiguration, io.micronaut.http.server.HttpServerConfiguration.HostResolutionConfiguration, io.micronaut.http.server.HttpServerConfiguration.HttpLocaleResolutionConfigurationProperties, io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ENABLED_PROPERTY
     
    static final String
    PREFIX
     
    protected final org.apache.catalina.connector.Connector
    tomcatConnector
     

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

    DEFAULT_DATEHEADER, DEFAULT_DISPATCH_OPTIONS_REQUESTS, DEFAULT_DUAL_PROTOCOL, DEFAULT_HTTP_TO_HTTPS_REDIRECT, DEFAULT_IDLE_TIME_MINUTES, DEFAULT_LOG_HANDLED_EXCEPTIONS, DEFAULT_MAX_PARAMS, DEFAULT_MAX_REQUEST_BUFFER_SIZE, DEFAULT_MAX_REQUEST_SIZE, DEFAULT_PORT, DEFAULT_RANDOM_PORT, DEFAULT_READ_IDLE_TIME_MINUTES, DEFAULT_SEMICOLON_IS_NORMAL_CHAR, DEFAULT_WRITE_IDLE_TIME_MINUTES

  • Constructor Summary

    Constructors
    Constructor
    Description
    TomcatConfiguration(@Nullable io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration multipartConfiguration, @Nullable String protocol)
    Default constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<TomcatConfiguration.AccessLogConfiguration>
    getAccessLogConfiguration()
     
    Optional<io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration>
    getMultipartConfiguration()
     
    String
    getProtocol()
     
    org.apache.catalina.connector.Connector
    getTomcatConnector()
     
    boolean
    isEnabled()
     
    void
    setAccessLogConfiguration(@Nullable TomcatConfiguration.AccessLogConfiguration accessLogConfiguration)
    Sets the access log configuration.
    void
    setEnabled(boolean enabled)
    Sets whether the Tomcat runtime is enabled.
    void
    setProtocol(@Nullable String protocol)
     

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

    getApplicationConfiguration, getClientAddressHeader, getContextPath, getCors, getDefaultCharset, getHost, getHostResolution, getHttpVersion, getIdleTimeout, getLocaleResolution, getMaxParams, getMaxRequestBufferSize, getMaxRequestSize, getMultipart, getPort, getReadIdleTimeout, getReadTimeout, getServerHeader, getThreadSelection, getWriteIdleTimeout, isDateHeader, isDispatchOptionsRequests, isDualProtocol, isEscapeHtmlUrl, isHttpToHttpsRedirect, isLogHandledExceptions, isNotFoundOnMissingBody, isRedispatchNonBlockingOnly, isSemicolonIsNormalChar, isValidateUrl, setClientAddressHeader, setContextPath, setCors, setDateHeader, setDefaultCharset, setDispatchOptionsRequests, setDualProtocol, setEscapeHtmlUrl, setHost, setHostResolution, setHttpToHttpsRedirect, setHttpVersion, setIdleTimeout, setLocaleResolution, setLogHandledExceptions, setMaxParams, setMaxRequestBufferSize, setMaxRequestSize, setMultipart, setNotFoundOnMissingBody, setPort, setReadIdleTimeout, setReadTimeout, setRedispatchNonBlockingOnly, setSemicolonIsNormalChar, setServerHeader, setThreadSelection, setValidateUrl, setWriteIdleTimeout

    Methods inherited from class Object

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

  • Field Details

    • PREFIX

      public static final String PREFIX
      See Also:

    • ENABLED_PROPERTY

      public static final String ENABLED_PROPERTY
      See Also:

    • tomcatConnector

      @ConfigurationBuilder protected final org.apache.catalina.connector.Connector tomcatConnector

  • Constructor Details

    • TomcatConfiguration

      public TomcatConfiguration(@Nullable io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration multipartConfiguration, @Property(name="micronaut.server.tomcat.protocol") @Nullable String protocol)
      Default constructor.
      Parameters:
      multipartConfiguration - The multipart config
      protocol - The protocol to use

  • Method Details

    • getProtocol

      public String getProtocol()
      Returns:
      The protocol to use. Defaults to org.apache.coyote.http11.Http11NioProtocol.

    • setProtocol

      public void setProtocol(@Nullable String protocol)
      Parameters:
      protocol - The protocol to use. Defaults to org.apache.coyote.http11.Http11NioProtocol.

    • getTomcatConnector

      public org.apache.catalina.connector.Connector getTomcatConnector()
      Returns:
      The tomcat connector.

    • getMultipartConfiguration

      public Optional<io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration> getMultipartConfiguration()
      Returns:
      The multipart configuration

    • isEnabled

      public boolean isEnabled()
      Specified by:
      isEnabled in interface io.micronaut.core.util.Toggleable

    • setEnabled

      public void setEnabled(boolean enabled)
      Sets whether the Tomcat runtime is enabled.
      Parameters:
      enabled - True if the runtime is enabled

    • getAccessLogConfiguration

      public Optional<TomcatConfiguration.AccessLogConfiguration> getAccessLogConfiguration()
      Returns:
      The access log configuration.
      Since:
      4.8.0

    • setAccessLogConfiguration

      @Inject public void setAccessLogConfiguration(@Nullable TomcatConfiguration.AccessLogConfiguration accessLogConfiguration)
      Sets the access log configuration.
      Parameters:
      accessLogConfiguration - The access log configuration.
      Since:
      4.8.0