Module io.helidon.webserver
Package io.helidon.webserver

Interface SocketConfiguration.SocketConfigurationBuilder<B extends SocketConfiguration.SocketConfigurationBuilder<B>>

Type Parameters:
B - type of the subclass of this class to provide correct fluent API
All Known Implementing Classes:
ServerConfiguration.Builder, SocketConfiguration.Builder, WebServer.Builder
Enclosing interface:
SocketConfiguration
public static interface SocketConfiguration.SocketConfigurationBuilder<B extends SocketConfiguration.SocketConfigurationBuilder<B>>
Socket configuration builder API, used by SocketConfiguration.Builder to configure additional sockets, and by WebServer.Builder to configure the default socket.

  • Method Summary

    Modifier and Type
    Method
    Description
    B
    backlog(int backlog)
    Configures a maximum length of the queue of incoming connections on the server socket.
    B
    backpressureBufferSize(long size)
    Maximum length of the response data sending buffer can keep without flushing.
    B
    backpressureStrategy(BackpressureStrategy backpressureStrategy)
    Sets a backpressure strategy for the server to apply against user provided response upstream.
    default B
    bindAddress(String address)
    Configures local address where the server listens on with the server socket.
    B
    bindAddress(InetAddress bindAddress)
    Configures local address where the server listens on with the server socket.
    default B
    config(Config config)
    Update this socket configuration from a Config.
    B
    enableCompression(boolean value)
    Enable negotiation for gzip/deflate content encodings.
    default B
    host(String address)
    A helper method that just calls bindAddress(String).
    B
    maxHeaderSize(int size)
    Maximal number of bytes of all header values combined.
    B
    maxInitialLineLength(int length)
    Maximal number of characters in the initial HTTP line.
    B
    maxPayloadSize(long size)
    Set a maximum payload size for a client request.
    B
    maxUpgradeContentLength(int size)
    Set a maximum length of the content of an upgrade request.
    B
    port(int port)
    Configures a server port to listen on with the server socket.
    B
    receiveBufferSize(int receiveBufferSize)
    Configures proposed value of the TCP receive window that is advertised to the remote peer on the server socket.
    B
    timeout(long amount, TimeUnit unit)
    Configures a server socket timeout.
    B
    tls(WebServerTls webServerTls)
    Configures SSL for this socket.
    default B
    tls(Supplier<WebServerTls> tlsConfig)
    Configures SSL for this socket.

  • Method Details

    • port

      B port(int port)
      Configures a server port to listen on with the server socket. If port is 0 then any available ephemeral port will be used.
      Parameters:
      port - the server port of the server socket
      Returns:
      this builder

    • bindAddress

      default B bindAddress(String address)
      Configures local address where the server listens on with the server socket. If not configured, then listens an all local addresses.
      Parameters:
      address - an address to bind with the server socket
      Returns:
      this builder
      Throws:
      NullPointerException - in case the bind address is null
      ConfigException - in case the address provided is not a valid host address

    • host

      default B host(String address)
      A helper method that just calls bindAddress(String).
      Parameters:
      address - host to listen on
      Returns:
      this builder

    • bindAddress

      B bindAddress(InetAddress bindAddress)
      Configures local address where the server listens on with the server socket. If not configured, then listens an all local addresses.
      Parameters:
      bindAddress - an address to bind with the server socket
      Returns:
      this builder
      Throws:
      NullPointerException - in case the bind address is null

    • backlog

      B backlog(int backlog)
      Configures a maximum length of the queue of incoming connections on the server socket.

      Default value is SocketConfiguration.DEFAULT_BACKLOG_SIZE.

      Parameters:
      backlog - a maximum length of the queue of incoming connections
      Returns:
      this builder

    • timeout

      B timeout(long amount, TimeUnit unit)
      Configures a server socket timeout.
      Parameters:
      amount - an amount of time to configure the timeout, use 0 for infinite timeout
      unit - time unit to use with the configured amount
      Returns:
      this builder

    • receiveBufferSize

      B receiveBufferSize(int receiveBufferSize)
      Configures proposed value of the TCP receive window that is advertised to the remote peer on the server socket.

      If 0 then use implementation default.

      Parameters:
      receiveBufferSize - a buffer size in bytes of the server socket or 0
      Returns:
      this builder

    • tls

      B tls(WebServerTls webServerTls)
      Configures SSL for this socket. When configured, the server enforces SSL configuration. If this method is called, any other method except for tls(java.util.function.Supplier)ยจ and repeated invocation of this method would be ignored.

      If this method is called again, the previous configuration would be ignored.

      Parameters:
      webServerTls - ssl configuration to use with this socket
      Returns:
      this builder

    • tls

      default B tls(Supplier<WebServerTls> tlsConfig)
      Configures SSL for this socket. When configured, the server enforces SSL configuration.
      Parameters:
      tlsConfig - supplier ssl configuration to use with this socket
      Returns:
      this builder

    • maxHeaderSize

      B maxHeaderSize(int size)
      Maximal number of bytes of all header values combined. When a bigger value is received, a Http.Status.BAD_REQUEST_400 is returned.

      Default is 16384

      Parameters:
      size - maximal number of bytes of combined header values
      Returns:
      this builder

    • maxInitialLineLength

      B maxInitialLineLength(int length)
      Maximal number of characters in the initial HTTP line.

      Default is 4096

      Parameters:
      length - maximal number of characters
      Returns:
      this builder

    • enableCompression

      B enableCompression(boolean value)
      Enable negotiation for gzip/deflate content encodings. Clients can request compression using the "Accept-Encoding" header.

      Default is false

      Parameters:
      value - compression flag
      Returns:
      this builder

    • maxPayloadSize

      B maxPayloadSize(long size)
      Set a maximum payload size for a client request. Can prevent DoS attacks.
      Parameters:
      size - maximum payload size
      Returns:
      this builder

    • backpressureBufferSize

      B backpressureBufferSize(long size)
      Maximum length of the response data sending buffer can keep without flushing. Depends on `backpressure-policy` what happens if max buffer size is reached.
      Parameters:
      size - maximum non-flushed data Netty can buffer until backpressure is applied
      Returns:
      this builder

    • backpressureStrategy

      B backpressureStrategy(BackpressureStrategy backpressureStrategy)
      Sets a backpressure strategy for the server to apply against user provided response upstream.
      • LINEAR - Data are requested one-by-one, in case buffer reaches watermark, no other data is requested.
      • AUTO_FLUSH - Data are requested one-by-one, in case buffer reaches watermark, no other data is requested.
      • PREFETCH - After first data chunk arrives, probable number of chunks needed to fill the buffer up to watermark is calculated and requested.
      • NONE - No backpressure is applied, Long.MAX_VALUE(unbounded) is requested from upstream.
      Parameters:
      backpressureStrategy - One of NONE, PREFETCH or LINEAR, default is LINEAR
      Returns:
      this builder

    • maxUpgradeContentLength

      B maxUpgradeContentLength(int size)
      Set a maximum length of the content of an upgrade request.

      Default is 64*1024

      Parameters:
      size - Maximum length of the content of an upgrade request
      Returns:
      this builder

    • config

      default B config(Config config)
      Update this socket configuration from a Config.
      Parameters:
      config - configuration on the node of a socket
      Returns:
      updated builder instance