Package org.axonframework.messaging.eventhandling.replay

Interface ResetContext

All Superinterfaces:

Message

All Known Implementing Classes:

GenericResetContext

public interface ResetContext
extends Message

A Message initiating the reset of an Event Handling Component.

A payload can be provided to support the reset operation handling this message.

Since:

4.4.0

Author:

Steven van Beelen

Field Summary

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

RESOURCE_KEY

Method Summary

Modifier and Type	Method	Description
ResetContext	andMetadata(Map<String,String> metadata)	Returns a copy of this Message (implementation) with its metadata merged with the given metadata.
default ResetContext	withConvertedPayload(Class<?> type, Converter converter)	Returns a new Message implementation with its Message.payload() converted to the given type by the given converter.
ResetContext	withConvertedPayload(Type type, Converter converter)	Returns a new Message implementation with its Message.payload() converted to the given type by the given converter.
default ResetContext	withConvertedPayload(TypeReference<?> type, Converter converter)	Returns a new Message implementation with its Message.payload() converted to the given type by the given converter.
ResetContext	withMetadata(Map<String,String> metadata)	Returns a copy of this Message (implementation) with the given metadata.

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

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

Method Details

withMetadata

ResetContext 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 Message

Parameters:

metadata - The new metadata for the Message.

Returns:

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

andMetadata

ResetContext andMetadata(Map<String,String> metadata)

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 Message

Parameters:

metadata - The metadata to merge with.

Returns:

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

withConvertedPayload

default ResetContext withConvertedPayload(Class<?> 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 Message

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.

withConvertedPayload

default ResetContext withConvertedPayload(TypeReference<?> 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 Message

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.

withConvertedPayload

ResetContext 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 Message

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.