Packages

sealed class JettyBuilder[F[_]] extends ServletContainer[F] with ServerBuilder[F]

Source
JettyBuilder.scala
Linear Supertypes
ServletContainer[F], ServerBuilder[F], BackendBuilder[F, Server], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JettyBuilder
  2. ServletContainer
  3. ServerBuilder
  4. BackendBuilder
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Self = JettyBuilder[F]
    Definition Classes
    JettyBuilder → ServletContainer → ServerBuilder

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. implicit val F: ConcurrentEffect[F]
    Attributes
    protected
    Definition Classes
    JettyBuilder → ServerBuilder → BackendBuilder
  5. def allocated: F[(Server, F[Unit])]

    Returns an effect that allocates a backend and an F[Unit] to release it.

    Returns an effect that allocates a backend and an F[Unit] to release it. The returned F waits until the backend is ready to process requests. The second element of the tuple shuts down the backend when run.

    Unlike resource and stream, there is no automatic release of the backend. This function is intended for REPL sessions, tests, and other situations where composing a cats.effect.Resource or fs2.Stream is not tenable. resource or stream is recommended wherever possible.

    Definition Classes
    BackendBuilder
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. final def bindAny(host: String = defaults.IPv4Host): Self
    Definition Classes
    ServerBuilder
  8. final def bindHttp(port: Int = defaults.HttpPort, host: String = defaults.IPv4Host): Self
    Definition Classes
    ServerBuilder
  9. final def bindLocal(port: Int): Self
    Definition Classes
    ServerBuilder
  10. def bindSocketAddress(socketAddress: InetSocketAddress): Self
    Definition Classes
    JettyBuilder → ServerBuilder
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def mountFilter(filter: Filter, urlMapping: String, name: Option[String], dispatches: EnumSet[DispatcherType]): Self

    Mounts a filter to the server.

    Mounts a filter to the server.

    The http4s way is to create a middleware around an HttpRoutes, which runs not just on servlet containers, but all supported backends. This method is good for legacy scenarios, or for reusing parts of the servlet ecosystem for an app that is committed to running on a servlet container.

    Definition Classes
    JettyBuilder → ServletContainer
  19. def mountHttpApp(service: HttpApp[F], prefix: String): Self
  20. def mountService(service: HttpRoutes[F], prefix: String): Self
  21. def mountServlet(servlet: HttpServlet, urlMapping: String, name: Option[String] = None): Self

    Mounts a servlet to the server.

    Mounts a servlet to the server.

    The http4s way is to create HttpRoutes, which runs not just on servlet containers, but all supported backends. This method is good for legacy scenarios, or for reusing parts of the servlet ecosystem for an app that is committed to running on a servlet container.

    Definition Classes
    JettyBuilder → ServletContainer
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. def resource: Resource[F, Server]

    Returns a Server resource.

    Returns a Server resource. The resource is not acquired until the server is started and ready to accept requests.

    Definition Classes
    JettyBuilder → ServerBuilder → BackendBuilder
  26. final def serve: Stream[F, ExitCode]

    Runs the server as a process that never emits.

    Runs the server as a process that never emits. Useful for a server that runs for the rest of the JVM's life.

    Definition Classes
    ServerBuilder
  27. final def serveWhile(terminateWhenTrue: Signal[F, Boolean], exitWith: Ref[F, ExitCode]): Stream[F, ExitCode]

    Runs the server as a Stream that emits only when the terminated signal becomes true.

    Runs the server as a Stream that emits only when the terminated signal becomes true. Useful for servers with associated lifetime behaviors.

    Definition Classes
    ServerBuilder
  28. def stream: Stream[F, Server]

    Returns the backend as a single-element stream.

    Returns the backend as a single-element stream. The stream does not emit until the backend is ready to process requests. The backend is shut down when the stream is finalized.

    Definition Classes
    BackendBuilder
  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  34. def withAsyncTimeout(asyncTimeout: Duration): Self
  35. def withBanner(banner: Seq[String]): Self

    Set the banner to display when the server starts up

    Set the banner to display when the server starts up

    Definition Classes
    JettyBuilder → ServerBuilder
  36. def withHttp2c: Self

    Enables HTTP/2 connection upgrade over plain text (no TLS).

    Enables HTTP/2 connection upgrade over plain text (no TLS). See https://webtide.com/introduction-to-http2-in-jetty

  37. def withIdleTimeout(idleTimeout: Duration): Self
  38. def withJettyHttpConfiguration(value: HttpConfiguration): Self

    Provide a specific org.eclipse.jetty.server.HttpConfiguration.

    Provide a specific org.eclipse.jetty.server.HttpConfiguration.

    This can be used for direct low level control over many HTTP related configuration settings which http4s may not directly expose.

  39. def withServiceErrorHandler(serviceErrorHandler: ServiceErrorHandler[F]): Self

    Sets the handler for errors thrown invoking the service.

    Sets the handler for errors thrown invoking the service. Is not guaranteed to be invoked on errors on the server backend, such as parsing a request or handling a context timeout.

    Definition Classes
    JettyBuilder → ServerBuilder
  40. def withServletIo(servletIo: ServletIo[F]): Self

    Sets the servlet I/O mode for reads and writes within the servlet.

    Sets the servlet I/O mode for reads and writes within the servlet. Not to be confused with the server connectors.

    Definition Classes
    JettyBuilder → ServletContainer
    See also

    org.http4s.servlet.ServletIo

  41. def withShutdownTimeout(shutdownTimeout: Duration): Self

    Sets the graceful shutdown timeout for Jetty.

    Sets the graceful shutdown timeout for Jetty. Closing the resource will wait this long before a forcible stop.

  42. def withSslContext(sslContext: SSLContext): Self

    Configures the server with TLS, using the provided SSLContext and its default SSLParameters

  43. def withSslContextAndParameters(sslContext: SSLContext, sslParameters: SSLParameters): Self

    Configures the server with TLS, using the provided SSLContext and its default SSLParameters

  44. def withThreadPoolResource(threadPoolResource: Resource[F, ThreadPool]): JettyBuilder[F]

    Set the org.eclipse.jetty.util.thread.ThreadPool that Jetty will use.

    Set the org.eclipse.jetty.util.thread.ThreadPool that Jetty will use.

    It is recommended you use JettyThreadPools#resource to build this so that it will be gracefully shutdown when/if the Jetty server is shutdown.

  45. final def withoutBanner: Self

    Disable the banner when the server starts up

    Disable the banner when the server starts up

    Definition Classes
    ServerBuilder
  46. def withoutHttp2c: Self
  47. def withoutSsl: Self

    Disables SSL.

Deprecated Value Members

  1. def withSSL(keyStore: StoreInfo, keyManagerPassword: String, protocol: String = "TLS", trustStore: Option[StoreInfo] = None, clientAuth: SSLClientAuthMode = SSLClientAuthMode.NotRequested): Self
    Annotations
    @deprecated
    Deprecated

    (Since version 0.21.0-RC3) Build an SSLContext from the first four parameters and use withSslContext (note lowercase). To also request client certificates, use withSslContextAndParameters, calling either .setWantClientAuth(true) or setNeedClientAuth(true) on the SSLParameters.

  2. def withSSLContext(sslContext: SSLContext, clientAuth: SSLClientAuthMode = SSLClientAuthMode.NotRequested): Self
    Annotations
    @deprecated
    Deprecated

    (Since version 0.21.0-RC3) Use withSslContext (note lowercase). To request client certificates, use withSslContextAndParameters, calling either .setWantClientAuth(true) or setNeedClientAuth(true) on the SSLParameters.

  3. def withThreadPool(threadPool: ThreadPool): JettyBuilder[F]

    Set the org.eclipse.jetty.util.thread.ThreadPool that Jetty will use.

    Set the org.eclipse.jetty.util.thread.ThreadPool that Jetty will use.

    Annotations
    @deprecated
    Deprecated

    (Since version 0.21.23) Please use withThreadPoolResource instead and see JettyThreadPools.

    Note

    You should prefer #withThreadPoolResource instead of this method. If you invoke this method the provided org.eclipse.jetty.util.thread.ThreadPool will not be joined, stopped, or destroyed when/if the Jetty server stops. This is to preserve the <= 0.21.23 semantics.

Inherited from ServletContainer[F]

Inherited from ServerBuilder[F]

Inherited from BackendBuilder[F, Server]

Inherited from AnyRef

Inherited from Any

Ungrouped