com.lightbend.lagom.javadsl.api.broker

Class Message<Payload>

Object

com.lightbend.lagom.javadsl.api.broker.Message<Payload>

public final class Message<Payload>
extends Object

A message broker message.

This provides access to both the message payload, and the metadata.

Method Summary

Modifier and Type	Method and Description
<Metadata> Message<Payload>	add(MetadataKey<Metadata> key, Metadata metadata) Add a metadata key and value to this message.
static <Payload> Message<Payload>	create(Payload payload) Create a message with the given payload.
<Metadata> Optional<Metadata>	get(MetadataKey<Metadata> key) Get the metadata for the given metadata key.
Payload	getPayload() The payload of the message.
String	messageKeyAsString() Get the message key as a String.
<P2> Message<P2>	withPayload(P2 payload) Return a copy of this message with the given payload.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getPayload

public Payload getPayload()

The payload of the message.

get

public <Metadata> Optional<Metadata> get(MetadataKey<Metadata> key)

Get the metadata for the given metadata key.

Parameters:

key - The key of the metadata.

Returns:

The metadata, if found for that key.

add

public <Metadata> Message<Payload> add(MetadataKey<Metadata> key,
                                       Metadata metadata)

Add a metadata key and value to this message.

Parameters:

key - The key to add.

metadata - The metadata to add.

Returns:

A copy of this message with the key and value added.

withPayload

public <P2> Message<P2> withPayload(P2 payload)

Return a copy of this message with the given payload.

Parameters:

payload - The payload.

Returns:

A copy of this message with the given payload.

messageKeyAsString

public String messageKeyAsString()

Get the message key as a String.

If the key is not a String, it will be converted to a String using toString.

If the underlying message broker doesn't support keys, the empty string will be returned.

Returns:

A string representation of the message key.

create

public static <Payload> Message<Payload> create(Payload payload)

Create a message with the given payload.