com.lightbend.lagom.javadsl.api.deser

Class RawExceptionMessage

Object

com.lightbend.lagom.javadsl.api.deser.RawExceptionMessage

public class RawExceptionMessage
extends Object

A serialized exception message.

A serialized exception message consists of a transport error code, a protocol, and a message body. All, some or none of these details may be sent over the wire when the error is sent, depending on what the underlying protocol supports.

Some protocols have a maximum limit on the amount of data that can be sent with an error message, eg for WebSockets, the WebSocket close frame can have a maximum payload of 125 bytes. While it's up to the transport implementation itself to enforce this limit and gracefully handle when the message exceeds this, exception serializers should be aware of this when producing exception messages.

Constructor Summary

Constructors

Constructor and Description
RawExceptionMessage(TransportErrorCode errorCode, MessageProtocol protocol, akka.util.ByteString message)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
TransportErrorCode	errorCode() The error code.
int	hashCode()
akka.util.ByteString	message() The message.
String	messageAsText() Get the message as text.
MessageProtocol	protocol() The protocol.
String	toString()

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RawExceptionMessage

public RawExceptionMessage(TransportErrorCode errorCode,
                           MessageProtocol protocol,
                           akka.util.ByteString message)

Method Detail

errorCode

public TransportErrorCode errorCode()

The error code.

This will be sent as an HTTP status code, or WebSocket close code.

Returns:

The error code.

protocol

public MessageProtocol protocol()

The protocol.

Returns:

The protocol.

message

public akka.util.ByteString message()

The message.

Returns:

The message.

messageAsText

public String messageAsText()

Get the message as text.

If this is a binary message (that is, the message protocol does not define a charset), encodes it using Base64.

Returns:

The message as text.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object