Interface ConfigurableTomcatWebServerFactory

All Superinterfaces:
ConfigurableWebServerFactory, ErrorPageRegistry, WebServerFactory
All Known Implementing Classes:
TomcatReactiveWebServerFactory, TomcatServletWebServerFactory, TomcatWebServerFactory
public interface ConfigurableTomcatWebServerFactory extends ConfigurableWebServerFactory
ConfigurableWebServerFactory for Tomcat-specific features.
Since:
4.0.0
Author:
Brian Clozel
See Also:

  • Method Details

    • setBaseDirectory

      void setBaseDirectory(@Nullable File baseDirectory)
      Set the Tomcat base directory. If not specified a temporary directory will be used.
      Parameters:
      baseDirectory - the tomcat base directory

    • setBackgroundProcessorDelay

      void setBackgroundProcessorDelay(int delay)
      Sets the background processor delay in seconds.
      Parameters:
      delay - the delay in seconds

    • addEngineValves

      void addEngineValves(Valve... engineValves)
      Add Valves that should be applied to the Tomcat Engine.
      Parameters:
      engineValves - the valves to add

    • addConnectorCustomizers

      void addConnectorCustomizers(TomcatConnectorCustomizer... tomcatConnectorCustomizers)
      Add TomcatConnectorCustomizers that should be added to the Tomcat Connector.
      Parameters:
      tomcatConnectorCustomizers - the customizers to add

    • addContextCustomizers

      void addContextCustomizers(TomcatContextCustomizer... tomcatContextCustomizers)
      Add TomcatContextCustomizers that should be added to the Tomcat Context.
      Parameters:
      tomcatContextCustomizers - the customizers to add

    • addProtocolHandlerCustomizers

      void addProtocolHandlerCustomizers(TomcatProtocolHandlerCustomizer<?>... tomcatProtocolHandlerCustomizers)
      Add TomcatProtocolHandlerCustomizers that should be added to the Tomcat Connector.
      Parameters:
      tomcatProtocolHandlerCustomizers - the customizers to add

    • setUriEncoding

      void setUriEncoding(Charset uriEncoding)
      Set the character encoding to use for URL decoding. If not specified 'UTF-8' will be used.
      Parameters:
      uriEncoding - the uri encoding to set

    • setUseApr

      void setUseApr(boolean useApr)
      Whether to use APR.
      Parameters:
      useApr - whether to use APR

    • setDisableMBeanRegistry

      void setDisableMBeanRegistry(boolean disableMBeanRegistry)
      Set whether the factory should disable Tomcat's MBean registry prior to creating the server.
      Parameters:
      disableMBeanRegistry - whether to disable the MBean registry