org.axonframework.commandhandling

Class DefaultCommandBusSpanFactory

java.lang.Object

org.axonframework.commandhandling.DefaultCommandBusSpanFactory

All Implemented Interfaces:

CommandBusSpanFactory

public class DefaultCommandBusSpanFactory
extends Object
implements CommandBusSpanFactory

Default implementation of the CommandBusSpanFactory. Can be configured to include the command handling of a distributed command in the same trace or not (true by default).

Since:

4.9.0

Author:

Mitchell Herrijgers

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultCommandBusSpanFactory.Builder Builder class to instantiate a DefaultCommandBusSpanFactory.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultCommandBusSpanFactory(DefaultCommandBusSpanFactory.Builder builder) Creates a new DefaultCommandBusSpanFactory using the provided builder.

Method Summary

Modifier and Type	Method and Description
static DefaultCommandBusSpanFactory.Builder	builder() Creates a Builder to be able to create a DefaultCommandBusSpanFactory.
Span	createDispatchCommandSpan(CommandMessage<?> commandMessage, boolean distributed) Creates a span for the dispatching of a command.
Span	createHandleCommandSpan(CommandMessage<?> commandMessage, boolean distributed) Creates a span for the handling of a command.
<T> CommandMessage<T>	propagateContext(CommandMessage<T> commandMessage) Propagates the context of the current span to the given command message.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCommandBusSpanFactory

protected DefaultCommandBusSpanFactory(DefaultCommandBusSpanFactory.Builder builder)

Creates a new DefaultCommandBusSpanFactory using the provided builder.

Parameters:

builder - The builder to build the DefaultCommandBusSpanFactory from.

Method Detail

createDispatchCommandSpan

public Span createDispatchCommandSpan(CommandMessage<?> commandMessage,
                                      boolean distributed)

Description copied from interface: CommandBusSpanFactory

Creates a span for the dispatching of a command.

Specified by:

createDispatchCommandSpan in interface CommandBusSpanFactory

Parameters:

commandMessage - The command message to create a span for.

distributed - Whether the command is distributed or not.

Returns:

The created span.

createHandleCommandSpan

public Span createHandleCommandSpan(CommandMessage<?> commandMessage,
                                    boolean distributed)

Description copied from interface: CommandBusSpanFactory

Creates a span for the handling of a command.

Specified by:

createHandleCommandSpan in interface CommandBusSpanFactory

Parameters:

commandMessage - The command message to create a span for.

distributed - Whether the command is distributed or not.

Returns:

The created span.

propagateContext

public <T> CommandMessage<T> propagateContext(CommandMessage<T> commandMessage)

Description copied from interface: CommandBusSpanFactory

Propagates the context of the current span to the given command message.

Specified by:

propagateContext in interface CommandBusSpanFactory

Type Parameters:

T - The type of the payload of the command message.

Parameters:

commandMessage - The command message to propagate the context to.

Returns:

The command message with the propagated context.

builder

public static DefaultCommandBusSpanFactory.Builder builder()

Creates a Builder to be able to create a DefaultCommandBusSpanFactory. The default values are:

• distributedCommandInSameTrace defaults to true

The spanFactory is a required field and should be provided.

Returns:

a Builder to be able to create a DefaultCommandBusSpanFactory