Class JettyConfiguration

java.lang.Object
io.micronaut.http.server.HttpServerConfiguration
io.micronaut.servlet.jetty.JettyConfiguration
All Implemented Interfaces:
io.micronaut.core.util.Toggleable, io.micronaut.http.context.ServerContextPathProvider, io.micronaut.scheduling.executor.ThreadSelectionConfiguration
@ConfigurationProperties("jetty") @Replaces(io.micronaut.http.server.HttpServerConfiguration.class) public class JettyConfiguration extends io.micronaut.http.server.HttpServerConfiguration implements io.micronaut.core.util.Toggleable
Configuration properties for Jetty.
Since:
1.0.0
Author:
graemerocher

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    JettyConfiguration.ConnectorConfiguration
    Configuration for additional connectors.
    static final class 
    JettyConfiguration.JettyRequestLog
    Jetty access log configuration.
    static class 
    JettyConfiguration.JettySslConfiguration
    The default connection pool configuration.

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

    io.micronaut.http.server.HttpServerConfiguration.CorsConfiguration, io.micronaut.http.server.HttpServerConfiguration.ErrorResponseIncludeMessageMode, 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 boolean
    DEFAULT_NATIVE_STATIC_RESOURCES
    The default value for setNativeStaticResources(boolean).
    static final String
    ENABLED_PROPERTY
     
    protected org.eclipse.jetty.server.HttpConfiguration
    httpConfiguration
     
    static final String
    PREFIX
     

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

    DEFAULT_DATEHEADER, DEFAULT_DISPATCH_OPTIONS_REQUESTS, DEFAULT_DUAL_PROTOCOL, DEFAULT_ERROR_RESPONSE_INCLUDE_MESSAGE, 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
    JettyConfiguration(@Nullable io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration multipartConfiguration)
    Default constructor.
    JettyConfiguration(@Nullable io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration multipartConfiguration, @Nullable JettyConfiguration.JettyRequestLog requestLog)
    Default constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.eclipse.jetty.server.HttpConfiguration
    getHttpConfiguration()
     
    Map<String,String>
    getInitParameters()
     
    Optional<io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration>
    getMultipartConfiguration()
     
    Optional<JettyConfiguration.JettyRequestLog>
    getRequestLog()
     
    boolean
    isEnabled()
     
    boolean
    isNativeStaticResources()
    Whether static resources are served by Jetty's own ResourceHandler rather than by the Micronaut static resource resolver that the other runtimes use.
    void
    setEnabled(boolean enabled)
    Sets whether the Jetty runtime is enabled.
    void
    setInitParameters(Map<String,String> initParameters)
    Sets the servlet init parameters.
    void
    setNativeStaticResources(boolean nativeStaticResources)
    Serve static resources with Jetty's own ResourceHandler instead of the Micronaut static resource resolver.

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

    getApplicationConfiguration, getClientAddressHeader, getContextPath, getCors, getDefaultCharset, getErrorResponseIncludeMessage, 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, setErrorResponseIncludeMessage, 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

  • Constructor Details

    • JettyConfiguration

      public JettyConfiguration(@Nullable io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration multipartConfiguration)
      Default constructor.
      Parameters:
      multipartConfiguration - The multipart configuration.

    • JettyConfiguration

      @Inject public JettyConfiguration(@Nullable io.micronaut.http.server.HttpServerConfiguration.MultipartConfiguration multipartConfiguration, @Nullable JettyConfiguration.JettyRequestLog requestLog)
      Default constructor.
      Parameters:
      multipartConfiguration - The multipart configuration.
      requestLog - Request log configuration.

  • Method Details

    • getHttpConfiguration

      public org.eclipse.jetty.server.HttpConfiguration getHttpConfiguration()
      Returns:
      The HTTP configuration instance

    • getMultipartConfiguration

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

    • getRequestLog

      public Optional<JettyConfiguration.JettyRequestLog> getRequestLog()
      Returns:
      The request log configuration.

    • isEnabled

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

    • setEnabled

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

    • isNativeStaticResources

      public boolean isNativeStaticResources()
      Whether static resources are served by Jetty's own ResourceHandler rather than by the Micronaut static resource resolver that the other runtimes use.
      Returns:
      True if Jetty serves static resources itself
      Since:
      6.2.0

    • setNativeStaticResources

      public void setNativeStaticResources(boolean nativeStaticResources)
      Serve static resources with Jetty's own ResourceHandler instead of the Micronaut static resource resolver. Jetty's handler supports range requests and conditional caching natively, but sits outside the Micronaut filter chain, so Micronaut filters (including CORS) do not see those requests and the cache-control setting of each static resource configuration applies instead of micronaut.server.responses.file. Default value (false).
      Parameters:
      nativeStaticResources - True to let Jetty serve static resources
      Since:
      6.2.0

    • getInitParameters

      public Map<String,String> getInitParameters()
      Returns:
      The servlet init parameters

    • setInitParameters

      public void setInitParameters(@MapFormat(transformation=FLAT,keyFormat=RAW) Map<String,String> initParameters)
      Sets the servlet init parameters.
      Parameters:
      initParameters - The init parameters