org.springframework.data.mongodb.core.messaging

Interface Message<S,T>

public interface Message<S,T>

General message abstraction for any type of Event / Message published by MongoDB server to the client. This might be Change Stream Events, or Documents published by a tailable cursor. The original message received is preserved in the raw parameter. Additional information about the origin of the Message is contained in Message.MessageProperties.
For convenience the getBody() of the message gets lazily converted into the target domain type if necessary using the mapping infrastructure.

Since:

2.1

Author:

Christoph Strobl, Mark Paluch

See Also:

Message.MessageProperties

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Message.MessageProperties

Method Summary

Modifier and Type	Method and Description
T	getBody() The converted message body if available.
Message.MessageProperties	getProperties() Message.MessageProperties containing information about the Message origin and other metadata.
S	getRaw() The raw message source as emitted by the origin.

Method Detail

getRaw

@Nullable
S getRaw()

The raw message source as emitted by the origin.

Returns:

can be null.

getBody

@Nullable
T getBody()

The converted message body if available.

Returns:

can be null.

getProperties

Message.MessageProperties getProperties()

Message.MessageProperties containing information about the Message origin and other metadata.

Returns:

never null.