Package io.fluxcapacitor.javaclient.configuration

Interface FluxCapacitorBuilder

All Superinterfaces:

FluxCapacitorConfiguration

All Known Implementing Classes:

DefaultFluxCapacitor.Builder

public interface FluxCapacitorBuilder
extends FluxCapacitorConfiguration

Builder interface for constructing a FluxCapacitor instance.

This interface exposes advanced configuration hooks for customizing message handling, dispatch behavior, serialization, user resolution, correlation tracking, and many other aspects of a Flux Capacitor client. It is primarily used via DefaultFluxCapacitor but can be extended or wrapped for deeper integrations.

Method Summary

Modifier and Type	Method	Description
FluxCapacitorBuilder	addBatchInterceptor(BatchInterceptor interceptor, MessageType... forTypes)	Registers a BatchInterceptor that applies to the given message types.
FluxCapacitorBuilder	addConsumerConfiguration(ConsumerConfiguration consumerConfiguration, MessageType... messageTypes)	Adds a specific consumer configuration for one or more message types.
FluxCapacitorBuilder	addDispatchInterceptor(DispatchInterceptor interceptor, boolean highPriority, MessageType... forTypes)	Adds a DispatchInterceptor for specified message types with optional priority.
default FluxCapacitorBuilder	addDispatchInterceptor(DispatchInterceptor interceptor, MessageType... forTypes)	Adds a DispatchInterceptor that modifies or monitors message dispatch.
FluxCapacitorBuilder	addHandlerDecorator(HandlerDecorator decorator, boolean highPriority, MessageType... forTypes)	Adds a HandlerDecorator with control over priority.
default FluxCapacitorBuilder	addHandlerDecorator(HandlerDecorator decorator, MessageType... forTypes)	Adds a HandlerDecorator for the given message types.
default FluxCapacitorBuilder	addHandlerInterceptor(HandlerInterceptor interceptor, boolean highPriority, MessageType... forTypes)	Adds a HandlerInterceptor with specified priority.
default FluxCapacitorBuilder	addHandlerInterceptor(HandlerInterceptor interceptor, MessageType... forTypes)	Adds a HandlerInterceptor for given message types.
FluxCapacitorBuilder	addParameterResolver(ParameterResolver<? super DeserializingMessage> parameterResolver)	Registers a ParameterResolver to support injection of method arguments in handlers.
default FluxCapacitorBuilder	addPropertySource(PropertySource propertySource)	Adds a PropertySource to the configuration chain.
FluxCapacitor	build(Client client)	Builds the FluxCapacitor instance using the provided low-level Client.
FluxCapacitorBuilder	configureDefaultConsumer(MessageType messageType, UnaryOperator<ConsumerConfiguration> updateFunction)	Update the default consumer configuration for the specified message type.
FluxCapacitorBuilder	disableAdhocDispatchInterceptor()	Disables support for dynamically injected dispatch interceptors.
FluxCapacitorBuilder	disableAutomaticAggregateCaching()	Disables automatic caching of aggregates.
FluxCapacitorBuilder	disableCacheEvictionMetrics()	Disables metrics related to cache eviction.
FluxCapacitorBuilder	disableDataProtection()	Disables security filtering based on @FilterContent.
FluxCapacitorBuilder	disableErrorReporting()	Disables automatic error reporting (e.g., via ErrorGateway).
FluxCapacitorBuilder	disableMessageCorrelation()	Disables automatic message correlation.
FluxCapacitorBuilder	disablePayloadValidation()	Disables payload validation.
FluxCapacitorBuilder	disableScheduledCommandHandler()	Prevents installation of the default scheduled command handler.
FluxCapacitorBuilder	disableShutdownHook()	Prevents registration of a shutdown hook.
FluxCapacitorBuilder	disableTrackingMetrics()	Disables tracking of processing metrics.
FluxCapacitorBuilder	disableWebResponseCompression()	Disables compression for web responses.
default FluxCapacitorBuilder	forwardWebRequestsToLocalServer(int port)	Forwards incoming MessageType.WEBREQUEST messages to a locally running HTTP server on the specified port.
FluxCapacitorBuilder	forwardWebRequestsToLocalServer(LocalServerConfig localServerConfig, UnaryOperator<ConsumerConfiguration> consumerConfigurator)	Configures forwarding of MessageType.WEBREQUEST messages to a local HTTP server using the specified LocalServerConfig and custom consumer configuration.
FluxCapacitorBuilder	makeApplicationInstance(boolean makeApplicationInstance)	Marks the built instance as the global (application-level) FluxCapacitor.
FluxCapacitorBuilder	registerUserProvider(UserProvider userProvider)	Registers a user provider used for resolving and authenticating User instances.
FluxCapacitorBuilder	replaceCache(Cache cache)	Replaces the default cache implementation.
FluxCapacitorBuilder	replaceCorrelationDataProvider(UnaryOperator<CorrelationDataProvider> correlationDataProvider)	Replaces the CorrelationDataProvider used to attach correlation data to messages.
FluxCapacitorBuilder	replaceDefaultResponseMapper(ResponseMapper responseMapper)	Replaces the default response mapper used for generic result mapping.
FluxCapacitorBuilder	replaceDocumentSerializer(DocumentSerializer documentSerializer)	Replaces the document serializer for search indexing.
FluxCapacitorBuilder	replaceIdentityProvider(UnaryOperator<IdentityProvider> replaceFunction)	Replaces the identity provider used to generate message and entity identifiers.
FluxCapacitorBuilder	replaceMessageRoutingInterceptor(DispatchInterceptor messageRoutingInterceptor)	Replaces the default routing interceptor used for message dispatch.
FluxCapacitorBuilder	replacePropertySource(UnaryOperator<PropertySource> replacer)	Replaces the existing property source.
FluxCapacitorBuilder	replaceRelationshipsCache(UnaryOperator<Cache> replaceFunction)	Replaces the internal relationships cache with a new implementation.
FluxCapacitorBuilder	replaceSerializer(Serializer serializer)	Replaces the default serializer used for events, commands, snapshots, and documents.
FluxCapacitorBuilder	replaceSnapshotSerializer(Serializer serializer)	Overrides the serializer used specifically for snapshot serialization.
FluxCapacitorBuilder	replaceTaskScheduler(Function<Clock,TaskScheduler> function)	Replaces the default TaskScheduler implementation.
FluxCapacitorBuilder	replaceWebResponseMapper(WebResponseMapper webResponseMapper)	Replaces the WebResponseMapper used for handling web responses.
FluxCapacitorBuilder	withAggregateCache(Class<?> aggregateType, Cache cache)	Configures a dedicated cache for a specific aggregate type.

Methods inherited from interface io.fluxcapacitor.javaclient.configuration.FluxCapacitorConfiguration

cache, clock, correlationDataProvider, customConsumerConfigurations, customParameterResolvers, defaultConsumerConfigurations, defaultResponseMapper, documentSerializer, forwardingWebConsumer, generalBatchInterceptors, highPrioDispatchInterceptors, highPrioHandlerDecorators, identityProvider, lowPrioDispatchInterceptors, lowPrioHandlerDecorators, makeApplicationInstance, messageRoutingInterceptor, propertySource, relationshipsCache, schedulingInterceptor, serializer, snapshotSerializer, taskScheduler, userProvider, webResponseMapper

Method Details

configureDefaultConsumer

FluxCapacitorBuilder configureDefaultConsumer(MessageType messageType,
 UnaryOperator<ConsumerConfiguration> updateFunction)

Update the default consumer configuration for the specified message type.

addConsumerConfiguration

FluxCapacitorBuilder addConsumerConfiguration(ConsumerConfiguration consumerConfiguration,
 MessageType... messageTypes)

Adds a specific consumer configuration for one or more message types.

addBatchInterceptor

FluxCapacitorBuilder addBatchInterceptor(BatchInterceptor interceptor,
 MessageType... forTypes)

Registers a BatchInterceptor that applies to the given message types.

addDispatchInterceptor

default FluxCapacitorBuilder addDispatchInterceptor(DispatchInterceptor interceptor,
 MessageType... forTypes)

Adds a DispatchInterceptor that modifies or monitors message dispatch. Shortcut for highPriority = false.

addDispatchInterceptor

FluxCapacitorBuilder addDispatchInterceptor(DispatchInterceptor interceptor,
 boolean highPriority,
 MessageType... forTypes)

Adds a DispatchInterceptor for specified message types with optional priority.

addHandlerInterceptor

default FluxCapacitorBuilder addHandlerInterceptor(HandlerInterceptor interceptor,
 MessageType... forTypes)

Adds a HandlerInterceptor for given message types.

addHandlerInterceptor

default FluxCapacitorBuilder addHandlerInterceptor(HandlerInterceptor interceptor,
 boolean highPriority,
 MessageType... forTypes)

Adds a HandlerInterceptor with specified priority.

addHandlerDecorator

default FluxCapacitorBuilder addHandlerDecorator(HandlerDecorator decorator,
 MessageType... forTypes)

Adds a HandlerDecorator for the given message types.

addHandlerDecorator

FluxCapacitorBuilder addHandlerDecorator(HandlerDecorator decorator,
 boolean highPriority,
 MessageType... forTypes)

Adds a HandlerDecorator with control over priority.

replaceMessageRoutingInterceptor

FluxCapacitorBuilder replaceMessageRoutingInterceptor(DispatchInterceptor messageRoutingInterceptor)

Replaces the default routing interceptor used for message dispatch.

replaceCache

FluxCapacitorBuilder replaceCache(Cache cache)

Replaces the default cache implementation.

forwardWebRequestsToLocalServer

default FluxCapacitorBuilder forwardWebRequestsToLocalServer(int port)

Forwards incoming MessageType.WEBREQUEST messages to a locally running HTTP server on the specified port.

This allows applications to handle web requests using their own HTTP server rather than Flux Capacitor’s message-based @HandleWeb infrastructure.

Note: This feature pushes requests to the local server and bypasses Flux’s pull-based dispatch model. Its use is discouraged unless integration with an existing HTTP stack is required.

Parameters:

port - the port on which the local HTTP server is listening

Returns:

this builder instance

See Also:

• forwardWebRequestsToLocalServer(LocalServerConfig, UnaryOperator)
• ForwardingWebConsumer

forwardWebRequestsToLocalServer

FluxCapacitorBuilder forwardWebRequestsToLocalServer(LocalServerConfig localServerConfig,
 UnaryOperator<ConsumerConfiguration> consumerConfigurator)

Configures forwarding of MessageType.WEBREQUEST messages to a local HTTP server using the specified LocalServerConfig and custom consumer configuration.

This mechanism is useful for advanced integration scenarios but bypasses Flux's pull-based message tracking. Prefer native @HandleWeb handlers when possible.

Parameters:

localServerConfig - configuration for the local server (e.g., port, error behavior)

consumerConfigurator - function to customize the underlying ConsumerConfiguration

Returns:

this builder instance

See Also:

• ForwardingWebConsumer

replaceDefaultResponseMapper

FluxCapacitorBuilder replaceDefaultResponseMapper(ResponseMapper responseMapper)

Replaces the default response mapper used for generic result mapping.

replaceWebResponseMapper

FluxCapacitorBuilder replaceWebResponseMapper(WebResponseMapper webResponseMapper)

Replaces the WebResponseMapper used for handling web responses.

replaceTaskScheduler

FluxCapacitorBuilder replaceTaskScheduler(Function<Clock,TaskScheduler> function)

Replaces the default TaskScheduler implementation.

withAggregateCache

FluxCapacitorBuilder withAggregateCache(Class<?> aggregateType,
 Cache cache)

Configures a dedicated cache for a specific aggregate type.

replaceRelationshipsCache

FluxCapacitorBuilder replaceRelationshipsCache(UnaryOperator<Cache> replaceFunction)

Replaces the internal relationships cache with a new implementation.

replaceIdentityProvider

FluxCapacitorBuilder replaceIdentityProvider(UnaryOperator<IdentityProvider> replaceFunction)

Replaces the identity provider used to generate message and entity identifiers.

addParameterResolver

FluxCapacitorBuilder addParameterResolver(ParameterResolver<? super DeserializingMessage> parameterResolver)

Registers a ParameterResolver to support injection of method arguments in handlers.

replaceSerializer

FluxCapacitorBuilder replaceSerializer(Serializer serializer)

Replaces the default serializer used for events, commands, snapshots, and documents.

replaceCorrelationDataProvider

FluxCapacitorBuilder replaceCorrelationDataProvider(UnaryOperator<CorrelationDataProvider> correlationDataProvider)

Replaces the CorrelationDataProvider used to attach correlation data to messages.

replaceSnapshotSerializer

FluxCapacitorBuilder replaceSnapshotSerializer(Serializer serializer)

Overrides the serializer used specifically for snapshot serialization.

replaceDocumentSerializer

FluxCapacitorBuilder replaceDocumentSerializer(DocumentSerializer documentSerializer)

Replaces the document serializer for search indexing.

registerUserProvider

FluxCapacitorBuilder registerUserProvider(UserProvider userProvider)

Registers a user provider used for resolving and authenticating User instances.

addPropertySource

default FluxCapacitorBuilder addPropertySource(PropertySource propertySource)

Adds a PropertySource to the configuration chain.

replacePropertySource

FluxCapacitorBuilder replacePropertySource(UnaryOperator<PropertySource> replacer)

Replaces the existing property source.

disableErrorReporting

FluxCapacitorBuilder disableErrorReporting()

Disables automatic error reporting (e.g., via ErrorGateway).

disableShutdownHook

FluxCapacitorBuilder disableShutdownHook()

Prevents registration of a shutdown hook.

disableMessageCorrelation

FluxCapacitorBuilder disableMessageCorrelation()

Disables automatic message correlation.

disablePayloadValidation

FluxCapacitorBuilder disablePayloadValidation()

Disables payload validation.

disableDataProtection

FluxCapacitorBuilder disableDataProtection()

Disables security filtering based on @FilterContent.

disableAutomaticAggregateCaching

FluxCapacitorBuilder disableAutomaticAggregateCaching()

Disables automatic caching of aggregates.

disableScheduledCommandHandler

FluxCapacitorBuilder disableScheduledCommandHandler()

Prevents installation of the default scheduled command handler.

disableTrackingMetrics

FluxCapacitorBuilder disableTrackingMetrics()

Disables tracking of processing metrics.

disableCacheEvictionMetrics

FluxCapacitorBuilder disableCacheEvictionMetrics()

Disables metrics related to cache eviction.

disableWebResponseCompression

FluxCapacitorBuilder disableWebResponseCompression()

Disables compression for web responses.

disableAdhocDispatchInterceptor

FluxCapacitorBuilder disableAdhocDispatchInterceptor()

Disables support for dynamically injected dispatch interceptors.

makeApplicationInstance

FluxCapacitorBuilder makeApplicationInstance(boolean makeApplicationInstance)

Marks the built instance as the global (application-level) FluxCapacitor.

build

FluxCapacitor build(Client client)

Builds the FluxCapacitor instance using the provided low-level Client.