trait EndpointHandler[F[_], B] extends AnyRef
Handles the result of decoding a request using an endpoint's inputs.
- Alphabetic
- By Inheritance
- EndpointHandler
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def onDecodeFailure(ctx: DecodeFailureContext)(implicit monad: MonadError[F], bodyListener: BodyListener[F, B]): F[Option[ServerResponse[B]]]
Called when the given request hasn't been successfully decoded, because of the given failure on the given input.
Called when the given request hasn't been successfully decoded, because of the given failure on the given input. This is captured by the
ctxparameter.Might be called multiple times per request.
- returns
An effect, describing the optional server response. If
None, the next endpoint will be tried (if any).
- abstract def onDecodeSuccess[A, U, I](ctx: DecodeSuccessContext[F, A, U, I])(implicit monad: MonadError[F], bodyListener: BodyListener[F, B]): F[ServerResponse[B]]
Called when the request has been successfully decoded into data, and when the security logic succeeded.
Called when the request has been successfully decoded into data, and when the security logic succeeded. This is captured by the
ctxparameter.Called at most once per request.
- A
The type of the endpoint's security inputs.
- U
Type of the successful result of the security logic.
- I
The type of the endpoint's inputs.
- returns
An effect, describing the server's response.
- abstract def onSecurityFailure[A](ctx: SecurityFailureContext[F, A])(implicit monad: MonadError[F], bodyListener: BodyListener[F, B]): F[ServerResponse[B]]
Called when the security inputs have been successfully decoded into data, but the security logic failed (either with an error result or an exception).
Called when the security inputs have been successfully decoded into data, but the security logic failed (either with an error result or an exception). This is captured by the
ctxparameter.Called at most once per request.
- A
The type of the endpoint's security inputs.
- returns
An effect, describing the server's response.
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated