org.axonframework.eventhandling

Class GenericTrackedDomainEventMessage<T>

java.lang.Object

org.axonframework.messaging.MessageDecorator<T>

org.axonframework.eventhandling.GenericEventMessage<T>

org.axonframework.eventhandling.GenericDomainEventMessage<T>

org.axonframework.eventhandling.GenericTrackedDomainEventMessage<T>

Type Parameters:

T - The type of payload contained in this Message

All Implemented Interfaces:

Serializable, DomainEventMessage<T>, EventMessage<T>, TrackedEventMessage<T>, Message<T>

public class GenericTrackedDomainEventMessage<T>
extends GenericDomainEventMessage<T>
implements TrackedEventMessage<T>

Generic implementation of a DomainEventMessage that is also a TrackedEventMessage.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.axonframework.eventhandling.GenericEventMessage

clock

Constructor Summary

Constructors

Modifier	Constructor and Description
	GenericTrackedDomainEventMessage(TrackingToken trackingToken, DomainEventMessage<T> delegate) Initialize a DomainEventMessage originating from an aggregate.
protected	GenericTrackedDomainEventMessage(TrackingToken trackingToken, String type, String aggregateIdentifier, long sequenceNumber, Message<T> delegate, Instant timestamp) Initialize a DomainEventMessage originating from an aggregate.
	GenericTrackedDomainEventMessage(TrackingToken trackingToken, String type, String aggregateIdentifier, long sequenceNumber, Message<T> delegate, Supplier<Instant> timestamp) Initialize a DomainEventMessage originating from an Aggregate using existing data.

Method Summary

Modifier and Type	Method and Description
GenericTrackedDomainEventMessage<T>	andMetaData(Map<String,?> metaData) Returns a copy of this EventMessage with it MetaData merged with the given metaData.
protected void	describeTo(StringBuilder stringBuilder) Describe the message specific properties to the given stringBuilder.
protected String	describeType() Describe the type of message, used in MessageDecorator.toString().
TrackingToken	trackingToken() Returns the TrackingToken of the event message.
GenericTrackedDomainEventMessage<T>	withMetaData(Map<String,?> metaData) Returns a copy of this EventMessage with the given metaData.
GenericTrackedDomainEventMessage<T>	withTrackingToken(TrackingToken trackingToken) Creates a copy of this message with the given trackingToken to replace the one in this message.

Methods inherited from class org.axonframework.eventhandling.GenericDomainEventMessage

getAggregateIdentifier, getSequenceNumber, getType

Methods inherited from class org.axonframework.eventhandling.GenericEventMessage

asEventMessage, getTimestamp

Methods inherited from class org.axonframework.messaging.MessageDecorator

getDelegate, getIdentifier, getMetaData, getPayload, getPayloadType, serializeMetaData, serializePayload, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.axonframework.eventhandling.EventMessage

getIdentifier, getTimestamp

Methods inherited from interface org.axonframework.messaging.Message

getMetaData, getPayload, getPayloadType, serializeMetaData, serializePayload

Constructor Detail

GenericTrackedDomainEventMessage

public GenericTrackedDomainEventMessage(TrackingToken trackingToken,
                                        DomainEventMessage<T> delegate)

Initialize a DomainEventMessage originating from an aggregate.

Parameters:

trackingToken - Tracking token of the event

delegate - Delegate domain event containing other event data

GenericTrackedDomainEventMessage

public GenericTrackedDomainEventMessage(TrackingToken trackingToken,
                                        String type,
                                        String aggregateIdentifier,
                                        long sequenceNumber,
                                        Message<T> delegate,
                                        Supplier<Instant> timestamp)

Initialize a DomainEventMessage originating from an Aggregate using existing data. The timestamp of the event is supplied lazily to prevent unnecessary deserialization of the timestamp.

Parameters:

trackingToken - Tracking token of the event

type - The domain type

aggregateIdentifier - The identifier of the aggregate generating this message

sequenceNumber - The message's sequence number

delegate - The delegate message providing the payload, metadata and identifier of the event

timestamp - The event's timestamp supplier

GenericTrackedDomainEventMessage

protected GenericTrackedDomainEventMessage(TrackingToken trackingToken,
                                           String type,
                                           String aggregateIdentifier,
                                           long sequenceNumber,
                                           Message<T> delegate,
                                           Instant timestamp)

Initialize a DomainEventMessage originating from an aggregate.

Parameters:

trackingToken - Tracking token of the event

type - The domain type

aggregateIdentifier - The identifier of the aggregate generating this message

sequenceNumber - The message's sequence number

delegate - The delegate message providing the payload, metadata and identifier of the event

timestamp - The event's timestamp

Method Detail

trackingToken

public TrackingToken trackingToken()

Description copied from interface: TrackedEventMessage

Returns the TrackingToken of the event message.

Specified by:

trackingToken in interface TrackedEventMessage<T>

Returns:

the tracking token of the event

withMetaData

public GenericTrackedDomainEventMessage<T> withMetaData(@Nonnull
                                                        Map<String,?> metaData)

Description copied from interface: EventMessage

Returns a copy of this EventMessage with the given metaData. The payload, Timestamp and Identifier remain unchanged.

Specified by:

withMetaData in interface DomainEventMessage<T>

Specified by:

withMetaData in interface EventMessage<T>

Specified by:

withMetaData in interface Message<T>

Overrides:

withMetaData in class GenericDomainEventMessage<T>

Parameters:

metaData - The new MetaData for the Message

Returns:

a copy of this message with the given MetaData

andMetaData

public GenericTrackedDomainEventMessage<T> andMetaData(@Nonnull
                                                       Map<String,?> metaData)

Description copied from interface: EventMessage

Returns a copy of this EventMessage with it MetaData merged with the given metaData. The payload, Timestamp and Identifier remain unchanged.

Specified by:

andMetaData in interface DomainEventMessage<T>

Specified by:

andMetaData in interface EventMessage<T>

Specified by:

andMetaData in interface Message<T>

Overrides:

andMetaData in class GenericDomainEventMessage<T>

Parameters:

metaData - The MetaData to merge with

Returns:

a copy of this message with the given MetaData

describeTo

protected void describeTo(StringBuilder stringBuilder)

Description copied from class: MessageDecorator

Describe the message specific properties to the given stringBuilder. Subclasses should override this method, calling the super method and appending their own properties to the end (or beginning).

As convention, String values should be enclosed in single quotes, Objects in curly brackets and numeric values may be appended without enclosing. All properties should be preceded by a comma when appending, or finish with a comma when prefixing values.

Overrides:

describeTo in class GenericDomainEventMessage<T>

Parameters:

stringBuilder - the builder to append data to

withTrackingToken

public GenericTrackedDomainEventMessage<T> withTrackingToken(TrackingToken trackingToken)

Description copied from interface: TrackedEventMessage

Creates a copy of this message with the given trackingToken to replace the one in this message.

This method is useful in case streams are modified (combined, split), and the tokens of the combined stream are different than the originating stream.

Specified by:

withTrackingToken in interface TrackedEventMessage<T>

Parameters:

trackingToken - The tracking token to replace

Returns:

a new instance of a message with a different tracking token

describeType

protected String describeType()

Description copied from class: MessageDecorator

Describe the type of message, used in MessageDecorator.toString().

Defaults to the simple class name of the actual instance.

Overrides:

describeType in class GenericDomainEventMessage<T>

Returns:

the type of message