Package io.fluxcapacitor.javaclient.configuration

Class DefaultFluxCapacitor.Builder

java.lang.Object

io.fluxcapacitor.javaclient.configuration.DefaultFluxCapacitor.Builder

All Implemented Interfaces:

FluxCapacitorBuilder, FluxCapacitorConfiguration

Enclosing class:

DefaultFluxCapacitor

public static class DefaultFluxCapacitor.Builder
extends Object
implements FluxCapacitorBuilder

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
FluxCapacitorBuilder	addBatchInterceptor(BatchInterceptor interceptor, MessageType... forTypes)	Registers a BatchInterceptor that applies to the given message types.
DefaultFluxCapacitor.Builder	addConsumerConfiguration(@NonNull ConsumerConfiguration configuration, MessageType... messageTypes)	Adds a specific consumer configuration for one or more message types.
DefaultFluxCapacitor.Builder	addDispatchInterceptor(@NonNull DispatchInterceptor interceptor, boolean highPriority, MessageType... forTypes)	Adds a DispatchInterceptor for specified message types with optional priority.
DefaultFluxCapacitor.Builder	addHandlerDecorator(@NonNull HandlerDecorator interceptor, boolean highPriority, MessageType... forTypes)	Adds a HandlerDecorator with control over priority.
DefaultFluxCapacitor.Builder	addParameterResolver(@NonNull ParameterResolver<? super DeserializingMessage> parameterResolver)	Registers a ParameterResolver to support injection of method arguments in handlers.
FluxCapacitor	build(@NonNull Client client)	Builds the FluxCapacitor instance using the provided low-level Client.
DefaultFluxCapacitor.Builder	configureDefaultConsumer(@NonNull MessageType messageType, @NonNull UnaryOperator<ConsumerConfiguration> updateFunction)	Update the default consumer configuration for the specified message type.
protected GenericGateway	createRequestGateway(Client client, MessageType messageType, String topic, RequestHandler requestHandler, Map<MessageType,DispatchInterceptor> dispatchInterceptors, Map<MessageType,HandlerDecorator> handlerDecorators, List<ParameterResolver<? super DeserializingMessage>> parameterResolvers, Function<Class<?>,HandlerRepository> handlerRepositorySupplier, RepositoryProvider repositoryProvider, ResponseMapper responseMapper)
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).
DefaultFluxCapacitor.Builder	disableMessageCorrelation()	Disables automatic message correlation.
DefaultFluxCapacitor.Builder	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.
protected FluxCapacitor	doBuild(Map<MessageType,? extends Tracking> trackingSupplier, Function<String,? extends GenericGateway> customGatewaySupplier, CommandGateway commandGateway, QueryGateway queryGateway, EventGateway eventGateway, ResultGateway resultGateway, ErrorGateway errorGateway, MetricsGateway metricsGateway, WebRequestGateway webRequestGateway, AggregateRepository aggregateRepository, SnapshotStore snapshotStore, EventStore eventStore, KeyValueStore keyValueStore, DocumentStore documentStore, MessageScheduler messageScheduler, UserProvider userProvider, Cache cache, Serializer serializer, CorrelationDataProvider correlationDataProvider, IdentityProvider identityProvider, PropertySource propertySource, DelegatingClock clock, TaskScheduler taskScheduler, Client client, ThrowingRunnable shutdownHandler)
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.
protected ConsumerConfiguration	getDefaultConsumerConfiguration(MessageType messageType)
protected HandlerRegistry	localHandlerRegistry(MessageType messageType, Map<MessageType,HandlerDecorator> handlerDecorators, List<ParameterResolver<? super DeserializingMessage>> parameterResolvers, Function<Class<?>,HandlerRepository> handlerRepositorySupplier, RepositoryProvider repositoryProvider)
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(@NonNull Cache cache)	Replaces the default cache implementation.
FluxCapacitorBuilder	replaceCorrelationDataProvider(@NonNull UnaryOperator<CorrelationDataProvider> replaceFunction)	Replaces the CorrelationDataProvider used to attach correlation data to messages.
FluxCapacitorBuilder	replaceDefaultResponseMapper(ResponseMapper defaultResponseMapper)	Replaces the default response mapper used for generic result mapping.
FluxCapacitorBuilder	replaceDocumentSerializer(@NonNull 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.
DefaultFluxCapacitor.Builder	replaceMessageRoutingInterceptor(@NonNull 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.
DefaultFluxCapacitor.Builder	replaceSerializer(@NonNull Serializer serializer)	Replaces the default serializer used for events, commands, snapshots, and documents.
DefaultFluxCapacitor.Builder	replaceSnapshotSerializer(@NonNull 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 class java.lang.Object

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

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

addDispatchInterceptor, addHandlerDecorator, addHandlerInterceptor, addHandlerInterceptor, addPropertySource, forwardWebRequestsToLocalServer

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

Constructor Details

Builder

public Builder()

Method Details

replaceSerializer

public DefaultFluxCapacitor.Builder replaceSerializer(@NonNull
 @NonNull Serializer serializer)

Description copied from interface: FluxCapacitorBuilder

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

Specified by:

replaceSerializer in interface FluxCapacitorBuilder

replaceCorrelationDataProvider

public FluxCapacitorBuilder replaceCorrelationDataProvider(@NonNull
 @NonNull UnaryOperator<CorrelationDataProvider> replaceFunction)

Description copied from interface: FluxCapacitorBuilder

Replaces the CorrelationDataProvider used to attach correlation data to messages.

Specified by:

replaceCorrelationDataProvider in interface FluxCapacitorBuilder

replaceSnapshotSerializer

public DefaultFluxCapacitor.Builder replaceSnapshotSerializer(@NonNull
 @NonNull Serializer serializer)

Description copied from interface: FluxCapacitorBuilder

Overrides the serializer used specifically for snapshot serialization.

Specified by:

replaceSnapshotSerializer in interface FluxCapacitorBuilder

replaceDocumentSerializer

public FluxCapacitorBuilder replaceDocumentSerializer(@NonNull
 @NonNull DocumentSerializer documentSerializer)

Description copied from interface: FluxCapacitorBuilder

Replaces the document serializer for search indexing.

Specified by:

replaceDocumentSerializer in interface FluxCapacitorBuilder

registerUserProvider

public FluxCapacitorBuilder registerUserProvider(UserProvider userProvider)

Description copied from interface: FluxCapacitorBuilder

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

Specified by:

registerUserProvider in interface FluxCapacitorBuilder

replacePropertySource

public FluxCapacitorBuilder replacePropertySource(UnaryOperator<PropertySource> replacer)

Description copied from interface: FluxCapacitorBuilder

Replaces the existing property source.

Specified by:

replacePropertySource in interface FluxCapacitorBuilder

configureDefaultConsumer

public DefaultFluxCapacitor.Builder configureDefaultConsumer(@NonNull
 @NonNull MessageType messageType,
 @NonNull
 @NonNull UnaryOperator<ConsumerConfiguration> updateFunction)

Description copied from interface: FluxCapacitorBuilder

Update the default consumer configuration for the specified message type.

Specified by:

configureDefaultConsumer in interface FluxCapacitorBuilder

addConsumerConfiguration

public DefaultFluxCapacitor.Builder addConsumerConfiguration(@NonNull
 @NonNull ConsumerConfiguration configuration,
 MessageType... messageTypes)

Description copied from interface: FluxCapacitorBuilder

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

Specified by:

addConsumerConfiguration in interface FluxCapacitorBuilder

addBatchInterceptor

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

Description copied from interface: FluxCapacitorBuilder

Registers a BatchInterceptor that applies to the given message types.

Specified by:

addBatchInterceptor in interface FluxCapacitorBuilder

addDispatchInterceptor

public DefaultFluxCapacitor.Builder addDispatchInterceptor(@NonNull
 @NonNull DispatchInterceptor interceptor,
 boolean highPriority,
 MessageType... forTypes)

Description copied from interface: FluxCapacitorBuilder

Adds a DispatchInterceptor for specified message types with optional priority.

Specified by:

addDispatchInterceptor in interface FluxCapacitorBuilder

addHandlerDecorator

public DefaultFluxCapacitor.Builder addHandlerDecorator(@NonNull
 @NonNull HandlerDecorator interceptor,
 boolean highPriority,
 MessageType... forTypes)

Description copied from interface: FluxCapacitorBuilder

Adds a HandlerDecorator with control over priority.

Specified by:

addHandlerDecorator in interface FluxCapacitorBuilder

replaceMessageRoutingInterceptor

public DefaultFluxCapacitor.Builder replaceMessageRoutingInterceptor(@NonNull
 @NonNull DispatchInterceptor messageRoutingInterceptor)

Description copied from interface: FluxCapacitorBuilder

Replaces the default routing interceptor used for message dispatch.

Specified by:

replaceMessageRoutingInterceptor in interface FluxCapacitorBuilder

replaceCache

public FluxCapacitorBuilder replaceCache(@NonNull
 @NonNull Cache cache)

Description copied from interface: FluxCapacitorBuilder

Replaces the default cache implementation.

Specified by:

replaceCache in interface FluxCapacitorBuilder

forwardWebRequestsToLocalServer

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

Description copied from interface: FluxCapacitorBuilder

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.

Specified by:

forwardWebRequestsToLocalServer in interface FluxCapacitorBuilder

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

public FluxCapacitorBuilder replaceDefaultResponseMapper(ResponseMapper defaultResponseMapper)

Description copied from interface: FluxCapacitorBuilder

Replaces the default response mapper used for generic result mapping.

Specified by:

replaceDefaultResponseMapper in interface FluxCapacitorBuilder

replaceWebResponseMapper

public FluxCapacitorBuilder replaceWebResponseMapper(WebResponseMapper webResponseMapper)

Description copied from interface: FluxCapacitorBuilder

Replaces the WebResponseMapper used for handling web responses.

Specified by:

replaceWebResponseMapper in interface FluxCapacitorBuilder

replaceTaskScheduler

public FluxCapacitorBuilder replaceTaskScheduler(Function<Clock,TaskScheduler> function)

Description copied from interface: FluxCapacitorBuilder

Replaces the default TaskScheduler implementation.

Specified by:

replaceTaskScheduler in interface FluxCapacitorBuilder

withAggregateCache

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

Description copied from interface: FluxCapacitorBuilder

Configures a dedicated cache for a specific aggregate type.

Specified by:

withAggregateCache in interface FluxCapacitorBuilder

replaceRelationshipsCache

public FluxCapacitorBuilder replaceRelationshipsCache(UnaryOperator<Cache> replaceFunction)

Description copied from interface: FluxCapacitorBuilder

Replaces the internal relationships cache with a new implementation.

Specified by:

replaceRelationshipsCache in interface FluxCapacitorBuilder

replaceIdentityProvider

public FluxCapacitorBuilder replaceIdentityProvider(UnaryOperator<IdentityProvider> replaceFunction)

Description copied from interface: FluxCapacitorBuilder

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

Specified by:

replaceIdentityProvider in interface FluxCapacitorBuilder

addParameterResolver

public DefaultFluxCapacitor.Builder addParameterResolver(@NonNull
 @NonNull ParameterResolver<? super DeserializingMessage> parameterResolver)

Description copied from interface: FluxCapacitorBuilder

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

Specified by:

addParameterResolver in interface FluxCapacitorBuilder

disableErrorReporting

public FluxCapacitorBuilder disableErrorReporting()

Description copied from interface: FluxCapacitorBuilder

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

Specified by:

disableErrorReporting in interface FluxCapacitorBuilder

disableShutdownHook

public FluxCapacitorBuilder disableShutdownHook()

Description copied from interface: FluxCapacitorBuilder

Prevents registration of a shutdown hook.

Specified by:

disableShutdownHook in interface FluxCapacitorBuilder

disableMessageCorrelation

public DefaultFluxCapacitor.Builder disableMessageCorrelation()

Description copied from interface: FluxCapacitorBuilder

Disables automatic message correlation.

Specified by:

disableMessageCorrelation in interface FluxCapacitorBuilder

disablePayloadValidation

public DefaultFluxCapacitor.Builder disablePayloadValidation()

Description copied from interface: FluxCapacitorBuilder

Disables payload validation.

Specified by:

disablePayloadValidation in interface FluxCapacitorBuilder

disableDataProtection

public FluxCapacitorBuilder disableDataProtection()

Description copied from interface: FluxCapacitorBuilder

Disables security filtering based on @FilterContent.

Specified by:

disableDataProtection in interface FluxCapacitorBuilder

disableAutomaticAggregateCaching

public FluxCapacitorBuilder disableAutomaticAggregateCaching()

Description copied from interface: FluxCapacitorBuilder

Disables automatic caching of aggregates.

Specified by:

disableAutomaticAggregateCaching in interface FluxCapacitorBuilder

disableScheduledCommandHandler

public FluxCapacitorBuilder disableScheduledCommandHandler()

Description copied from interface: FluxCapacitorBuilder

Prevents installation of the default scheduled command handler.

Specified by:

disableScheduledCommandHandler in interface FluxCapacitorBuilder

disableTrackingMetrics

public FluxCapacitorBuilder disableTrackingMetrics()

Description copied from interface: FluxCapacitorBuilder

Disables tracking of processing metrics.

Specified by:

disableTrackingMetrics in interface FluxCapacitorBuilder

disableCacheEvictionMetrics

public FluxCapacitorBuilder disableCacheEvictionMetrics()

Description copied from interface: FluxCapacitorBuilder

Disables metrics related to cache eviction.

Specified by:

disableCacheEvictionMetrics in interface FluxCapacitorBuilder

disableWebResponseCompression

public FluxCapacitorBuilder disableWebResponseCompression()

Description copied from interface: FluxCapacitorBuilder

Disables compression for web responses.

Specified by:

disableWebResponseCompression in interface FluxCapacitorBuilder

disableAdhocDispatchInterceptor

public FluxCapacitorBuilder disableAdhocDispatchInterceptor()

Description copied from interface: FluxCapacitorBuilder

Disables support for dynamically injected dispatch interceptors.

Specified by:

disableAdhocDispatchInterceptor in interface FluxCapacitorBuilder

makeApplicationInstance

public FluxCapacitorBuilder makeApplicationInstance(boolean makeApplicationInstance)

Description copied from interface: FluxCapacitorBuilder

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

Specified by:

makeApplicationInstance in interface FluxCapacitorBuilder

build

public FluxCapacitor build(@NonNull
 @NonNull Client client)

Description copied from interface: FluxCapacitorBuilder

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

Specified by:

build in interface FluxCapacitorBuilder

doBuild

protected FluxCapacitor doBuild(Map<MessageType,? extends Tracking> trackingSupplier,
 Function<String,? extends GenericGateway> customGatewaySupplier,
 CommandGateway commandGateway,
 QueryGateway queryGateway,
 EventGateway eventGateway,
 ResultGateway resultGateway,
 ErrorGateway errorGateway,
 MetricsGateway metricsGateway,
 WebRequestGateway webRequestGateway,
 AggregateRepository aggregateRepository,
 SnapshotStore snapshotStore,
 EventStore eventStore,
 KeyValueStore keyValueStore,
 DocumentStore documentStore,
 MessageScheduler messageScheduler,
 UserProvider userProvider,
 Cache cache,
 Serializer serializer,
 CorrelationDataProvider correlationDataProvider,
 IdentityProvider identityProvider,
 PropertySource propertySource,
 DelegatingClock clock,
 TaskScheduler taskScheduler,
 Client client,
 ThrowingRunnable shutdownHandler)

getDefaultConsumerConfiguration

protected ConsumerConfiguration getDefaultConsumerConfiguration(MessageType messageType)

createRequestGateway

protected GenericGateway createRequestGateway(Client client,
 MessageType messageType,
 String topic,
 RequestHandler requestHandler,
 Map<MessageType,DispatchInterceptor> dispatchInterceptors,
 Map<MessageType,HandlerDecorator> handlerDecorators,
 List<ParameterResolver<? super DeserializingMessage>> parameterResolvers,
 Function<Class<?>,HandlerRepository> handlerRepositorySupplier,
 RepositoryProvider repositoryProvider,
 ResponseMapper responseMapper)

localHandlerRegistry

protected HandlerRegistry localHandlerRegistry(MessageType messageType,
 Map<MessageType,HandlerDecorator> handlerDecorators,
 List<ParameterResolver<? super DeserializingMessage>> parameterResolvers,
 Function<Class<?>,HandlerRepository> handlerRepositorySupplier,
 RepositoryProvider repositoryProvider)