com.lightbend.lagom.javadsl.api.deser

Interface ExceptionSerializer

All Known Implementing Classes:

JacksonExceptionSerializer

public interface ExceptionSerializer

Handles the serialization and deserialization of exceptions.

Field Summary

Fields

Modifier and Type	Field and Description
static ExceptionSerializer	DEFAULT The default serializer factory.
static ExceptionSerializer	JACKSON The default Jackson exception serializer.

Method Summary

Modifier and Type	Method and Description
Throwable	deserialize(RawExceptionMessage message) Deserialize an exception message into an exception.
RawExceptionMessage	serialize(Throwable exception, Collection<MessageProtocol> accept) Serialize the given exception to an exception message.

Field Detail

JACKSON

static final ExceptionSerializer JACKSON

The default Jackson exception serializer.

This is only a placeholder, the framework will provide the actual implementation at runtime.

DEFAULT

static final ExceptionSerializer DEFAULT

The default serializer factory.

Method Detail

serialize

RawExceptionMessage serialize(Throwable exception,
                              Collection<MessageProtocol> accept)

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.

Parameters:

exception - The exception to serialize.

accept - The accepted protocols.

Returns:

The raw exception message.

deserialize

Throwable deserialize(RawExceptionMessage message)

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.

Parameters:

message - The message to deserialize.

Returns:

The deserialized exception.