com.lightbend.lagom.scaladsl.api.deser
DefaultExceptionSerializer
Companion object DefaultExceptionSerializer
class DefaultExceptionSerializer extends ExceptionSerializer
The default exception serializer.
Serializes exception messages to JSON.
This serializer is capable of converting Lagom built-in exceptions to and from JSON. Custom sub classes of TransportException can also be deserialized by extending this class and overriding fromCodeAndMessage().
- Alphabetic
- By Inheritance
- DefaultExceptionSerializer
- ExceptionSerializer
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new DefaultExceptionSerializer(environment: Environment)
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 DefaultExceptionSerializer to any2stringadd[DefaultExceptionSerializer] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (DefaultExceptionSerializer, B)
- Implicit
- This member is added by an implicit conversion from DefaultExceptionSerializer to ArrowAssoc[DefaultExceptionSerializer] 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( ... ) @native()
-
def
deserialize(message: RawExceptionMessage): Throwable
Deserialize an exception message into an exception.
Deserialize an exception message into an exception.
The exception serializer should make a best effort attempt at deserializing the message, but should not expect the message to be in any particular format. If it cannot deserialize the message, it should return a generic exception, it should not itself throw an exception.
- message
The message to deserialize.
- returns
The deserialized exception.
- Definition Classes
- DefaultExceptionSerializer → ExceptionSerializer
-
def
ensuring(cond: (DefaultExceptionSerializer) ⇒ Boolean, msg: ⇒ Any): DefaultExceptionSerializer
- Implicit
- This member is added by an implicit conversion from DefaultExceptionSerializer to Ensuring[DefaultExceptionSerializer] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (DefaultExceptionSerializer) ⇒ Boolean): DefaultExceptionSerializer
- Implicit
- This member is added by an implicit conversion from DefaultExceptionSerializer to Ensuring[DefaultExceptionSerializer] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): DefaultExceptionSerializer
- Implicit
- This member is added by an implicit conversion from DefaultExceptionSerializer to Ensuring[DefaultExceptionSerializer] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): DefaultExceptionSerializer
- Implicit
- This member is added by an implicit conversion from DefaultExceptionSerializer to Ensuring[DefaultExceptionSerializer] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from DefaultExceptionSerializer to StringFormat[DefaultExceptionSerializer] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
-
def
fromCodeAndMessage(transportErrorCode: TransportErrorCode, exceptionMessage: ExceptionMessage): Throwable
Override this if you wish to deserialize your own custom Exceptions.
Override this if you wish to deserialize your own custom Exceptions.
The default implementation delegates to TransportException.fromCodeAndMessage(), which will return a best match Lagom built-in exception.
- transportErrorCode
The transport error code.
- exceptionMessage
The exception message.
- returns
The exception.
- Attributes
- protected
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @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
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
serialize(exception: Throwable, accept: Seq[MessageProtocol]): RawExceptionMessage
Serialize the given exception to an exception message.
Serialize the given exception to an exception message.
The raw exception message consists of an error code, a message protocol, and a message entity to send across the wire.
The exception serializer may attempt to match one of the protocols passed into the accept parameter.
- exception
The exception to serialize.
- accept
The accepted protocols.
- returns
The raw exception message.
- Definition Classes
- DefaultExceptionSerializer → ExceptionSerializer
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
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( ... ) @native()
-
def
→[B](y: B): (DefaultExceptionSerializer, B)
- Implicit
- This member is added by an implicit conversion from DefaultExceptionSerializer to ArrowAssoc[DefaultExceptionSerializer] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc