org.axonframework.deadline

Interface DeadlineManagerSpanFactory

All Known Implementing Classes:

DefaultDeadlineManagerSpanFactory

public interface DeadlineManagerSpanFactory

Span factory that creates spans for the DeadlineManager. You can customize the spans of the bus by creating your own implementation.

Since:

4.9.0

Author:

Mitchell Herrijgers

Method Summary

Modifier and Type	Method and Description
Span	createCancelAllSpan(String deadlineName) Creates a span that represents the cancellation of all deadlines with a certain name.
Span	createCancelAllWithinScopeSpan(String deadlineName, ScopeDescriptor scopeDescriptor) Creates a span that represents the cancellation of all deadlines with a certain name within a certain scope.
Span	createCancelScheduleSpan(String deadlineName, String deadlineId) Creates a span that represents the cancellation of a specific deadline.
Span	createExecuteSpan(String deadlineName, String deadlineId, DeadlineMessage<?> deadlineMessage) Creates a span that represents the execution of a deadline.
Span	createScheduleSpan(String deadlineName, String deadlineId, DeadlineMessage<?> deadlineMessage) Creates a span that represents the scheduling of a deadline.
<T> DeadlineMessage<T>	propagateContext(DeadlineMessage<T> deadlineMessage) Propagates the context of the current span to the given deadline message.

Method Detail

createScheduleSpan

Span createScheduleSpan(String deadlineName,
                        String deadlineId,
                        DeadlineMessage<?> deadlineMessage)

Creates a span that represents the scheduling of a deadline.

Parameters:

deadlineName - The name of the deadline.

deadlineId - The id of the deadline.

deadlineMessage - The message of the deadline.

Returns:

The created span.

createCancelScheduleSpan

Span createCancelScheduleSpan(String deadlineName,
                              String deadlineId)

Creates a span that represents the cancellation of a specific deadline.

Parameters:

deadlineName - The name of the deadline.

deadlineId - The id of the deadline.

Returns:

The created span.

createCancelAllSpan

Span createCancelAllSpan(String deadlineName)

Creates a span that represents the cancellation of all deadlines with a certain name.

Parameters:

deadlineName - The name of the deadlines.

Returns:

The created span.

createCancelAllWithinScopeSpan

Span createCancelAllWithinScopeSpan(String deadlineName,
                                    ScopeDescriptor scopeDescriptor)

Creates a span that represents the cancellation of all deadlines with a certain name within a certain scope.

Parameters:

deadlineName - The name of the deadlines.

scopeDescriptor - The scope descriptor of the deadlines.

Returns:

The created span.

createExecuteSpan

Span createExecuteSpan(String deadlineName,
                       String deadlineId,
                       DeadlineMessage<?> deadlineMessage)

Creates a span that represents the execution of a deadline.

Parameters:

deadlineName - The name of the deadline.

deadlineId - The id of the deadline.

deadlineMessage - The message of the deadline.

Returns:

The created span.

propagateContext

<T> DeadlineMessage<T> propagateContext(DeadlineMessage<T> deadlineMessage)

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

Type Parameters:

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

Parameters:

deadlineMessage - The deadline message to propagate the context to.

Returns:

The deadline message with the propagated context.