Class/Object

io.finch

Bootstrap

Related Docs: object Bootstrap | package finch

Permalink

class Bootstrap[F[_], ES <: HList, CTS <: HList] extends AnyRef

Bootstraps a Finagle HTTP service out of the collection of Finch endpoints.

val api: Service[Request, Response] = Bootstrap
 .configure(negotiateContentType = true, enableMethodNotAllowed = true)
 .serve[Application.Json](getUser :+: postUser)
 .serve[Text.Plain](healthcheck)
 .toService

Supported Configuration Options

- includeDateHeader (default: true): whether or not to include the Date header into each response (see RFC2616, section 14.18)

- includeServerHeader (default: true): whether or not to include the Server header into each response (see RFC2616, section 14.38)

- enableMethodNotAllowed (default: false): whether or not to enable 405 MethodNotAllowed HTTP response (see RFC2616, section 10.4.6)

- enableUnsupportedMediaType (default: false) whether or not to enable 415 UnsupportedMediaType HTTP response (see RFC7231, section 6.5.13)

Self Type
Bootstrap[F, ES, CTS]
See also

https://tools.ietf.org/html/rfc7231#section-6.5.13

https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

https://www.w3.org/Protocols/rfc2616/rfc2616-sec12.html

https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

Linear Supertypes
AnyRef, Any
Known Subclasses
Bootstrap
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Bootstrap
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Bootstrap(endpoints: ES, includeDateHeader: Boolean = true, includeServerHeader: Boolean = true, enableMethodNotAllowed: Boolean = false, enableUnsupportedMediaType: Boolean = false)

    Permalink

Type Members

  1. class Serve[CT] extends AnyRef

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. def compile(implicit ts: Compile[F, ES, CTS]): Compiled[F]

    Permalink

  7. def configure(includeDateHeader: Boolean = self.includeDateHeader, includeServerHeader: Boolean = self.includeServerHeader, enableMethodNotAllowed: Boolean = self.enableMethodNotAllowed, enableUnsupportedMediaType: Boolean = self.enableUnsupportedMediaType): Bootstrap[F, ES, CTS]

    Permalink

  8. val enableMethodNotAllowed: Boolean

    Permalink

  9. val enableUnsupportedMediaType: Boolean

    Permalink

  10. val endpoints: ES

    Permalink

  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  12. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  15. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  16. val includeDateHeader: Boolean

    Permalink

  17. val includeServerHeader: Boolean

    Permalink

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. def serve[CT]: Serve[CT]

    Permalink

  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  24. def toService(implicit F: Effect[F], ts: Compile[F, ES, CTS]): Service[Request, Response]

    Permalink

  25. final def toString(): String

    Permalink
    Definition Classes
    Bootstrap → AnyRef → Any

  26. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  27. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  28. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped