Endpoint

An Endpoint represents the HTTP endpoint.

It is well known and widely adopted in Finagle that "Your Server is a Function" (i.e., Request => Future[Response]). In a REST/HTTP API setting this function may be viewed as Request =1=> (A =2=> Future[B]) =3=> Future[Response], where transformation 1 is a request decoding (deserialization), transformation 2 - is a business logic and transformation 3 is - a response encoding (serialization). The only interesting part here is transformation 2 (i.e., A => Future[B]), which represents an application business.

An Endpoint transformation (map, mapAsync, etc.) encodes the business logic, while the rest of Finch ecosystem takes care about both serialization and deserialization.

A typical way to transform (or map) the Endpoint is to use io.finch.syntax.Mapper:

import io.finch._

case class Foo(i: Int)
case class Bar(s: String)

val foo: Endpoint[Foo] = get("foo") { Ok(Foo(42)) }
val bar: Endpoint[Bar] = get("bar" :: string) { s: String => Ok(Bar(s)) }

Endpoints are also composable in terms of or-else combinator (known as a "space invader" operator :+:) that takes two Endpoints and returns a coproduct Endpoint.

import io.finch._

val foobar: Endpoint[Foo :+: Bar :+: CNil] = foo :+: bar

An Endpoint might be converted into a Finagle Service with Endpoint.toService method so it can be served within Finagle HTTP.

import com.twitter.finagle.Http

Http.server.serve(foobar.toService)

Self Type: Endpoint[A]

Linear Supertypes

AnyRef, Any

Known Subclasses

*, /, EndpointMapper, root

Abstract Value Members

abstract def apply(input: Input): Result[A]

Runs this endpoint.

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def :+:[B](that: Endpoint[B])(implicit a: Adjoin[:+:[B, :+:[A, CNil]]]): Endpoint[shapeless.ops.adjoin.Adjoin.Out]

Composes this endpoint with another in such a way that coproducts are flattened.
final def ::[B](other: Endpoint[B])(implicit pa: PairAdjoin[B, A]): Endpoint[internal.PairAdjoin.Out]

Composes this endpoint with the given Endpoint.
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def coproduct[B >: A](other: Endpoint[B]): Endpoint[B]

Sequentially composes this endpoint with the given other endpoint.
Sequentially composes this endpoint with the given other endpoint. The resulting endpoint will succeed if either this or that endpoints are succeed.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def handle[B >: A](pf: PartialFunction[Throwable, Output[B]]): Endpoint[B]

Recovers from any exception occurred in this endpoint by creating a new endpoint that will handle any matching throwable from the underlying future.
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def item: RequestItem

Request item (part) that's this endpoint work with.
final def liftToTry: Endpoint[Try[A]]

Lifts this endpoint into one that always succeeds, with Try representing both success and failure cases.
final def map[B](fn: (A) ⇒ B): Endpoint[B]

Maps this endpoint to the given function A => B.
final def mapAsync[B](fn: (A) ⇒ Future[B]): Endpoint[B]

Maps this endpoint to the given function A => Future[B].
final def mapOutput[B](fn: (A) ⇒ Output[B]): Endpoint[B]

Maps this endpoint to the given function A => Output[B].
final def mapOutputAsync[B](fn: (A) ⇒ Future[Output[B]]): Endpoint[B]

Maps this endpoint to the given function A => Future[Output[B]].
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def product[B](other: Endpoint[B]): Endpoint[(A, B)]

Returns a product of this and other endpoint.
Returns a product of this and other endpoint. The resulting endpoint returns a tuple of both values.
This combinator is an important piece for Finch's error accumulation. In its current form, product will accumulate Finch's own errors (i.e., Errors) into Errors) and will fail-fast with the first non-Finch error (just ordinary Exception) observed.
final def productWith[B, O](other: Endpoint[B])(p: (A, B) ⇒ O): Endpoint[O]

Returns a product of this and other endpoint.
Returns a product of this and other endpoint. The resulting endpoint returns a value of resulting type for product function.
final def rescue[B >: A](pf: PartialFunction[Throwable, Future[Output[B]]]): Endpoint[B]

Recovers from any exception occurred in this endpoint by creating a new endpoint that will handle any matching throwable from the underlying future.
final def should(rule: ValidationRule[A]): Endpoint[A]

Validates the result of this endpoint using a predefined rule.
Validates the result of this endpoint using a predefined rule. This method allows for rules to be reused across multiple endpoints.
rule
the predefined ValidationRule that will return true if the data is valid
returns
an endpoint that will return the value of this reader if it is valid. Otherwise the future fails with an Error.NotValid error.
final def should(rule: String)(predicate: (A) ⇒ Boolean): Endpoint[A]

Validates the result of this endpoint using a predicate.
Validates the result of this endpoint using a predicate. The rule is used for error reporting.
rule
text describing the rule being validated
predicate
returns true if the data is valid
returns
an endpoint that will return the value of this reader if it is valid. Otherwise the future fails with an Error.NotValid error.
final def shouldNot(rule: ValidationRule[A]): Endpoint[A]

Validates the result of this endpoint using a predefined rule.
Validates the result of this endpoint using a predefined rule. This method allows for rules to be reused across multiple endpoints.
rule
the predefined ValidationRule that will return false if the data is valid
returns
an endpoint that will return the value of this reader if it is valid. Otherwise the future fails with a Error.NotValid error.
final def shouldNot(rule: String)(predicate: (A) ⇒ Boolean): Endpoint[A]

Validates the result of this endpoint using a predicate.
Validates the result of this endpoint using a predicate. The rule is used for error reporting.
rule
text describing the rule being validated
predicate
returns false if the data is valid
returns
an endpoint that will return the value of this reader if it is valid. Otherwise the future fails with a Error.NotValid error.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def toService(implicit tr: ToResponse.Aux[A, Json], tre: ToResponse.Aux[Exception, Json]): Service[Request, Response]

Converts this endpoint to a Finagle service Request => Future[Response] that serves JSON.
Converts this endpoint to a Finagle service Request => Future[Response] that serves JSON.
Consider using Bootstrap instead.
final def toServiceAs[CT <: String](implicit tr: ToResponse.Aux[A, CT], tre: ToResponse.Aux[Exception, CT]): Service[Request, Response]

Converts this endpoint to a Finagle service Request => Future[Response] that serves custom content-type CT.
Converts this endpoint to a Finagle service Request => Future[Response] that serves custom content-type CT.
Consider using Bootstrap instead.
def toString(): String

Definition Classes
AnyRef → Any
final def transform[B](fn: (Future[Output[A]]) ⇒ Future[Output[B]]): Endpoint[B]

Transforms this endpoint to the given function Future[Output[A]] => Future[Output[B]].
Transforms this endpoint to the given function Future[Output[A]] => Future[Output[B]].
Might be useful to perform some extra action on the underlying Future. For example, time the latency of the given endpoint.
```
import io.finch._
import com.twitter.finagle.stats._

def time[A](stat: Stat, e: Endpoint[A]): Endpoint[A] =
  e.transform(f => Stat.timeFuture(s)(f))
```
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def withCharset(charset: Charset): Endpoint[A]
final def withCookie(cookie: Cookie): Endpoint[A]
final def withHeader(header: (String, String)): Endpoint[A]
final def withToString(ts: ⇒ String): Endpoint[A]

Overrides the toString method on this endpoint.

Related Docs: object Endpoint | package finch

trait Endpoint[A] extends AnyRef

Abstract Value Members

abstract def apply(input: Input): Result[A]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def :+:[B](that: Endpoint[B])(implicit a: Adjoin[:+:[B, :+:[A, CNil]]]): Endpoint[shapeless.ops.adjoin.Adjoin.Out]

final def ::[B](other: Endpoint[B])(implicit pa: PairAdjoin[B, A]): Endpoint[internal.PairAdjoin.Out]

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def coproduct[B >: A](other: Endpoint[B]): Endpoint[B]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def handle[B >: A](pf: PartialFunction[Throwable, Output[B]]): Endpoint[B]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def item: RequestItem

final def liftToTry: Endpoint[Try[A]]

final def map[B](fn: (A) ⇒ B): Endpoint[B]

final def mapAsync[B](fn: (A) ⇒ Future[B]): Endpoint[B]

final def mapOutput[B](fn: (A) ⇒ Output[B]): Endpoint[B]

final def mapOutputAsync[B](fn: (A) ⇒ Future[Output[B]]): Endpoint[B]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def product[B](other: Endpoint[B]): Endpoint[(A, B)]

final def productWith[B, O](other: Endpoint[B])(p: (A, B) ⇒ O): Endpoint[O]

final def rescue[B >: A](pf: PartialFunction[Throwable, Future[Output[B]]]): Endpoint[B]

final def should(rule: ValidationRule[A]): Endpoint[A]

final def should(rule: String)(predicate: (A) ⇒ Boolean): Endpoint[A]

final def shouldNot(rule: ValidationRule[A]): Endpoint[A]

final def shouldNot(rule: String)(predicate: (A) ⇒ Boolean): Endpoint[A]

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

final def toService(implicit tr: ToResponse.Aux[A, Json], tre: ToResponse.Aux[Exception, Json]): Service[Request, Response]

final def toServiceAs[CT <: String](implicit tr: ToResponse.Aux[A, CT], tre: ToResponse.Aux[Exception, CT]): Service[Request, Response]

def toString(): String

final def transform[B](fn: (Future[Output[A]]) ⇒ Future[Output[B]]): Endpoint[B]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

final def withCharset(charset: Charset): Endpoint[A]

final def withCookie(cookie: Cookie): Endpoint[A]

final def withHeader(header: (String, String)): Endpoint[A]

final def withToString(ts: ⇒ String): Endpoint[A]

Inherited from AnyRef

Inherited from Any

Ungrouped