Packages

trait HttpProblem extends RuntimeException with Error

An error type which represents an HTTP related problem.

This is an implementation of RFC 7807. While not strictly required by the RFC, instances of this type SHOULD provide a type, title, and status.

Note

This incarnation of RFC 7807 exists to be fully compliant with the RFC spec. The RFC permits all the fields to be optional, which can lead to error values which are not very useful. There is good reason for this choice by the authors of the RFC, if you are attempting to parse an error value you don't really want to fail during parsing just because the error is ill defined, you'd like to at least get what you can from the error value. That being said, using HttpError is much preferable to this type. Users are encouraged to use HttpError instead of HttpProblem.

See also

https://tools.ietf.org/html/rfc7807

Linear Supertypes
Error, RuntimeException, Exception, Throwable, Serializable, AnyRef, Any
Known Subclasses
SimpleHttpProblem
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HttpProblem
  2. Error
  3. RuntimeException
  4. Exception
  5. Throwable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def detail: Option[String]

    Detail information about the error.

    Detail information about the error. Unlike #title, this may change from occurrence to occurrence of the problem.

    See also

    https://tools.ietf.org/html/rfc7807#section-3.1

  2. abstract def instance: Option[String]

    This SHOULD be a URI reference unique to this instance of the problem.

    This SHOULD be a URI reference unique to this instance of the problem.

    See also

    https://tools.ietf.org/html/rfc7807#section-3.1

  3. abstract def status: Option[Int]

    The status code associated with the problem.

    The status code associated with the problem. It SHOULD map to status codes for HTTP (RFC 7231).

    See also

    https://tools.ietf.org/html/rfc7807#section-3.1

    https://tools.ietf.org/html/rfc7231

  4. abstract def title: Option[String]

    The title of the error.

    The title of the error. Per RFC 7807 this should be a short human readable summary of the problem. It should not change from occurrence to occurrence of the problem, e.g. it should have a functional dependency on type.

    See also

    https://tools.ietf.org/html/rfc7807#section-3.1

  5. abstract def type: Option[String]

    The type of the error.

    The type of the error. Per RFC 7807 this SHOULD be a URI.

    See also

    https://tools.ietf.org/html/rfc7807#section-3.1

Concrete 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. final def addSuppressed(arg0: Throwable): Unit
    Definition Classes
    Throwable
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def causes: Vector[Throwable]
    Definition Classes
    Error
  7. final lazy val causesErrorMessages: Vector[String]
    Definition Classes
    Error
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. final lazy val errorMessages: Vector[String]
    Definition Classes
    Error
  12. def fillInStackTrace(): Throwable
    Definition Classes
    Throwable
  13. final lazy val getCause: Throwable
    Definition Classes
    Error → Throwable
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def getLocalizedMessage(): String
    Definition Classes
    Throwable
  16. final lazy val getMessage: String
    Definition Classes
    Error → Throwable
  17. def getStackTrace(): Array[StackTraceElement]
    Definition Classes
    Throwable
  18. final def getSuppressed(): Array[Throwable]
    Definition Classes
    Throwable
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def initCause(arg0: Throwable): Throwable
    Definition Classes
    Throwable
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. final lazy val primaryErrorMessage: eu.timepit.refined.types.all.NonEmptyString
    Definition Classes
    HttpProblem → Error
  26. def printStackTrace(arg0: PrintWriter): Unit
    Definition Classes
    Throwable
  27. def printStackTrace(arg0: PrintStream): Unit
    Definition Classes
    Throwable
  28. def printStackTrace(): Unit
    Definition Classes
    Throwable
  29. def secondaryErrorMessages: Vector[String]
    Definition Classes
    Error
  30. def setStackTrace(arg0: Array[StackTraceElement]): Unit
    Definition Classes
    Throwable
  31. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  32. def toString(): String
    Definition Classes
    Throwable → AnyRef → Any
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

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

Inherited from Error

Inherited from RuntimeException

Inherited from Exception

Inherited from Throwable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped