org.qi4j.library.http

## Interface JettyConfiguration

- All Superinterfaces:
    Composite, ConfigurationComposite, Identity
  All Known Subinterfaces:
    SecureJettyConfiguration

      public interface JettyConfiguration
      extends ConfigurationComposite

  Configuration of the JettyService. The only mandatory property is port. Other properties are provided with a sensible default respecting the original Jetty defaults.

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from interface org.qi4j.api.entity.Identity

      `Identity.IdentityMixin`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `Property<String>` | `contextPath()` url prefix of the `JettyService`.
    `Property<Integer>` | `gracefullShutdownTimeout()` Timeout use to wait for active requests to terminate on shutdown in milliseconds.
    `Property<String>` | `hostName()` Name or ip representing the interface on which the `JettyService` will bind the server socket.
    `Property<Integer>` | `lowResourceMaxIdleTime()`
    `Property<Integer>` | `maxFormContentSize()`
    `Property<Integer>` | `maxIdleTime()`
    `Property<Integer>` | `port()`
    `Property<Integer>` | `requestHeaderSize()`
    `Property<String>` | `resourcePath()`
    `Property<Integer>` | `responseBufferSize()` Size of the content buffer for sending responses in bytes.
    `Property<Integer>` | `responseHeaderSize()`
    `Property<Boolean>` | `sendDateHeader()`
    `Property<Boolean>` | `sendServerVersion()`
    `Property<Boolean>` | `statistics()` Defaults to false.
    `Property<String>` | `virtualHosts()` Virtual hosts for this JettyService.
    `Property<String>` | `welcomeFiles()` Welcome files names for this JettyService.

    - ### Methods inherited from interface org.qi4j.api.entity.Identity

      `identity`

- - ### Method Detail

    - #### port

          Property<Integer> port()

      Returns:
        Port on which the `JettyService` will listen for incomming requests.

    - #### hostName

          @Optional
          Property<String> hostName()

      Name or ip representing the interface on which the `JettyService` will bind the server socket. If not set the `JettyService` will be bound to all interfaces.
      Returns:
        Name or ip representing the interface on which the `JettyService` will bind the server socket.

    - #### statistics

          @UseDefaults
          Property<Boolean> statistics()

      Defaults to false.
      Returns:
        If the `JettyService` should collect statistics.

    - #### maxIdleTime

          @Optional
          Property<Integer> maxIdleTime()

      Returns:
        Maximum Idle time for connections in milliseconds.

    - #### lowResourceMaxIdleTime

          @Optional
          Property<Integer> lowResourceMaxIdleTime()

      Returns:
        Maximum Idle time for connections in milliseconds when resources are low.

    - #### requestHeaderSize

          @Optional
          Property<Integer> requestHeaderSize()

      Returns:
        The size of the buffer to be used for request headers in bytes.

    - #### responseHeaderSize

          @Optional
          Property<Integer> responseHeaderSize()

      Returns:
        The size of the buffer to be used for response headers in bytes.

    - #### responseBufferSize

          @Optional
          Property<Integer> responseBufferSize()

      Size of the content buffer for sending responses in bytes. These buffers are only used for active connections that are sending responses with bodies that will not fit within the header buffer.
      Returns:
        The size of the content buffer for sending responses in bytes.

    - #### contextPath

          @Optional
          Property<String> contextPath()

      url prefix of the `JettyService`. Defaulted to "/".
      Returns:
        The url prefix of the `JettyService`.

    - #### resourcePath

          @Optional
          Property<String> resourcePath()

    - #### virtualHosts

          @Optional
          Property<String> virtualHosts()

      Virtual hosts for this JettyService. Coma separated list of hostnames.
      Returns:
        Virtual hosts for this JettyService.

    - #### welcomeFiles

          @Optional
          Property<String> welcomeFiles()

      Welcome files names for this JettyService. Coma separated list of welcome files. Defaulted to index.html.
      Returns:
        Welcome files names for this JettyService.

    - #### maxFormContentSize

          @Optional
          Property<Integer> maxFormContentSize()

      Returns:
        Maximum Form content size.

    - #### sendDateHeader

          @Optional
          Property<Boolean> sendDateHeader()

      Returns:
        If `JettyService` populates http header with server date.

    - #### sendServerVersion

          @Optional
          Property<Boolean> sendServerVersion()

      Returns:
        If `JettyService` expose it's implementation version.

    - #### gracefullShutdownTimeout

          @Optional
          Property<Integer> gracefullShutdownTimeout()

      Timeout use to wait for active requests to terminate on shutdown in milliseconds. Jetty will stop gracefully only if this property is set.
      Returns:
        Timeout use to wait for active requests to terminate on shutdown in milliseconds.