Packages

case class DefaultDecodeFailureHandler(respond: (DecodeFailureContext) => Option[(StatusCode, List[Header])], failureMessage: (DecodeFailureContext) => String, response: (StatusCode, List[Header], String) => ValuedEndpointOutput[_]) extends DecodeFailureHandler with Product with Serializable

A decode failure handler, which:

  • decides whether the given decode failure should lead to a response (and if so, with which status code and headers), using respond
  • in case a response is sent, creates the message using failureMessage
  • in case a response is sent, creates the response using response, given the status code, headers, and the created failure message. By default, the headers might include authentication challenge.
Linear Supertypes
Serializable, Product, Equals, DecodeFailureHandler, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DefaultDecodeFailureHandler
  2. Serializable
  3. Product
  4. Equals
  5. DecodeFailureHandler
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DefaultDecodeFailureHandler(respond: (DecodeFailureContext) => Option[(StatusCode, List[Header])], failureMessage: (DecodeFailureContext) => String, response: (StatusCode, List[Header], String) => ValuedEndpointOutput[_])

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. def apply(ctx: DecodeFailureContext): Option[ValuedEndpointOutput[_]]

    Given the context in which a decode failure occurred (the request, the input and the failure), returns an optional response to the request.

    Given the context in which a decode failure occurred (the request, the input and the failure), returns an optional response to the request. None indicates that no action should be taken, and the request might be passed for decoding to other endpoints.

    Inputs are decoded in the following order: path, method, query, headers, body. Hence, if there's a decode failure on a query parameter, any method & path inputs of the input must have matched and must have been decoded successfully.

    Definition Classes
    DefaultDecodeFailureHandler → DecodeFailureHandler
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. val failureMessage: (DecodeFailureContext) => String
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def productElementNames: Iterator[String]
    Definition Classes
    Product
  15. val respond: (DecodeFailureContext) => Option[(StatusCode, List[Header])]
  16. def response(messageOutput: (String) => ValuedEndpointOutput[_]): DefaultDecodeFailureHandler
  17. val response: (StatusCode, List[Header], String) => ValuedEndpointOutput[_]
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from DecodeFailureHandler

Inherited from AnyRef

Inherited from Any

Ungrouped