Package org.axonframework.deadline

Class GenericDeadlineMessage

java.lang.Object

org.axonframework.messaging.core.MessageDecorator

org.axonframework.messaging.eventhandling.GenericEventMessage

org.axonframework.deadline.GenericDeadlineMessage

All Implemented Interfaces:

DeadlineMessage, Message, EventMessage

public class GenericDeadlineMessage
extends GenericEventMessage
implements DeadlineMessage

Generic implementation of the DeadlineMessage interface.

Since:

3.3.0

Author:

Milan Savic, Steven van Beelen

Field Summary

Fields inherited from interface org.axonframework.messaging.core.Message

RESOURCE_KEY

Constructor Summary

Constructors

Constructor	Description
GenericDeadlineMessage(String deadlineName, String identifier, MessageType type, @Nullable Object payload, Map<String,String> metadata, Instant timestamp)	Constructs a GenericDeadlineMessage for the given deadlineName, identifier, type, payload, metadata, and timestamp.
GenericDeadlineMessage(String deadlineName, Message delegate, Supplier<Instant> timestampSupplier)	Constructs a GenericDeadlineMessage for the given deadlineName, delegate and timestampSupplier, intended to reconstruct another DeadlineMessage.
GenericDeadlineMessage(String deadlineName, MessageType type, @Nullable Object payload)	Constructs a GenericDeadlineMessage for the given deadlineName, type, and payload.
GenericDeadlineMessage(String deadlineName, MessageType type, @Nullable Object payload, Map<String,String> metadata)	Constructs a GenericDeadlineMessage for the given deadlineName, type, payload, and metadata.
GenericDeadlineMessage(MessageType type, String deadlineName)	Constructs a GenericDeadlineMessage for the given type and deadlineName.

Method Summary

Modifier and Type	Method	Description
DeadlineMessage	andMetadata(Map<String,String> additionalMetadata)	Returns a copy of this Message (implementation) with its metadata merged with the given metadata.
static DeadlineMessage	asDeadlineMessage(String deadlineName, @Nullable Object messageOrPayload)	Deprecated. use asDeadlineMessage(String, Object, Instant) instead, as it sets the timestamp of the deadline, rather than the current time
static DeadlineMessage	asDeadlineMessage(String deadlineName, @Nullable Object messageOrPayload, Instant expiryTime)	Returns the given deadlineName and messageOrPayload as a DeadlineMessage which expires at the given expiryTime.
protected String	describeType()	Describe the type of message, used in MessageDecorator.toString().
String	getDeadlineName()	Returns the name of the deadline to be handled.
DeadlineMessage	withConvertedPayload(Type type, Converter converter)	Returns a new Message implementation with its Message.payload() converted to the given type by the given converter.
GenericDeadlineMessage	withConverter(@Nullable Converter converter)	Returns a new GenericDeadlineMessage with the same properties as this message, including its deadline name, and the given converter set for use in MessageDecorator.payloadAs(Class).
DeadlineMessage	withMetadata(Map<String,String> metadata)	Returns a copy of this Message (implementation) with the given metadata.

Methods inherited from class org.axonframework.messaging.eventhandling.GenericEventMessage

describeTo, timestamp

Methods inherited from class org.axonframework.messaging.core.MessageDecorator

delegate, identifier, metadata, payload, payloadAs, payloadAs, payloadAs, payloadType, toString, type

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.deadline.DeadlineMessage

withConvertedPayload, withConvertedPayload

Methods inherited from interface org.axonframework.messaging.eventhandling.EventMessage

identifier, timestamp

Methods inherited from interface org.axonframework.messaging.core.Message

metadata, payload, payloadAs, payloadAs, payloadAs, payloadAs, payloadAs, payloadType, type

Constructor Details

GenericDeadlineMessage

public GenericDeadlineMessage(MessageType type,
 String deadlineName)

Constructs a GenericDeadlineMessage for the given type and deadlineName.

The MessageDecorator.payload() defaults to null and the Metadata defaults to an empty instance.

Parameters:

type - the type for this DeadlineMessage

deadlineName - the name for this DeadlineMessage

GenericDeadlineMessage

public GenericDeadlineMessage(String deadlineName,
 MessageType type,
 @Nullable Object payload)

Constructs a GenericDeadlineMessage for the given deadlineName, type, and payload.

The Metadata defaults to an empty instance.

Parameters:

deadlineName - the name for this DeadlineMessage

type - the type for this DeadlineMessage

payload - the payload for this DeadlineMessage

GenericDeadlineMessage

public GenericDeadlineMessage(String deadlineName,
 MessageType type,
 @Nullable Object payload,
 Map<String,String> metadata)

Constructs a GenericDeadlineMessage for the given deadlineName, type, payload, and metadata.

Parameters:

deadlineName - the name for this DeadlineMessage

type - the type for this DeadlineMessage

payload - the payload for this DeadlineMessage

metadata - the metadata for this DeadlineMessage

GenericDeadlineMessage

public GenericDeadlineMessage(String deadlineName,
 String identifier,
 MessageType type,
 @Nullable Object payload,
 Map<String,String> metadata,
 Instant timestamp)

Constructs a GenericDeadlineMessage for the given deadlineName, identifier, type, payload, metadata, and timestamp.

Parameters:

deadlineName - the name for this DeadlineMessage

identifier - the identifier of this DeadlineMessage

type - the type for this DeadlineMessage

payload - the payload for this DeadlineMessage

metadata - the metadata for this DeadlineMessage

timestamp - the timestamp of this DeadlineMessage's creation

GenericDeadlineMessage

public GenericDeadlineMessage(String deadlineName,
 Message delegate,
 Supplier<Instant> timestampSupplier)

Constructs a GenericDeadlineMessage for the given deadlineName, delegate and timestampSupplier, intended to reconstruct another DeadlineMessage.

The timestamp of the deadline is supplied lazily through the given timestampSupplier to prevent unnecessary deserialization of the timestamp.

Parameters:

deadlineName - the name for this DeadlineMessage

delegate - the Message containing payload, type, identifier and metadata for the DeadlineMessage to reconstruct

timestampSupplier - Supplier for the timestamp of the DeadlineMessage's creation

Method Details

asDeadlineMessage

@Deprecated
public static DeadlineMessage asDeadlineMessage(String deadlineName,
 @Nullable Object messageOrPayload)

Deprecated.

use asDeadlineMessage(String, Object, Instant) instead, as it sets the timestamp of the deadline, rather than the current time

Returns the given deadlineName and messageOrPayload as a DeadlineMessage. If the messageOrPayload parameter is of type Message, a new DeadlineMessage will be created using the payload and metadata of the given message. Otherwise, the given messageOrPayload is wrapped into a GenericDeadlineMessage as its payload.

Parameters:

deadlineName - the name for the resulting DeadlineMessage

messageOrPayload - a Message or payload to wrap as a DeadlineMessage

Returns:

a DeadlineMessage using the deadlineName as its deadline name and containing the given messageOrPayload as the payload

asDeadlineMessage

public static DeadlineMessage asDeadlineMessage(String deadlineName,
 @Nullable Object messageOrPayload,
 Instant expiryTime)

Returns the given deadlineName and messageOrPayload as a DeadlineMessage which expires at the given expiryTime. If the messageOrPayload parameter is of type Message, a new DeadlineMessage instance will be created using the payload and metadata of the given message. Otherwise, the given messageOrPayload is wrapped into a GenericDeadlineMessage as its payload, with a MessageType resolved from the payload's class.

Parameters:

deadlineName - the name for the resulting DeadlineMessage

messageOrPayload - a Message or payload to wrap as a DeadlineMessage

expiryTime - the timestamp at which the deadline expires

Returns:

a DeadlineMessage using the deadlineName as its deadline name and containing the given messageOrPayload as the payload

getDeadlineName

public String getDeadlineName()

Description copied from interface: DeadlineMessage

Returns the name of the deadline to be handled.

Specified by:

getDeadlineName in interface DeadlineMessage

Returns:

the name of the deadline

withMetadata

public DeadlineMessage withMetadata(Map<String,String> metadata)

Description copied from interface: Message

Returns a copy of this Message (implementation) with the given metadata.

All other fields, like for example the Message.payload(), remain unchanged.

While the implementation returned may be different from the implementation of this, implementations must take special care in returning the same type of Message to prevent errors further downstream.

Specified by:

withMetadata in interface DeadlineMessage

Specified by:

withMetadata in interface EventMessage

Specified by:

withMetadata in interface Message

Overrides:

withMetadata in class GenericEventMessage

Parameters:

metadata - The new metadata for the Message.

Returns:

A copy of this Message (implementation) with the given metadata.

andMetadata

public DeadlineMessage andMetadata(Map<String,String> additionalMetadata)

Description copied from interface: Message

Returns a copy of this Message (implementation) with its metadata merged with the given metadata.

All other fields, like for example the Message.payload(), remain unchanged.

Specified by:

andMetadata in interface DeadlineMessage

Specified by:

andMetadata in interface EventMessage

Specified by:

andMetadata in interface Message

Overrides:

andMetadata in class GenericEventMessage

Parameters:

additionalMetadata - The metadata to merge with.

Returns:

A copy of this Message (implementation) with the given metadata.

withConvertedPayload

public DeadlineMessage withConvertedPayload(Type type,
 Converter converter)

Description copied from interface: Message

Returns a new Message implementation with its Message.payload() converted to the given type by the given converter. This new Message is effectively a copy of this Message with a renewed payload and Message.payloadType().

Will return the this instance if the payload type is assignable from the converted result.

Specified by:

withConvertedPayload in interface DeadlineMessage

Specified by:

withConvertedPayload in interface EventMessage

Specified by:

withConvertedPayload in interface Message

Overrides:

withConvertedPayload in class GenericEventMessage

Parameters:

type - The type to convert the Message.payload() to.

converter - The converter to convert the Message.payload() with.

Returns:

A new Message implementation with its Message.payload() converted to the given type by the given converter.

withConverter

public GenericDeadlineMessage withConverter(@Nullable Converter converter)

Returns a new GenericDeadlineMessage with the same properties as this message, including its deadline name, and the given converter set for use in MessageDecorator.payloadAs(Class).

Overrides:

withConverter in class GenericEventMessage

Parameters:

converter - the converter for the new message

Returns:

a copy of this instance with the converter set

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 GenericEventMessage

Returns:

The type of the message.