Package io.fluxcapacitor.javaclient.configuration.spring

Class FluxCapacitorSpringConfig

java.lang.Object

io.fluxcapacitor.javaclient.configuration.spring.FluxCapacitorSpringConfig

All Implemented Interfaces:

org.springframework.beans.factory.config.BeanPostProcessor

@Configuration
public class FluxCapacitorSpringConfig
extends Object
implements org.springframework.beans.factory.config.BeanPostProcessor

Spring configuration class for automatically wiring and initializing common Flux Capacitor components in a Spring application context.

This configuration simplifies the integration of Flux Capacitor by:

• Registering @Handle... annotated beans as handlers after the context is refreshed
• Auto-detecting and registering upcasters and downcasters with the Serializer
• Providing default implementations for core interfaces like CommandGateway, Serializer, and MessageScheduler

Note that Flux Capacitor does not require Spring, and this class is entirely optional. It exists purely to reduce boilerplate in Spring-based applications.

The simplest way to enable this configuration in a Spring Boot application, is by annotating your main application class with:

 @SpringBootApplication
 @Import(FluxCapacitorSpringConfig.class)
 

See Also:

• FluxCapacitor
• FluxCapacitorBuilder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FluxCapacitorSpringConfig(org.springframework.context.ApplicationContext context)	Stores a reference to the Spring context and prepares for handler detection.

Method Summary

Modifier and Type	Method	Description
AggregateRepository	aggregateRepository(FluxCapacitor fluxCapacitor)
CommandGateway	commandGateway(FluxCapacitor fluxCapacitor)
DocumentStore	documentStore(FluxCapacitor fluxCapacitor)
ErrorGateway	errorGateway(FluxCapacitor fluxCapacitor)
EventGateway	eventGateway(FluxCapacitor fluxCapacitor)
FluxCapacitor	fluxCapacitor(FluxCapacitorBuilder builder, List<FluxCapacitorCustomizer> customizers)	Constructs the FluxCapacitor instance if no FluxCapacitor bean exists, preferring a user-provided Client or falling back to either a WebSocketClient or LocalClient depending on presence of configuration properties.
FluxCapacitorBuilder	fluxCapacitorBuilder(Serializer serializer, Optional<UserProvider> userProvider, Optional<Cache> cache, Optional<WebResponseMapper> webResponseMapper, org.springframework.core.env.Environment environment)	Provides a default FluxCapacitorBuilder, configured using Spring-provided components such as UserProvider, Cache, and WebResponseMapper.
protected <T> Optional<T>	getBean(Class<T> type)
void	handle(org.springframework.context.event.ContextRefreshedEvent event)	Registers all discovered Spring beans as Flux Capacitor handlers once the application context is refreshed.
KeyValueStore	keyValueStore(FluxCapacitor fluxCapacitor)
MetricsGateway	metricsGateway(FluxCapacitor fluxCapacitor)
Object	postProcessAfterInitialization(Object bean, String beanName)	Captures beans post-initialization to inspect later for handler registration.
QueryGateway	queryGateway(FluxCapacitor fluxCapacitor)
ResultGateway	resultGateway(FluxCapacitor fluxCapacitor)
MessageScheduler	scheduler(FluxCapacitor fluxCapacitor)
Serializer	serializer()	Optionally provides a default Serializer implementation based on Jackson, automatically detecting and registering upcasters and downcasters from Spring-managed beans.
static SocketEndpointPostProcessor	socketEndpointPostProcessor()	Registers the SocketEndpointPostProcessor, used for handlers that manage WebSocket communication.
static StatefulPostProcessor	statefulPostProcessor()	Registers the StatefulPostProcessor, enabling lifecycle and stateful behavior for beans.
static TrackSelfPostProcessor	trackSelfPostProcessor()	Registers the TrackSelfPostProcessor, which supports payload classes that track and handle their own type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.beans.factory.config.BeanPostProcessor

postProcessBeforeInitialization

Constructor Details

FluxCapacitorSpringConfig

@Autowired
protected FluxCapacitorSpringConfig(org.springframework.context.ApplicationContext context)

Stores a reference to the Spring context and prepares for handler detection.

Method Details

trackSelfPostProcessor

@Bean
public static TrackSelfPostProcessor trackSelfPostProcessor()

Registers the TrackSelfPostProcessor, which supports payload classes that track and handle their own type.

See Also:

• TrackSelf

statefulPostProcessor

@Bean
public static StatefulPostProcessor statefulPostProcessor()

Registers the StatefulPostProcessor, enabling lifecycle and stateful behavior for beans.

See Also:

• Stateful

socketEndpointPostProcessor

@Bean
public static SocketEndpointPostProcessor socketEndpointPostProcessor()

Registers the SocketEndpointPostProcessor, used for handlers that manage WebSocket communication.

See Also:

• SocketEndpoint

postProcessAfterInitialization

public Object postProcessAfterInitialization(Object bean,
 String beanName)
                                      throws org.springframework.beans.BeansException

Captures beans post-initialization to inspect later for handler registration. Prototype beans are handled specially.

Specified by:

postProcessAfterInitialization in interface org.springframework.beans.factory.config.BeanPostProcessor

Throws:

org.springframework.beans.BeansException

handle

@EventListener
public void handle(org.springframework.context.event.ContextRefreshedEvent event)

Registers all discovered Spring beans as Flux Capacitor handlers once the application context is refreshed. Also installs a default uncaught exception handler and starts the application context if needed.

serializer

@Bean
public Serializer serializer()

Optionally provides a default Serializer implementation based on Jackson, automatically detecting and registering upcasters and downcasters from Spring-managed beans.

This method is only invoked if no other Serializer bean is defined.

If a custom serializer is provided by the application, upcasters and downcasters must be registered explicitly.

Returns:

a Serializer configured with discovered casting logic

fluxCapacitorBuilder

@Bean
public FluxCapacitorBuilder fluxCapacitorBuilder(Serializer serializer,
 Optional<UserProvider> userProvider,
 Optional<Cache> cache,
 Optional<WebResponseMapper> webResponseMapper,
 org.springframework.core.env.Environment environment)

Provides a default FluxCapacitorBuilder, configured using Spring-provided components such as UserProvider, Cache, and WebResponseMapper. Automatically uses application properties via SpringPropertySource.

fluxCapacitor

@Bean
public FluxCapacitor fluxCapacitor(FluxCapacitorBuilder builder,
 List<FluxCapacitorCustomizer> customizers)

Constructs the FluxCapacitor instance if no FluxCapacitor bean exists, preferring a user-provided Client or falling back to either a WebSocketClient or LocalClient depending on presence of configuration properties.

aggregateRepository

@Bean
public AggregateRepository aggregateRepository(FluxCapacitor fluxCapacitor)

scheduler

@Bean
public MessageScheduler scheduler(FluxCapacitor fluxCapacitor)

commandGateway

@Bean
public CommandGateway commandGateway(FluxCapacitor fluxCapacitor)

eventGateway

@Bean
public EventGateway eventGateway(FluxCapacitor fluxCapacitor)

queryGateway

@Bean
public QueryGateway queryGateway(FluxCapacitor fluxCapacitor)

errorGateway

@Bean
public ErrorGateway errorGateway(FluxCapacitor fluxCapacitor)

metricsGateway

@Bean
public MetricsGateway metricsGateway(FluxCapacitor fluxCapacitor)

resultGateway

@Bean
public ResultGateway resultGateway(FluxCapacitor fluxCapacitor)

keyValueStore

@Bean
public KeyValueStore keyValueStore(FluxCapacitor fluxCapacitor)

documentStore

@Bean
public DocumentStore documentStore(FluxCapacitor fluxCapacitor)

getBean

protected <T> Optional<T> getBean(Class<T> type)