Package org.axonframework.extension.spring.config

Class SpringSagaDescriptor

java.lang.Object

org.axonframework.extension.spring.config.SpringSagaDescriptor

All Implemented Interfaces:

EventProcessorDefinition.EventHandlerDescriptor, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

@Internal
public class SpringSagaDescriptor
extends Object
implements EventProcessorDefinition.EventHandlerDescriptor, org.springframework.context.ApplicationContextAware

Describes an Axon Framework 4 Saga discovered in a Spring application context, carrying everything SagaProcessorConfigurer needs to assemble that Saga's event processor.

Implements EventProcessorDefinition.EventHandlerDescriptor so that an EventProcessorDefinition's handler selector can pick a Saga the same way it picks an ordinary event handler bean. The Saga itself is assembled separately from ordinary handlers, though: see SagaProcessorConfigurer.

This class is internal wiring created by SpringSagaLookup. Spring discovers only the Saga type; Axon creates Saga instances itself, without applying Spring bean post-processors or injecting Saga fields.

Since:

5.4.0

Author:

Allard Buijze, Mateusz Nowak

Constructor Summary

Constructors

Constructor	Description
SpringSagaDescriptor(Class<?> sagaType)	Initializes a descriptor for the given Saga type.
SpringSagaDescriptor(String sagaBeanName, Class<?> sagaType, Supplier<org.springframework.beans.factory.config.BeanDefinition> sagaBeanDefinitionSupplier)	Initializes a descriptor for a discovered Saga bean.

Method Summary

Modifier and Type	Method	Description
org.springframework.beans.factory.config.BeanDefinition	beanDefinition()	Returns the Spring BeanDefinition for this event handler.
String	beanName()	Returns the Spring bean name of this event handler.
Class<?>	beanType()	Returns the Java type of this event handler bean.
ComponentBuilder<Object>	component()	Returns the component builder for this event handler.
Object	resolveBean()	Always throws, because a Saga has no single bean instance to resolve.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setSagaStore(String sagaStore)	Sets the name of the SagaStore bean the Sagas of this type are kept in.

Methods inherited from class java.lang.Object

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

Constructor Details

SpringSagaDescriptor

public SpringSagaDescriptor(Class<?> sagaType)

Initializes a descriptor for the given Saga type.

Parameters:

sagaType - the Saga type to configure

SpringSagaDescriptor

public SpringSagaDescriptor(String sagaBeanName,
 Class<?> sagaType,
 Supplier<org.springframework.beans.factory.config.BeanDefinition> sagaBeanDefinitionSupplier)

Initializes a descriptor for a discovered Saga bean.

Parameters:

sagaBeanName - the Spring bean name used for discovery and processor selectors

sagaType - the Saga type to configure

sagaBeanDefinitionSupplier - supplies the original Spring bean definition without making Spring treat it as an inner bean

Method Details

setSagaStore

public void setSagaStore(String sagaStore)

Sets the name of the SagaStore bean the Sagas of this type are kept in.

Parameters:

sagaStore - the name of the Saga store bean

beanName

public String beanName()

Description copied from interface: EventProcessorDefinition.EventHandlerDescriptor

Returns the Spring bean name of this event handler.

Specified by:

beanName in interface EventProcessorDefinition.EventHandlerDescriptor

Returns:

The bean name.

beanDefinition

public org.springframework.beans.factory.config.BeanDefinition beanDefinition()

Description copied from interface: EventProcessorDefinition.EventHandlerDescriptor

Returns the Spring BeanDefinition for this event handler.

Specified by:

beanDefinition in interface EventProcessorDefinition.EventHandlerDescriptor

Returns:

The bean definition.

beanType

public Class<?> beanType()

Description copied from interface: EventProcessorDefinition.EventHandlerDescriptor

Returns the Java type of this event handler bean.

Specified by:

beanType in interface EventProcessorDefinition.EventHandlerDescriptor

Returns:

The bean type.

resolveBean

public Object resolveBean()

Always throws, because a Saga has no single bean instance to resolve.

Spring never instantiates a Saga: instances are created and loaded per Saga identifier by the Saga manager. Returning a fresh throwaway instance here would look like the bean an EventProcessorDefinition selector asked for while belonging to no Saga at all. Select a Saga on beanName() or beanType() instead.

Specified by:

resolveBean in interface EventProcessorDefinition.EventHandlerDescriptor

Returns:

The event handler bean.

Throws:

UnsupportedOperationException - always

component

public ComponentBuilder<Object> component()

Description copied from interface: EventProcessorDefinition.EventHandlerDescriptor

Returns the component builder for this event handler.

Specified by:

component in interface EventProcessorDefinition.EventHandlerDescriptor

Returns:

The component builder.

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException