org.axonframework.deadline

Class DefaultDeadlineManagerSpanFactory

java.lang.Object

org.axonframework.deadline.DefaultDeadlineManagerSpanFactory

All Implemented Interfaces:

DeadlineManagerSpanFactory

public class DefaultDeadlineManagerSpanFactory
extends Object
implements DeadlineManagerSpanFactory

Default implementation of the DeadlineManagerSpanFactory. The attributes used for the id of the deadline and the scope of the deadline are configurable.

Since:

4.9.0

Author:

Mitchell Herrijgers

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DefaultDeadlineManagerSpanFactory.Builder	builder() Creates a new DefaultDeadlineManagerSpanFactory.Builder to build a DefaultDeadlineManagerSpanFactory with.
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> eventMessage) Propagates the context of the current span to the given deadline message.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDeadlineManagerSpanFactory

protected DefaultDeadlineManagerSpanFactory(DefaultDeadlineManagerSpanFactory.Builder builder)

Creates a new DefaultDeadlineManagerSpanFactory using the provided builder. The default values are:

• deadlineIdAttribute defaults to axon.deadlineId
• scopeAttribute defaults to axon.deadlineScope

The spanFactory is a required field and should be provided.

Parameters:

builder - The builder to build the DefaultDeadlineManagerSpanFactory from.

Method Detail

builder

public static DefaultDeadlineManagerSpanFactory.Builder builder()

Creates a new DefaultDeadlineManagerSpanFactory.Builder to build a DefaultDeadlineManagerSpanFactory with. The default values are:

• deadlineIdAttribute defaults to axon.deadlineId
• scopeAttribute defaults to axon.deadlineScope

The spanFactory is a required field and should be provided.

Returns:

The DefaultDeadlineManagerSpanFactory.Builder to build a DefaultDeadlineManagerSpanFactory with.

createScheduleSpan

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

Description copied from interface: DeadlineManagerSpanFactory

Creates a span that represents the scheduling of a deadline.

Specified by:

createScheduleSpan in interface DeadlineManagerSpanFactory

Parameters:

deadlineName - The name of the deadline.

deadlineId - The id of the deadline.

deadlineMessage - The message of the deadline.

Returns:

The created span.

createCancelScheduleSpan

public Span createCancelScheduleSpan(String deadlineName,
                                     String deadlineId)

Description copied from interface: DeadlineManagerSpanFactory

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

Specified by:

createCancelScheduleSpan in interface DeadlineManagerSpanFactory

Parameters:

deadlineName - The name of the deadline.

deadlineId - The id of the deadline.

Returns:

The created span.

createCancelAllSpan

public Span createCancelAllSpan(String deadlineName)

Description copied from interface: DeadlineManagerSpanFactory

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

Specified by:

createCancelAllSpan in interface DeadlineManagerSpanFactory

Parameters:

deadlineName - The name of the deadlines.

Returns:

The created span.

createCancelAllWithinScopeSpan

public Span createCancelAllWithinScopeSpan(String deadlineName,
                                           ScopeDescriptor scopeDescriptor)

Description copied from interface: DeadlineManagerSpanFactory

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

Specified by:

createCancelAllWithinScopeSpan in interface DeadlineManagerSpanFactory

Parameters:

deadlineName - The name of the deadlines.

scopeDescriptor - The scope descriptor of the deadlines.

Returns:

The created span.

createExecuteSpan

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

Description copied from interface: DeadlineManagerSpanFactory

Creates a span that represents the execution of a deadline.

Specified by:

createExecuteSpan in interface DeadlineManagerSpanFactory

Parameters:

deadlineName - The name of the deadline.

deadlineId - The id of the deadline.

deadlineMessage - The message of the deadline.

Returns:

The created span.

propagateContext

public <T> DeadlineMessage<T> propagateContext(DeadlineMessage<T> eventMessage)

Description copied from interface: DeadlineManagerSpanFactory

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

Specified by:

propagateContext in interface DeadlineManagerSpanFactory

Type Parameters:

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

Parameters:

eventMessage - The deadline message to propagate the context to.

Returns:

The deadline message with the propagated context.