DefaultConfigurer (Axon Framework 3.3.4 API)

java.lang.Object
- org.axonframework.config.DefaultConfigurer

All Implemented Interfaces:

Configurer
```
public class DefaultConfigurer
extends Object
implements Configurer
```
Entry point of the Axon Configuration API. It implements the Configurer interface, providing access to the methods to configure the default Axon components.
Using defaultConfiguration(), you will get a Configurer instance with default components configured. You will need to register your Aggregates (using configureAggregate(AggregateConfiguration) and provide a repository implementation for each of them, or if you wish to use event sourcing, register your aggregates through Configurer.configureAggregate(Class) and configure an Event Store (Configurer.configureEventStore(Function) or configureEmbeddedEventStore(Function)).
Use buildConfiguration() to build the configuration, which provides access to the configured building blocks, such as the CommandBus and EventBus.
Note that this Configurer implementation is not thread-safe.

Constructor Summary

Constructors
Modifier Constructor and Description

protected DefaultConfigurer()
Initialize the Configurer.

Constructors
Modifier	Constructor and Description
`protected`	`DefaultConfigurer()` Initialize the Configurer.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Configuration`	`buildConfiguration()` Returns the completely initialized Configuration built using this configurer.
`<A> Configurer`	`configureAggregate(AggregateConfiguration<A> aggregateConfiguration)` Configures an Aggregate in this configuration based on the given `aggregateConfiguration`.
`Configurer`	`configureCorrelationDataProviders(Function<Configuration,List<CorrelationDataProvider>> correlationDataProviderBuilder)` Configures the CorrelationDataProviders that Message processing components should use to attach correlation data to outgoing messages.
`Configurer`	`configureEmbeddedEventStore(Function<Configuration,EventStorageEngine> storageEngineBuilder)` Configures an Embedded Event Store which uses the given Event Storage Engine to store its events.
`Configurer`	`configureEventSerializer(Function<Configuration,Serializer> eventSerializerBuilder)` Configures the given event Serializer to use in this configuration.
`Configurer`	`configureMessageMonitor(Class<?> componentType, MessageMonitorFactory messageMonitorFactory)` Configures the factory to create the Message Monitor for the Message processing components in this configuration that match the given componentType, unless more specific configuration based on both type and name is available.
`Configurer`	`configureMessageMonitor(Class<?> componentType, String componentName, MessageMonitorFactory messageMonitorFactory)` Configures the factory create the Message Monitor for those Message processing components in this configuration that match the given class and name.
`Configurer`	`configureMessageMonitor(Function<Configuration,BiFunction<Class<?>,String,MessageMonitor<Message<?>>>> builder)` Configures the Message Monitor to use for the Message processing components in this configuration, unless more specific configuration based on the component's type, or type and name is available.
`Configurer`	`configureMessageSerializer(Function<Configuration,Serializer> messageSerializerBuilder)` Configures the given event Serializer to use in this configuration.
`protected CommandBus`	`defaultCommandBus(Configuration config)` Provides the default CommandBus implementation.
`protected CommandGateway`	`defaultCommandGateway(Configuration config)` Returns a `DefaultCommandGateway` that will use the configuration's `CommandBus` to dispatch commands.
`static Configurer`	`defaultConfiguration()` Returns a Configurer instance with default components configured, such as a `SimpleCommandBus` and `SimpleEventBus`.
`protected DeadlineManager`	`defaultDeadlineManager(Configuration config)` Provides the default `DeadlineManager` implementation.
`protected EventBus`	`defaultEventBus(Configuration config)` Provides the default EventBus implementation.
`protected HandlerDefinition`	`defaultHandlerDefinition(Class<?> inspectedClass)` Provides the default HandlerDefinition.
`protected ParameterResolverFactory`	`defaultParameterResolverFactory(Configuration config)` Provides the default ParameterResolverFactory.
`protected QueryBus`	`defaultQueryBus(Configuration config)` Provides the default QueryBus implementations.
`protected QueryGateway`	`defaultQueryGateway(Configuration config)` Returns a `DefaultQueryGateway` that will use the configuration's `QueryBus` to dispatch queries.
`protected QueryUpdateEmitter`	`defaultQueryUpdateEmitter(Configuration config)` Provides the default QueryUpdateEmitter implementation.
`protected ResourceInjector`	`defaultResourceInjector(Configuration config)` Returns a `ConfigurationResourceInjector` that injects resources defined in the given `config Configuration`.
`protected Serializer`	`defaultSerializer(Configuration config)` Provides the default Serializer implementation.
`Map<Class<?>,Component<?>>`	`getComponents()` Returns a map of all registered components in this configuration.
`protected Configuration`	`getConfig()` Returns the current Configuration object being built by this Configurer, without initializing it.
`protected void`	`invokeInitHandlers()` Calls all registered init handlers.
`protected void`	`invokeShutdownHandlers()` Invokes all registered shutdown handlers.
`protected void`	`invokeStartHandlers()` Invokes all registered start handlers.
`static Configurer`	`jpaConfiguration(EntityManagerProvider entityManagerProvider)` Returns a Configurer instance which has JPA versions of building blocks configured, such as a JPA based Event Store (see `JpaEventStorageEngine`), a `JpaTokenStore` and `JpaSagaStore`.
`static Configurer`	`jpaConfiguration(EntityManagerProvider entityManagerProvider, TransactionManager transactionManager)` Returns a Configurer instance which has JPA versions of building blocks configured, such as a JPA based Event Store (see `JpaEventStorageEngine`), a `JpaTokenStore` and `JpaSagaStore`.
`protected void`	`prepareModules()` Prepare the registered modules for initialization.
`Configurer`	`registerCommandHandler(int phase, Function<Configuration,Object> annotatedCommandHandlerBuilder)` Registers a command handler bean with this configuration.
`<C> Configurer`	`registerComponent(Class<C> componentType, Function<Configuration,? extends C> componentBuilder)` Registers a component which should be made available to other components or modules in this Configuration.
`Configurer`	`registerEventUpcaster(Function<Configuration,EventUpcaster> upcasterBuilder)` Registers an upcaster to be used to upcast Events to a newer version
`Configurer`	`registerHandlerDefinition(BiFunction<Configuration,Class,HandlerDefinition> handlerDefinitionClass)` Registers the definition of a Handler class.
`Configurer`	`registerModule(ModuleConfiguration module)` Registers an Axon module with this configuration.
`Configurer`	`registerQueryHandler(int phase, Function<Configuration,Object> annotatedQueryHandlerBuilder)` Registers a query handler bean with this configuration.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.axonframework.config.Configurer
configureAggregate, configureCommandBus, configureEventBus, configureEventStore, configureMessageMonitor, configureMessageMonitor, configureQueryBus, configureQueryUpdateEmitter, configureResourceInjector, configureSerializer, configureTransactionManager, registerCommandHandler, registerQueryHandler, start

- Constructor Detail
  - DefaultConfigurer
```
protected DefaultConfigurer()
```
    Initialize the Configurer.
- Method Detail
  - defaultConfiguration
```
public static Configurer defaultConfiguration()
```
    Returns a Configurer instance with default components configured, such as a SimpleCommandBus and SimpleEventBus.
    
    Returns:
    
    Configurer instance for further configuration.
  - jpaConfiguration
```
public static Configurer jpaConfiguration(EntityManagerProvider entityManagerProvider,
                                          TransactionManager transactionManager)
```
    Returns a Configurer instance which has JPA versions of building blocks configured, such as a JPA based Event Store (see JpaEventStorageEngine), a JpaTokenStore and JpaSagaStore.
    This method allows to provide a transaction manager for usage in JTA-managed entity manager.
    
    Parameters:
    
    entityManagerProvider - The instance that provides access to the JPA EntityManager.
    
    transactionManager - TransactionManager to be used for accessing the entity manager.
    
    Returns:
    
    A Configurer instance for further configuration.
  - jpaConfiguration
```
public static Configurer jpaConfiguration(EntityManagerProvider entityManagerProvider)
```
    Returns a Configurer instance which has JPA versions of building blocks configured, such as a JPA based Event Store (see JpaEventStorageEngine), a JpaTokenStore and JpaSagaStore.
    This configuration should be used with an entity manager running without JTA transaction. If you are using a entity manager in JTA mode, please provide the corresponding TransactionManager in the jpaConfiguration(EntityManagerProvider, TransactionManager) method.
    
    Parameters:
    
    entityManagerProvider - The instance that provides access to the JPA EntityManager.
    
    Returns:
    
    A Configurer instance for further configuration.
  - defaultCommandGateway
```
protected CommandGateway defaultCommandGateway(Configuration config)
```
    Returns a DefaultCommandGateway that will use the configuration's CommandBus to dispatch commands.
    
    Parameters:
    
    config - The configuration that supplies the command bus.
    
    Returns:
    
    The default command gateway.
  - defaultQueryGateway
```
protected QueryGateway defaultQueryGateway(Configuration config)
```
    Returns a DefaultQueryGateway that will use the configuration's QueryBus to dispatch queries.
    
    Parameters:
    
    config - The configuration that supplies the query bus.
    
    Returns:
    
    The default query gateway.
  - defaultQueryBus
```
protected QueryBus defaultQueryBus(Configuration config)
```
    Provides the default QueryBus implementations. Subclasses may override this method to provide their own default.
    
    Parameters:
    
    config - The configuration based on which the component is initialized.
    
    Returns:
    
    The default QueryBus to use.
  - defaultQueryUpdateEmitter
```
protected QueryUpdateEmitter defaultQueryUpdateEmitter(Configuration config)
```
    Provides the default QueryUpdateEmitter implementation. Subclasses may override this method to provide their own default.
    
    Parameters:
    
    config - The configuration based on which the component is initialized
    
    Returns:
    
    The default QueryUpdateEmitter to use
  - defaultParameterResolverFactory
```
protected ParameterResolverFactory defaultParameterResolverFactory(Configuration config)
```
    Provides the default ParameterResolverFactory. Subclasses may override this method to provide their own default.
    
    Parameters:
    
    config - The configuration based on which the component is initialized.
    
    Returns:
    
    The default ParameterResolverFactory to use.
  - defaultHandlerDefinition
```
protected HandlerDefinition defaultHandlerDefinition(Class<?> inspectedClass)
```
    Provides the default HandlerDefinition. Subclasses may override this method to provide their own default.
    
    Parameters:
    
    inspectedClass - The class being inspected for handlers
    
    Returns:
    
    The default HandlerDefinition to use
  - defaultCommandBus
```
protected CommandBus defaultCommandBus(Configuration config)
```
    Provides the default CommandBus implementation. Subclasses may override this method to provide their own default.
    
    Parameters:
    
    config - The configuration based on which the component is initialized.
    
    Returns:
    
    The default CommandBus to use.
  - defaultResourceInjector
```
protected ResourceInjector defaultResourceInjector(Configuration config)
```
    Returns a ConfigurationResourceInjector that injects resources defined in the given config Configuration.
    
    Parameters:
    
    config - The configuration that supplies registered components.
    
    Returns:
    
    A resource injector that supplies components registered with the configuration.
  - defaultDeadlineManager
```
protected DeadlineManager defaultDeadlineManager(Configuration config)
```
    Provides the default DeadlineManager implementation. Subclasses may override this method to provide their own default.
    
    Parameters:
    
    config - The configuration that supplies registered components.
    
    Returns:
    
    The default DeadlineManager to use
  - defaultEventBus
```
protected EventBus defaultEventBus(Configuration config)
```
    Provides the default EventBus implementation. Subclasses may override this method to provide their own default.
    
    Parameters:
    
    config - The configuration based on which the component is initialized.
    
    Returns:
    
    The default EventBus to use.
  - defaultSerializer
```
protected Serializer defaultSerializer(Configuration config)
```
    Provides the default Serializer implementation. Subclasses may override this method to provide their own default.
    
    Parameters:
    
    config - The configuration based on which the component is initialized.
    
    Returns:
    
    The default Serializer to use.
  - registerEventUpcaster
```
public Configurer registerEventUpcaster(Function<Configuration,EventUpcaster> upcasterBuilder)
```
    Description copied from interface: Configurer
    
    Registers an upcaster to be used to upcast Events to a newer version
    
    Specified by:
    
    registerEventUpcaster in interface Configurer
    
    Parameters:
    
    upcasterBuilder - The function that returns an EventUpcaster based on the configuration
    
    Returns:
    
    the current instance of the Configurer, for chaining purposes
  - configureMessageMonitor
```
public Configurer configureMessageMonitor(Function<Configuration,BiFunction<Class<?>,String,MessageMonitor<Message<?>>>> builder)
```
    Description copied from interface: Configurer
    
    Configures the Message Monitor to use for the Message processing components in this configuration, unless more specific configuration based on the component's type, or type and name is available. The builder function receives the type of component as well as its name as input, and is expected to return a MessageMonitor instance to be used by that type of component.
    
    Specified by:
    
    configureMessageMonitor in interface Configurer
    
    Parameters:
    
    builder - The MessageMonitor builder function
    
    Returns:
    
    the current instance of the Configurer, for chaining purposes
  - configureMessageMonitor
```
public Configurer configureMessageMonitor(Class<?> componentType,
                                          MessageMonitorFactory messageMonitorFactory)
```
    Description copied from interface: Configurer
    
    Configures the factory to create the Message Monitor for the Message processing components in this configuration that match the given componentType, unless more specific configuration based on both type and name is available.
    
    A component matches componentType if componentType is assignable from the component's class. If a component matches multiple types, and the types derive from each other, the configuration from the most derived type is used. If the matching types do not derive from each other, the result is unspecified.
    
    For example: in case a monitor is configured for CommandBus and another monitor is configured for SimpleCommandBus), components of type AsynchronousCommandBus will use the monitor configured for the SimpleCommandBus.
    
    A component's name matches componentName if they are identical; i.e. they are compared case sensitively.
    
    Specified by:
    
    configureMessageMonitor in interface Configurer
    
    Parameters:
    
    componentType - The declared type of the component
    
    messageMonitorFactory - The factory to use
    
    Returns:
    
    the current instance of the Configurer, for chaining purposes
  - configureMessageMonitor
```
public Configurer configureMessageMonitor(Class<?> componentType,
                                          String componentName,
                                          MessageMonitorFactory messageMonitorFactory)
```
    Description copied from interface: Configurer
    
    Configures the factory create the Message Monitor for those Message processing components in this configuration that match the given class and name.
    
    A component matches componentType if componentType is assignable from the component's class. If a component matches multiple types, and the types derive from each other, the configuration from the most derived type is used. If the matching types do not derive from each other, the result is unspecified.
    
    For example: in case a monitor is configured for CommandBus and another monitor is configured for SimpleCommandBus), components of type AsynchronousCommandBus will use the monitor configured for the SimpleCommandBus.
    
    A component's name matches componentName if they are identical; i.e. they are compared case sensitively.
    
    Specified by:
    
    configureMessageMonitor in interface Configurer
    
    Parameters:
    
    componentType - The declared type of the component
    
    componentName - The name of the component
    
    messageMonitorFactory - The factory to use
    
    Returns:
    
    the current instance of the Configurer, for chaining purposes
  - configureCorrelationDataProviders
```
public Configurer configureCorrelationDataProviders(Function<Configuration,List<CorrelationDataProvider>> correlationDataProviderBuilder)
```
    Description copied from interface: Configurer
    
    Configures the CorrelationDataProviders that Message processing components should use to attach correlation data to outgoing messages. The builder function receives the Configuration as input and is expected to return a list or CorrelationDataProviders.
    
    Specified by:
    
    configureCorrelationDataProviders in interface Configurer
    
    Parameters:
    
    correlationDataProviderBuilder - the builder function returning the CorrelationDataProvider list
    
    Returns:
    
    the current instance of the Configurer, for chaining purposes
  - registerModule
```
public Configurer registerModule(ModuleConfiguration module)
```
    Description copied from interface: Configurer
    
    Registers an Axon module with this configuration. The module is initialized when the configuration is created and has access to the global configuration when initialized.
    Typically, modules are registered for Event Handling components or Sagas.
    
    Specified by:
    
    registerModule in interface Configurer
    
    Parameters:
    
    module - The module to register
    
    Returns:
    
    the current instance of the Configurer, for chaining purposes
    
    See Also:
    
    SagaConfiguration, EventHandlingConfiguration
  - registerCommandHandler
```
public Configurer registerCommandHandler(int phase,
                                         Function<Configuration,Object> annotatedCommandHandlerBuilder)
```
    Description copied from interface: Configurer
    
    Registers a command handler bean with this configuration. The bean may be of any type. The actual command handler methods will be detected based on the annotations present on the bean's methods.
    The builder function receives the Configuration as input, and is expected to return a fully initialized instance of the command handler bean.
    
    Specified by:
    
    registerCommandHandler in interface Configurer
    
    Parameters:
    
    phase - defines a phase in which the command handler builder will be invoked during Configuration.start() and Configuration.shutdown(). When starting the configuration handlers are ordered in ascending, when shutting down the configuration, descending order is used.
    
    annotatedCommandHandlerBuilder - The builder function of the Command Handler bean
    
    Returns:
    
    the current instance of the Configurer, for chaining purposes
  - registerQueryHandler
```
public Configurer registerQueryHandler(int phase,
                                       Function<Configuration,Object> annotatedQueryHandlerBuilder)
```
    Description copied from interface: Configurer
    
    Registers a query handler bean with this configuration. The bean may be of any type. The actual query handler methods will be detected based on the annotations present on the bean's methods.
    The builder function receives the Configuration as input, and is expected to return a fully initialized instance of the query handler bean.
    
    Specified by:
    
    registerQueryHandler in interface Configurer
    
    Parameters:
    
    phase - defines a phase in which the query handler builder will be invoked during Configuration.start() and Configuration.shutdown(). When starting the configuration handlers are ordered in ascending, when shutting down the configuration, descending order is used.
    
    annotatedQueryHandlerBuilder - The builder function of the Query Handler bean
    
    Returns:
    
    the current instance of the Configurer, for chaining purposes
  - registerComponent
```
public <C> Configurer registerComponent(Class<C> componentType,
                                        Function<Configuration,? extends C> componentBuilder)
```
    Description copied from interface: Configurer
    
    Registers a component which should be made available to other components or modules in this Configuration. The builder function gets this configuration as input, and is expected to provide the component as output.
    Where possible, it is recommended to use the explicit configure... and register... methods.
    
    Specified by:
    
    registerComponent in interface Configurer
    
    Type Parameters:
    
    C - The type of component
    
    Parameters:
    
    componentType - The declared type of the component, typically an interface
    
    componentBuilder - The builder function of this component
    
    Returns:
    
    the current instance of the Configurer, for chaining purposes
  - configureEmbeddedEventStore
```
public Configurer configureEmbeddedEventStore(Function<Configuration,EventStorageEngine> storageEngineBuilder)
```
    Description copied from interface: Configurer
    
    Configures an Embedded Event Store which uses the given Event Storage Engine to store its events. The builder receives the Configuration as input and is expected to return a fully initialized EventStorageEngine instance.
    
    Specified by:
    
    configureEmbeddedEventStore in interface Configurer
    
    Parameters:
    
    storageEngineBuilder - The builder function for the EventStorageEngine
    
    Returns:
    
    the current instance of the Configurer, for chaining purposes
  - configureEventSerializer
```
public Configurer configureEventSerializer(Function<Configuration,Serializer> eventSerializerBuilder)
```
    Description copied from interface: Configurer
    
    Configures the given event Serializer to use in this configuration. The builder receives the Configuration as input and is expected to return a fully initialized Serializer instance.
    This Serializer is specifically used to serialize EventMessage payload and metadata.
    
    Specified by:
    
    configureEventSerializer in interface Configurer
    
    Parameters:
    
    eventSerializerBuilder - The builder function for the Serializer.
    
    Returns:
    
    The current instance of the Configurer, for chaining purposes.
  - configureMessageSerializer
```
public Configurer configureMessageSerializer(Function<Configuration,Serializer> messageSerializerBuilder)
```
    Description copied from interface: Configurer
    
    Configures the given event Serializer to use in this configuration. The builder receives the Configuration as input and is expected to return a fully initialized Serializer instance.
    This Serializer is specifically used to serialize Message payload and Metadata.
    
    Specified by:
    
    configureMessageSerializer in interface Configurer
    
    Parameters:
    
    messageSerializerBuilder - The builder function for the Serializer.
    
    Returns:
    
    The current instance of the Configurer, for chaining purposes.
  - configureAggregate
```
public <A> Configurer configureAggregate(AggregateConfiguration<A> aggregateConfiguration)
```
    Description copied from interface: Configurer
    
    Configures an Aggregate in this configuration based on the given aggregateConfiguration. This method allows for more fine-grained configuration compared to the Configurer.configureAggregate(Class) method.
    
    Specified by:
    
    configureAggregate in interface Configurer
    
    Type Parameters:
    
    A - The type of aggregate the configuration is for
    
    Parameters:
    
    aggregateConfiguration - The instance describing the configuration of an Aggregate
    
    Returns:
    
    the current instance of the Configurer, for chaining purposes
    
    See Also:
    
    AggregateConfigurer
  - registerHandlerDefinition
```
public Configurer registerHandlerDefinition(BiFunction<Configuration,Class,HandlerDefinition> handlerDefinitionClass)
```
    Description copied from interface: Configurer
    
    Registers the definition of a Handler class. Defaults to annotation based recognition of handler methods.
    
    Specified by:
    
    registerHandlerDefinition in interface Configurer
    
    Parameters:
    
    handlerDefinitionClass - A function providing the definition based on the current Configuration as well as the class being inspected.
    
    Returns:
    
    the current instance of the Configurer, for chaining purposes
  - buildConfiguration
```
public Configuration buildConfiguration()
```
    Description copied from interface: Configurer
    
    Returns the completely initialized Configuration built using this configurer. It is not recommended to change any configuration on this Configurer once this method is called.
    
    Specified by:
    
    buildConfiguration in interface Configurer
    
    Returns:
    
    the fully initialized Configuration
  - prepareModules
```
protected void prepareModules()
```
    Prepare the registered modules for initialization. This ensures all lifecycle handlers are registered.
  - invokeInitHandlers
```
protected void invokeInitHandlers()
```
    Calls all registered init handlers. Registration of init handlers after this invocation will result in an immediate invocation of that handler.
  - invokeStartHandlers
```
protected void invokeStartHandlers()
```
    Invokes all registered start handlers.
  - invokeShutdownHandlers
```
protected void invokeShutdownHandlers()
```
    Invokes all registered shutdown handlers.
  - getConfig
```
protected Configuration getConfig()
```
    Returns the current Configuration object being built by this Configurer, without initializing it. Note that retrieving objects from this configuration may lead to premature initialization of certain components.
    
    Returns:
    
    The current Configuration object being built by this Configurer.
  - getComponents
```
public Map<Class<?>,Component<?>> getComponents()
```
    Returns a map of all registered components in this configuration. The key of the map is the registered component type (typically an interface), the value is a Component instance that wraps the actual implementation. Note that calling Component.get() may prematurely initialize a component.
    
    Returns:
    
    A map of all registered components in this configuration.

Class DefaultConfigurer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.axonframework.config.Configurer

Constructor Detail

DefaultConfigurer

Method Detail

defaultConfiguration

jpaConfiguration

jpaConfiguration

defaultCommandGateway

defaultQueryGateway

defaultQueryBus

defaultQueryUpdateEmitter

defaultParameterResolverFactory

defaultHandlerDefinition

defaultCommandBus

defaultResourceInjector

defaultDeadlineManager

defaultEventBus

defaultSerializer

registerEventUpcaster

configureMessageMonitor

configureMessageMonitor

configureMessageMonitor

configureCorrelationDataProviders

registerModule

registerCommandHandler

registerQueryHandler

registerComponent

configureEmbeddedEventStore

configureEventSerializer

configureMessageSerializer

configureAggregate

registerHandlerDefinition

buildConfiguration

prepareModules

invokeInitHandlers

invokeStartHandlers

invokeShutdownHandlers

getConfig

getComponents