Class/Object

com.lightbend.lagom.scaladsl.api.deser

DefaultExceptionSerializer

Related Docs: object DefaultExceptionSerializer | package deser

Permalink

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().

Linear Supertypes
ExceptionSerializer, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DefaultExceptionSerializer
  2. ExceptionSerializer
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DefaultExceptionSerializer(environment: Environment)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def deserialize(message: RawExceptionMessage): Throwable

    Permalink

    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
    DefaultExceptionSerializerExceptionSerializer
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. def fromCodeAndMessage(transportErrorCode: TransportErrorCode, exceptionMessage: ExceptionMessage): Throwable

    Permalink

    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
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. def serialize(exception: Throwable, accept: Seq[MessageProtocol]): RawExceptionMessage

    Permalink

    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
    DefaultExceptionSerializerExceptionSerializer
  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  19. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ExceptionSerializer

Inherited from AnyRef

Inherited from Any

Ungrouped