Uses of Class
org.axonframework.messaging.core.Metadata

Packages that use Metadata

Package	Description
io.axoniq.framework.messaging.deadletter	Part of the Axon Messaging module.
io.axoniq.framework.messaging.eventhandling.deadletter.jdbc	Part of the Axon Messaging module.
io.axoniq.framework.messaging.eventhandling.deadletter.jpa	Part of the Axon Messaging module.
io.axoniq.framework.tracing.micrometer.propagator	Micrometer Propagator carrier over Axon message metadata: the Propagator.Getter/Propagator.Setter pair used to extract and inject trace context to and from a message's metadata, so a trace continues across message and service boundaries.
io.axoniq.framework.workflow.dsl.simple	Convenience Java DSL built on top of the base DSL, adding shortcuts for common workflow steps such as executing without extra input payload, waiting for a typed event, and replacing the workflow payload outright.
io.axoniq.framework.workflow.runtime.execution	Internal implementation of the workflow execution engine: the WorkflowEngine, its scheduling, state and storage, checkpointing/replay support, cancellation coordination, and the delegates implementing individual step primitives.
io.axoniq.framework.workflow.runtime.util	Internal runtime utilities for future resolution, workflow event and metadata construction, processing context propagation, reflection, and workflow state inspection.
org.axonframework.deadline	Deadline support carried over from Axon Framework 4, to keep deadlines that were scheduled before migrating firing while a project moves off this API.
org.axonframework.messaging.commandhandling.gateway	Part of the Axon Messaging module.
org.axonframework.messaging.core	Classes related to message processing in Axon Framework.
org.axonframework.messaging.eventhandling.gateway	Part of the Axon Messaging module.
org.axonframework.messaging.queryhandling.gateway	Part of the Axon Messaging module.
org.axonframework.test.fixture	Part of the Axon Test module.
org.axonframework.test.util	Part of the Axon Test module.

Uses of Metadata in io.axoniq.framework.messaging.deadletter

Methods in io.axoniq.framework.messaging.deadletter that return Metadata

Modifier and Type	Method	Description
Metadata	DeadLetter.diagnostics()	The diagnostic Metadata concerning this letter.
Metadata	GenericDeadLetter.diagnostics()

Methods in io.axoniq.framework.messaging.deadletter with parameters of type Metadata

Modifier and Type	Method	Description
DeadLetter<M>	DeadLetter.withDiagnostics(Metadata diagnostics)	Construct a copy of this DeadLetter, replacing the DeadLetter.diagnostics() with the given diagnostics.
DeadLetter<M>	GenericDeadLetter.withDiagnostics(Metadata diagnostics)

Method parameters in io.axoniq.framework.messaging.deadletter with type arguments of type Metadata

Modifier and Type	Method	Description
static <M extends Message> ShouldEnqueue<M>	Decisions.enqueue(Throwable enqueueCause, Function<DeadLetter<? extends M>,Metadata> diagnosticsBuilder)	Construct a ShouldEnqueue defining that a dead letter should be enqueued because of the given enqueueCause.
static <M extends Message> ShouldEnqueue<M>	Decisions.requeue(Throwable requeueCause, Function<DeadLetter<? extends M>,Metadata> diagnosticsBuilder)	Construct a ShouldEnqueue defining that a dead letter should be requeued because of the given requeueCause.
default DeadLetter<M>	DeadLetter.withDiagnostics(UnaryOperator<Metadata> diagnosticsBuilder)	Construct a copy of this DeadLetter, replacing the DeadLetter.diagnostics() with the result of the given diagnosticsBuilder.

Constructors in io.axoniq.framework.messaging.deadletter with parameters of type Metadata

Modifier	Constructor	Description
	GenericDeadLetter(Object sequenceIdentifier, M message, Cause cause, Instant enqueuedAt, Instant lastTouched, Metadata diagnostics)	Construct a GenericDeadLetter defining all the fields.
	GenericDeadLetter(Object sequenceIdentifier, M message, Cause cause, Instant enqueuedAt, Instant lastTouched, Metadata diagnostics, Context context)	Construct a GenericDeadLetter defining all the fields including the associated Context.

Constructor parameters in io.axoniq.framework.messaging.deadletter with type arguments of type Metadata

Modifier	Constructor	Description
	ShouldEnqueue(Throwable enqueueCause, Function<DeadLetter<? extends M>,Metadata> diagnosticsBuilder)	Constructs a default EnqueueDecision to enqueue using the given enqueueCause as the ShouldEnqueue.enqueueCause().

Uses of Metadata in io.axoniq.framework.messaging.eventhandling.deadletter.jdbc

Methods in io.axoniq.framework.messaging.eventhandling.deadletter.jdbc that return Metadata

Modifier and Type	Method	Description
Metadata	JdbcDeadLetter.diagnostics()

Methods in io.axoniq.framework.messaging.eventhandling.deadletter.jdbc with parameters of type Metadata

Modifier and Type	Method	Description
PreparedStatement	DeadLetterStatementFactory.requeueStatement(Connection connection, String identifier, Cause cause, Instant lastTouched, Metadata diagnostics)	Constructs the PreparedStatement used for the JdbcSequencedDeadLetterQueue.requeue(DeadLetter, UnaryOperator, org.axonframework.messaging.core.unitofwork.ProcessingContext) operation.
PreparedStatement	DefaultDeadLetterStatementFactory.requeueStatement(Connection connection, String letterIdentifier, Cause cause, Instant lastTouched, Metadata diagnostics)
DeadLetter<E>	JdbcDeadLetter.withDiagnostics(Metadata diagnostics)

Constructors in io.axoniq.framework.messaging.eventhandling.deadletter.jdbc with parameters of type Metadata

Modifier	Constructor	Description
	JdbcDeadLetter(String identifier, long index, String sequenceIdentifier, Instant enqueuedAt, Instant lastTouched, Cause cause, Metadata diagnostics, E message, Context context)	Constructs a new JdbcDeadLetter with all possible parameters.

Uses of Metadata in io.axoniq.framework.messaging.eventhandling.deadletter.jpa

Methods in io.axoniq.framework.messaging.eventhandling.deadletter.jpa that return Metadata

Modifier and Type	Method	Description
Metadata	JpaDeadLetter.diagnostics()

Methods in io.axoniq.framework.messaging.eventhandling.deadletter.jpa with parameters of type Metadata

Modifier and Type	Method	Description
void	DeadLetterEntry.setDiagnostics(Metadata diagnostics, Converter converter)	Sets the diagnostics, using the given Converter to serialize to byte array format.
DeadLetter<M>	JpaDeadLetter.withDiagnostics(Metadata diagnostics)

Constructors in io.axoniq.framework.messaging.eventhandling.deadletter.jpa with parameters of type Metadata

Modifier	Constructor	Description
	DeadLetterEntry(String processingGroup, String sequenceIdentifier, long sequenceIndex, DeadLetterEventEntry message, Instant enqueuedAt, Instant lastTouched, Cause cause, Metadata diagnostics, Converter converter)	Creates a new DeadLetterEntry consisting of the given parameters.
	JpaDeadLetter(DeadLetterEntry entry, Metadata diagnostics, M message, Context context)	Constructs a new JpaDeadLetter from a DeadLetterEntry, deserialized diagnostics and a reconstructed message entry containing both the message and its associated context.

Uses of Metadata in io.axoniq.framework.tracing.micrometer.propagator

Methods in io.axoniq.framework.tracing.micrometer.propagator with parameters of type Metadata

Modifier and Type	Method	Description
@Nullable String	MetadataPropagatorGetter.get(Metadata carrier, String key)

Uses of Metadata in io.axoniq.framework.workflow.dsl.simple

Methods in io.axoniq.framework.workflow.dsl.simple with parameters of type Metadata

Modifier and Type	Method	Description
void	SimpleWorkflowContext.awaitPublish(String stepName, Object payload, Metadata metadata)	Publishes a business event given as payload and metadata and blocks until the step is recorded.
WorkflowStepResult	SimpleWorkflowContext.publish(String stepName, Object payload, Metadata metadata)	Publishes a business event given as payload and metadata.

Uses of Metadata in io.axoniq.framework.workflow.runtime.execution

Methods in io.axoniq.framework.workflow.runtime.execution with parameters of type Metadata

Modifier and Type	Method	Description
void	EventSourcedRunningWorkflows.evolve(Metadata metadata)	Applies workflow lifecycle metadata to this collection.

Uses of Metadata in io.axoniq.framework.workflow.runtime.util

Methods in io.axoniq.framework.workflow.runtime.util that return Metadata

Modifier and Type	Method	Description
static Metadata	MetadataUtils.create(String workflowId)	Creates a new metadata instance with the given workflow id.
static Metadata	MetadataUtils.create(String workflowId, WorkflowStatus workflowStatus)	Creates a new metadata instance with the given workflow id and workflow status.
static Metadata	MetadataUtils.create(String workflowId, WorkflowStatus workflowStatus, VersionedType workflowDefinitionId)	Creates a new metadata instance with the given workflow id, workflow status, and workflow definition id.
static Metadata	MetadataUtils.create(String workflowId, String stepName, StepStatus stepStatus)	Creates a new metadata instance with the given workflow id and step name.
static Metadata	MetadataUtils.createVersionMigrationStep(String workflowId, String changeId, String version)	Metadata for a version-marker event: a COMPLETED step event with stepName = changeId plus marker keys (versionChangeId, version) whose presence flags this as a version marker.
static Metadata	MetadataUtils.markWaitForEventStep(Metadata metadata)	Marks the given metadata as a step that is waiting for an event.
static Metadata	MetadataUtils.withWorkflowDefinitionId(Metadata metadata, VersionedType workflowDefinitionId)	Enriches metadata with the workflow definition id.

Methods in io.axoniq.framework.workflow.runtime.util that return types with arguments of type Metadata

Modifier and Type	Method	Description
static Predicate<Metadata>	MetadataUtils.hasWorkflowId()	Predicate that matches metadata that contain a workflow id.
static Predicate<Metadata>	MetadataUtils.workflowIdFilter(String workflowId)	Returns a predicate that matches metadata with the given workflow id.

Methods in io.axoniq.framework.workflow.runtime.util with parameters of type Metadata

Modifier and Type	Method	Description
static String	MetadataUtils.getStepName(Metadata metadata)	Returns the step name from the metadata.
static Optional<StepStatus>	MetadataUtils.getStepStatus(Metadata metadata)	Returns the step status if present in the metadata.
static Optional<String>	MetadataUtils.getVersion(Metadata metadata)	Returns the version if present in the metadata.
static Optional<String>	MetadataUtils.getVersionChangeId(Metadata metadata)	Returns the version change id if present in the metadata.
static Optional<VersionedType>	MetadataUtils.getWorkflowDefinitionId(Metadata metadata)	Returns the workflow definition id if present in the metadata.
static String	MetadataUtils.getWorkflowId(Metadata metadata)	Returns the workflow id from the metadata.
static Optional<WorkflowStatus>	MetadataUtils.getWorkflowStatus(Metadata metadata)	Returns the workflow status if present in the metadata.
static boolean	MetadataUtils.isPublishStep(Metadata metadata)	Checks whether the metadata marks a publish step.
static boolean	MetadataUtils.isVersionMigrationStep(Metadata metadata)	Returns whether the given metadata carries a version marker.
static boolean	MetadataUtils.isWaitForEventStep(Metadata metadata)	Returns whether the given metadata carries a step that is waiting for an event.
static Metadata	MetadataUtils.markWaitForEventStep(Metadata metadata)	Marks the given metadata as a step that is waiting for an event.
static Optional<String>	MetadataUtils.payloadReducer(Metadata metadata)	Returns the payload reducer if present in the metadata.
static Metadata	MetadataUtils.withWorkflowDefinitionId(Metadata metadata, VersionedType workflowDefinitionId)	Enriches metadata with the workflow definition id.

Uses of Metadata in org.axonframework.deadline

Methods in org.axonframework.deadline that return Metadata

Modifier and Type	Method	Description
Metadata	StoredDeadlineConverter.metadata(@Nullable Object data)	Converts the given stored metadata into Metadata.

Uses of Metadata in org.axonframework.messaging.commandhandling.gateway

Methods in org.axonframework.messaging.commandhandling.gateway with parameters of type Metadata

Modifier and Type	Method	Description
CommandResult	CommandDispatcher.send(Object command, Metadata metadata)	Sends the given command with the given metadata and returns a CommandResult immediately, without waiting for the command to execute.
default <R> CompletableFuture<R>	CommandGateway.send(Object command, Class<R> resultType, Metadata metadata, @Nullable ProcessingContext context)	Sends the given command with the given metadata in the provided context (if available) and returns a CompletableFuture immediately, without waiting for the command to execute.
default CommandResult	CommandGateway.send(Object command, Metadata metadata)	Sends the given command with the given metadata and returns a CommandResult immediately, without waiting for the command to execute.
CommandResult	CommandGateway.send(Object command, Metadata metadata, @Nullable ProcessingContext context)	Sends the given command with the given metadata in the provided context (if available) and returns a CommandResult immediately, without waiting for the command to execute.
CommandResult	ContextAwareCommandDispatcher.send(Object command, Metadata metadata)
CommandResult	ConvertingCommandGateway.send(Object command, Metadata metadata, @Nullable ProcessingContext context)
CommandResult	DefaultCommandGateway.send(Object command, Metadata metadata, @Nullable ProcessingContext context)
default <R> @Nullable R	CommandGateway.sendAndWait(Object command, Class<R> resultType, Metadata metadata, @Nullable ProcessingContext context)	Send the given command with the given metadata in the provided context (if available) and waits for the result converted to the resultType.

Uses of Metadata in org.axonframework.messaging.core

Methods in org.axonframework.messaging.core that return Metadata

Modifier and Type	Method	Description
Metadata	Metadata.and(String key, @Nullable String value)	Returns a Metadata instance containing the current entries, and the given key and given value.
Metadata	Metadata.andIfNotPresent(String key, Supplier<String> value)	Returns a Metadata instance containing the current entries, and the given key if it was not yet present in this Metadata.
static Metadata	Metadata.emptyInstance()	Returns an empty Metadata instance.
static Metadata	Metadata.from(@Nullable Map<String,@Nullable String> metadataEntries)	Creates a new Metadata instance from the given metadataEntries.
Metadata	Metadata.mergedWith(Map<String,@Nullable String> additionalEntries)	Returns a Metadata instance containing values of this, combined with the given additionalEntries.
Metadata	GenericMessage.metadata()
Metadata	Message.metadata()	Returns the Metadata for this Message.
Metadata	MessageDecorator.metadata()
Metadata	Metadata.subset(String... keys)	Returns a Metadata instance containing a subset of the keys in this instance.
static Metadata	Metadata.with(String key, @Nullable String value)	Creates a Metadata instance with a single entry from the given key and given value.
Metadata	Metadata.withoutKeys(Set<String> keys)	Returns a Metadata instance for which the entries with given keys are removed.

Methods in org.axonframework.messaging.core with parameters of type Metadata

Modifier and Type	Method	Description
protected abstract Message	AbstractMessage.withMetadata(Metadata metadata)	Returns a new message instance with the same payload and properties as this message but given metadata.
protected Message	GenericMessage.withMetadata(Metadata metadata)

Uses of Metadata in org.axonframework.messaging.eventhandling.gateway

Methods in org.axonframework.messaging.eventhandling.gateway with parameters of type Metadata

Modifier and Type	Method	Description
default void	EventAppender.append(Object event, Metadata metadata)	Append a single event to the event store in the current ProcessingContext with the given Metadata.
void	EventAppender.append(List<?> events, Metadata metadata)	Append a collection of events to the event store in the current ProcessingContext, all with the given Metadata.
void	ProcessingContextEventAppender.append(List<?> events, Metadata metadata)

Uses of Metadata in org.axonframework.messaging.queryhandling.gateway

Methods in org.axonframework.messaging.queryhandling.gateway with parameters of type Metadata

Modifier and Type	Method	Description
<R> CompletableFuture<R>	DefaultQueryGateway.query(Object query, Class<R> responseType, Metadata metadata, @Nullable ProcessingContext context)
default <R> CompletableFuture<R>	QueryGateway.query(Object query, Class<R> responseType, Metadata metadata, @Nullable ProcessingContext context)	Sends given query with the given metadata in the provided context (if available) over the QueryBus, expecting a single response with the given responseType from a single source.
<R> CompletableFuture<List<R>>	DefaultQueryGateway.queryMany(Object query, Class<R> responseType, Metadata metadata, @Nullable ProcessingContext context)
default <R> CompletableFuture<List<R>>	QueryGateway.queryMany(Object query, Class<R> responseType, Metadata metadata, @Nullable ProcessingContext context)	Sends given query with the given metadata in the provided context (if available) over the QueryBus, expecting multiple responses in the form of responseType from a single source.
<R> org.reactivestreams.Publisher<R>	DefaultQueryGateway.streamingQuery(Object query, Class<R> responseType, Metadata metadata, @Nullable ProcessingContext context)
default <R> org.reactivestreams.Publisher<R>	QueryGateway.streamingQuery(Object query, Class<R> responseType, Metadata metadata, @Nullable ProcessingContext context)	Sends given query with the given metadata in the provided context (if available) over the QueryBus, expecting a response as a Publisher of responseType.
<R> org.reactivestreams.Publisher<R>	DefaultQueryGateway.subscriptionQuery(Object query, Class<R> responseType, Metadata metadata, @Nullable ProcessingContext context, int updateBufferSize)
default <R> org.reactivestreams.Publisher<R>	QueryGateway.subscriptionQuery(Object query, Class<R> responseType, Metadata metadata, @Nullable ProcessingContext context, int updateBufferSize)	Sends given query with the given metadata over the QueryBus as a subscription query, combining the initial result and emitted update as a Publisher of the given responseType.

Uses of Metadata in org.axonframework.test.fixture

Methods in org.axonframework.test.fixture with parameters of type Metadata

Modifier and Type	Method	Description
AxonTestPhase.Given	AxonTestPhase.Given.command(Object payload, Metadata metadata)	Configures a single command with the given metadata as part of the "given" state.
AxonTestPhase.When.Command	AxonTestPhase.When.command(Object payload, Metadata metadata)	Dispatches the given command with the provided metadata to the appropriate command handler and records all activity for result validation.
AxonTestPhase.Given	AxonTestPhase.Given.event(Object payload, Metadata metadata)	Configures a single event with the given metadata as part of the "given" state.
AxonTestPhase.When.Event	AxonTestPhase.When.event(Object payload, Metadata metadata)	Publishes the given event with the provided metadata to the appropriate event handler and records all activity for result validation.

Uses of Metadata in org.axonframework.test.util

Methods in org.axonframework.test.util with parameters of type Metadata

Modifier and Type	Method	Description
Object	CallbackBehavior.handle(Object commandPayload, Metadata commandMetadata)	Invoked when the Command Bus receives a Command that is dispatched with a Callback method.
Object	DefaultCallbackBehavior.handle(Object commandPayload, Metadata commandMetadata)