Module io.avaje.jex
Package io.avaje.jex

Interface JexConfig

public sealed interface JexConfig
Jex configuration interface.

Provides a fluent API for configuring Jex's various settings, including port, host, health endpoint, trailing slash handling, JSON service, template renderers, executor service, HTTPS configuration, compression, and plugin loading.

  • Method Details

    • host

      JexConfig host(String host)
      Set the host on which the HttpServer will bind to. Defaults to any local address.
      Parameters:
      host - The host.

    • port

      JexConfig port(int port)
      Sets the port number on which the HttpServer will listen for incoming requests.
      Parameters:
      port - The port number.

    • contextPath

      JexConfig contextPath(String contextPath)
      Set the contextPath.
      Parameters:
      contextPath - The context path which defaults to "/".

    • socketBacklog

      JexConfig socketBacklog(int backlog)
      Set the socket backlog. If this value is less than or equal to zero, then a system default value is used
      Parameters:
      backlog - the socket backlog. If this value is less than or equal to zero, then a system default value is used

    • health

      JexConfig health(boolean health)
      Enables/Disables the default health endpoint.
      Parameters:
      health - whether to enable/disable.

    • ignoreTrailingSlashes

      JexConfig ignoreTrailingSlashes(boolean ignoreTrailingSlashes)
      Configures whether trailing slashes in request URIs should be ignored.
      Parameters:
      ignoreTrailingSlashes - whether to enable/disable trailing slashes.

    • jsonService

      JexConfig jsonService(JsonService jsonService)
      Sets the JSON service used for (de)serialization.
      Parameters:
      jsonService - The json service instance.

    • renderer

      JexConfig renderer(String extension, TemplateRender renderer)
      Registers a template renderer for a specific file extension.
      Parameters:
      extension - The file extension.
      renderer - The template renderer implementation.

    • executor

      JexConfig executor(Executor executor)
      Sets the executor service used to handle incoming requests.
      Parameters:
      executor - The executor service.

    • httpsConfig

      JexConfig httpsConfig(HttpsConfigurator https)
      Enable https with the provided HttpsConfigurator
      Parameters:
      https - The HTTPS configuration.

    • compression

      JexConfig compression(Consumer<CompressionConfig> consumer)
      Configures compression settings using a consumer function.
      Parameters:
      consumer - The consumer function to configure compression settings.
      Returns:
      The updated configuration.

    • port

      int port()
      Returns the configured port number. (Defaults to 8080 if not set)

    • host

      String host()
      Returns the configured host. (Defaults to localhost if not set)

    • contextPath

      String contextPath()
      Return the contextPath. (Defaults to "/")

    • health

      boolean health()
      Returns whether the health endpoint is enabled.

    • ignoreTrailingSlashes

      boolean ignoreTrailingSlashes()
      Returns whether trailing slashes in request URIs are ignored.

    • jsonService

      JsonService jsonService()
      Returns the configured JSON service.

    • httpsConfig

      HttpsConfigurator httpsConfig()
      Return the HttpsConfigurator if https is enabled.

    • scheme

      String scheme()
      Return the schema as http or https.

    • compression

      CompressionConfig compression()
      Returns the configured compression settings.

    • renderers

      Map<String,TemplateRender> renderers()
      Returns a map of registered template renderers, keyed by file extension.

    • executor

      Executor executor()
      Executor for serving requests. Defaults to a
      invalid reference 
      Executors#newVirtualThreadPerTaskExecutor()

    • disableSpiPlugins

      JexConfig disableSpiPlugins()
      Disables auto-configuring the current instance with JexPlugin loaded using the ServiceLoader.

    • socketBacklog

      int socketBacklog()
      Return the socket backlog.

    • useSpiPlugins

      boolean useSpiPlugins()
      Return true if SPI plugins should be loaded and registered.