abstract class ParsingErrorHandler extends AnyRef
Produces the response to a request that failed to parse. Selected by the
pekko.http.server.parsing-error-handler setting.
This is also the earliest public symbol that observes a rejected request, so it is what
observability tooling attaches to: the OpenTelemetry Java agent instruments handle to emit a
span for a request that never reaches the route handler
(open-telemetry/opentelemetry-java-instrumentation#5139).
- Alphabetic
- By Inheritance
- ParsingErrorHandler
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ParsingErrorHandler()
Abstract Value Members
- abstract def handle(status: StatusCode, error: ErrorInfo, log: LoggingAdapter, settings: ServerSettings): HttpResponse
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from ParsingErrorHandler toany2stringadd[ParsingErrorHandler] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (ParsingErrorHandler, B)
- Implicit
- This member is added by an implicit conversion from ParsingErrorHandler toArrowAssoc[ParsingErrorHandler] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- 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]) @IntrinsicCandidate() @native()
- def ensuring(cond: (ParsingErrorHandler) => Boolean, msg: => Any): ParsingErrorHandler
- Implicit
- This member is added by an implicit conversion from ParsingErrorHandler toEnsuring[ParsingErrorHandler] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (ParsingErrorHandler) => Boolean): ParsingErrorHandler
- Implicit
- This member is added by an implicit conversion from ParsingErrorHandler toEnsuring[ParsingErrorHandler] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): ParsingErrorHandler
- Implicit
- This member is added by an implicit conversion from ParsingErrorHandler toEnsuring[ParsingErrorHandler] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): ParsingErrorHandler
- Implicit
- This member is added by an implicit conversion from ParsingErrorHandler toEnsuring[ParsingErrorHandler] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- 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
- @IntrinsicCandidate() @native()
- def handle(status: StatusCode, error: ErrorInfo, log: LoggingAdapter, settings: ServerSettings, context: IllegalRequestContext): HttpResponse
Called by the server for a request that failed to parse, with what is known about that request.
Called by the server for a request that failed to parse, with what is known about that request.
The default implementation ignores
contextand delegates to the four-argumenthandle, so existing handlers keep working unchanged; override this method instead to make use of the context. The parameter is still worth passing for a handler that does not read it, because the arguments of this method are visible to anything instrumenting it: the OpenTelemetry Java agent has to name the span it emits for a rejected requestHTTPand report neitherhttp.request.methodnorurl.path, since the four-argument signature describes only the failure and never the request that caused it. See https://github.com/apache/pekko-http/issues/1245.Note that
DefaultParsingErrorHandlerdeliberately keeps implementing the four-argument method rather than this one, so that advice matching that signature keeps firing.- Since
2.0.0
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- 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
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- 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
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from ParsingErrorHandler toStringFormat[ParsingErrorHandler] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (ParsingErrorHandler, B)
- Implicit
- This member is added by an implicit conversion from ParsingErrorHandler toArrowAssoc[ParsingErrorHandler] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.