io.spine.server.integration

Class ExternalMessageEnvelope

java.lang.Object

io.spine.server.type.AbstractMessageEnvelope<com.google.protobuf.Message,io.spine.server.integration.ExternalMessage,io.spine.core.ActorContext>

io.spine.server.integration.ExternalMessageEnvelope

All Implemented Interfaces:

MessageEnvelope<com.google.protobuf.Message,io.spine.server.integration.ExternalMessage,io.spine.core.ActorContext>

public final class ExternalMessageEnvelope
extends AbstractMessageEnvelope<com.google.protobuf.Message,io.spine.server.integration.ExternalMessage,io.spine.core.ActorContext>

An envelope for the messages produced outside of the current Bounded Context.

Method Summary

Modifier and Type	Method and Description
io.spine.core.Origin	asMessageOrigin() This method is not supported and always throws UnsupportedOperationException.
io.spine.core.ActorContext	context() Obtains the context of the message.
com.google.protobuf.Message	id() The ID of the message.
com.google.protobuf.Message	message() Obtains an originally transferred message.
io.spine.type.MessageClass	messageClass() Obtains a message class of an originally transferred message such as io.spine.sample.TaskCreated class.
static ExternalMessageEnvelope	of(io.spine.server.integration.ExternalMessage externalMessage, com.google.protobuf.Message originalMessage) Creates a new instance of ExternalMessageEnvelope from the ExternalMessage instance and the message transferred inside the ExternalMessage such as a io.spine.sample.TaskCreated event message.
EventEnvelope	toEventEnvelope() Converts this instance to an envelope of the external event.

Methods inherited from class io.spine.server.type.AbstractMessageEnvelope

equals, hashCode, outerObject, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

of

public static ExternalMessageEnvelope of(io.spine.server.integration.ExternalMessage externalMessage,
                                         com.google.protobuf.Message originalMessage)

Creates a new instance of ExternalMessageEnvelope from the ExternalMessage instance and the message transferred inside the ExternalMessage such as a io.spine.sample.TaskCreated event message.

This factory method provides an optimal performance of the ExternalMessageEnvelope creation. It allows to avoid unpacking the original message from the ExternalMessage instance.

Parameters:

externalMessage - the instance of ExternalMessage to wrap into an envelope

originalMessage - the message instance, which was originally transferred inside the externalMessage such as a io.spine.sample.TaskCreated event message.

Returns:

the new instance of external message envelope.

id

public com.google.protobuf.Message id()

Description copied from interface: MessageEnvelope

The ID of the message.

message

public com.google.protobuf.Message message()

Obtains an originally transferred message. For instance, io.spine.sample.TaskCreated event message may returned for an external event transferred inside of this envelope instance.

Returns:

the instance of origin message

messageClass

public io.spine.type.MessageClass messageClass()

Obtains a message class of an originally transferred message such as io.spine.sample.TaskCreated class.

Returns:

the event message

See Also:

ExternalMessageEnvelope.message(), ExternalMessageEnvelope.of(ExternalMessage, Message)

context

public io.spine.core.ActorContext context()

Description copied from interface: MessageEnvelope

Obtains the context of the message.

toEventEnvelope

public EventEnvelope toEventEnvelope()

Converts this instance to an envelope of the external event.

asMessageOrigin

public io.spine.core.Origin asMessageOrigin()

This method is not supported and always throws UnsupportedOperationException.

This should never happen as no event is caused directly by an ExternalMessage.

Instead, the external messages are consumed by an anti-corruption layer such as external reactor or subscriber methods in the destination Bounded Context.

Throws:

java.lang.UnsupportedOperationException - always