Package io.quarkus.undertow.deployment

Interface ServletConfig

@ConfigMapping(prefix="quarkus.servlet") @ConfigRoot(phase=BUILD_TIME) public interface ServletConfig

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    ServletConfig.ContextPathConverter
    This converter adds a '/' at the beginning of the context path but does not add one at the end, given we want to support binding to a context without an ending '/'.

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<@WithConverter(ContextPathConverter.class) String>
    contextPath()
    The context path for Servlet content.
    String
    defaultCharset()
    The default charset to use for reading and writing requests

  • Method Details

    • contextPath

      Optional<@WithConverter(ContextPathConverter.class) String> contextPath()
      The context path for Servlet content. This will determine the path used to resolve all Servlet-based resources, including JAX-RS resources - when using the Undertow extension in conjunction with RESTEasy.

      This path is specified with a leading /, but is resolved relative to quarkus.http.root-path.

      • If quarkus.http.root-path=/ and quarkus.servlet.context-path=/bar, the servlet path will be /bar
      • If quarkus.http.root-path=/foo and quarkus.servlet.context-path=/bar, the servlet path will be /foo/bar

    • defaultCharset

      @WithDefault("UTF-8") String defaultCharset()
      The default charset to use for reading and writing requests