Package io.axoniq.framework.workflow.runtime.execution

Class SimpleWorkflowConfigurationRegistry

java.lang.Object

io.axoniq.framework.workflow.runtime.execution.SimpleWorkflowConfigurationRegistry

All Implemented Interfaces:

WorkflowConfigurationRegistry<SimpleWorkflowConfigurationRegistry>, DescribableComponent

public class SimpleWorkflowConfigurationRegistry
extends Object
implements WorkflowConfigurationRegistry<SimpleWorkflowConfigurationRegistry>

In-memory workflow definition registry implementation.

Since:

5.4.0

Author:

Simon Zambrovski

Nested Class Summary

Nested classes/interfaces inherited from interface io.axoniq.framework.workflow.runtime.execution.WorkflowConfigurationRegistry

WorkflowConfigurationRegistry.PredicatedWorkflowConfiguration, WorkflowConfigurationRegistry.RoutingLog

Field Summary

Fields inherited from interface io.axoniq.framework.workflow.runtime.execution.WorkflowConfigurationRegistry

RESOURCE_KEY

Constructor Summary

Constructors

Constructor	Description
SimpleWorkflowConfigurationRegistry()

Method Summary

Modifier and Type	Method	Description
void	describeTo(ComponentDescriptor descriptor)	Describe the properties of this DescribableComponent with the given descriptor.
List<WorkflowConfigurationRegistry.PredicatedWorkflowConfiguration>	getHighestVersionConfigurations(MessageType type)	Returns the configurations registered for the given event type whose WorkflowConfiguration.workflowVersion() is the highest among all registrations (semver-ordered).
List<WorkflowConfigurationRegistry.PredicatedWorkflowConfiguration>	getHighestVersionConfigurations(QualifiedName qualifiedName)	Returns the configurations registered for qualifiedName whose WorkflowConfiguration.workflowVersion() is the highest among all registrations (semver-ordered).
List<WorkflowConfigurationRegistry.PredicatedWorkflowConfiguration>	getWorkflowsConfigurations(QualifiedName qualifiedName)
SimpleWorkflowConfigurationRegistry	register(EventCondition eventCondition, WorkflowConfiguration<?> workflowConfiguration)
Set<QualifiedName>	supportedEvents()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.axoniq.framework.workflow.runtime.execution.WorkflowConfigurationRegistry

findByWorkflowNameAndVersion, findClosestHigherRegisteredVersion, findClosestRegisteredVersion, getByVersion, getWorkflowConfiguration, register, registeredVersions, resolveDefinitionForReplay, warnAboutSameVersionDuplicates

Constructor Details

SimpleWorkflowConfigurationRegistry

public SimpleWorkflowConfigurationRegistry()

Method Details

register

public SimpleWorkflowConfigurationRegistry register(EventCondition eventCondition,
 WorkflowConfiguration<?> workflowConfiguration)

Specified by:

register in interface WorkflowConfigurationRegistry<SimpleWorkflowConfigurationRegistry>

getHighestVersionConfigurations

public List<WorkflowConfigurationRegistry.PredicatedWorkflowConfiguration> getHighestVersionConfigurations(MessageType type)

Returns the configurations registered for the given event type whose WorkflowConfiguration.workflowVersion() is the highest among all registrations (semver-ordered). Multiple configurations may be returned if duplicates exist at that version (run-in-parallel semantics).

This is the lookup event-driven callers use, so the event's type reaches the registry whole. It is currently decided on MessageType.qualifiedName() alone, and taking the full type keeps MessageType.version() in reach for when it participates in the decision.

The memoized lookup is keyed by MessageType.qualifiedName(), as the event's version does not select a configuration yet. Taking the whole type here keeps MessageType.version() in reach of the lookup for when it does.

Specified by:

getHighestVersionConfigurations in interface WorkflowConfigurationRegistry<SimpleWorkflowConfigurationRegistry>

getHighestVersionConfigurations

public List<WorkflowConfigurationRegistry.PredicatedWorkflowConfiguration> getHighestVersionConfigurations(QualifiedName qualifiedName)

Description copied from interface: WorkflowConfigurationRegistry

Returns the configurations registered for qualifiedName whose WorkflowConfiguration.workflowVersion() is the highest among all registrations (semver-ordered). Multiple configurations may be returned if duplicates exist at that version (run-in-parallel semantics).

Event-driven callers should use WorkflowConfigurationRegistry.getHighestVersionConfigurations(MessageType); this variant serves registration-time recomputation, where only a QualifiedName exists.

Specified by:

getHighestVersionConfigurations in interface WorkflowConfigurationRegistry<SimpleWorkflowConfigurationRegistry>

supportedEvents

public Set<QualifiedName> supportedEvents()

Specified by:

supportedEvents in interface WorkflowConfigurationRegistry<SimpleWorkflowConfigurationRegistry>

getWorkflowsConfigurations

public List<WorkflowConfigurationRegistry.PredicatedWorkflowConfiguration> getWorkflowsConfigurations(QualifiedName qualifiedName)

Specified by:

getWorkflowsConfigurations in interface WorkflowConfigurationRegistry<SimpleWorkflowConfigurationRegistry>

describeTo

public void describeTo(ComponentDescriptor descriptor)

Description copied from interface: DescribableComponent

Describe the properties of this DescribableComponent with the given descriptor.

Components should call the appropriate describeProperty methods on the descriptor to register their properties. The descriptor is responsible for determining how these properties are formatted and structured in the final output.

Best Practices: As a general rule, all relevant fields of a DescribableComponent implementation should be described in this method. However, developers have discretion to include only the fields that make sense in the context. Not every field may be meaningful for description purposes, especially internal implementation details. Furthermore, components might want to expose different information based on their current state. The final decision on what properties to include lies with the person implementing the describeTo method, who should focus on providing information that is useful for understanding the component's configuration and state.

Example implementation:

 public void describeTo(ComponentDescriptor descriptor) {
     descriptor.describeProperty("name", this.name);
     descriptor.describeProperty("enabled", this.enabled);
     descriptor.describeProperty("configuration", this.configuration); // A nested component
     descriptor.describeProperty("handlers", this.eventHandlers);      // A collection
 }
 

Specified by:

describeTo in interface DescribableComponent

Parameters:

descriptor - The component descriptor to describe this DescribableComponentn its properties in.