AxonConfiguration (Axon Framework 4.0 API)

java.lang.Object
- org.axonframework.spring.config.AxonConfiguration

All Implemented Interfaces:

Configuration, org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle
```
@Configuration(value="org.axonframework.spring.config.AxonConfiguration")
public class AxonConfiguration
extends Object
implements Configuration, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware, org.springframework.context.SmartLifecycle
```
Spring Configuration class that defines a number of conditional beans. It also allows for access to components that are available in the Configuration, but not made available as Spring beans by default.

Field Summary
- Fields inherited from interface org.springframework.context.SmartLifecycle
  DEFAULT_PHASE

Constructor Summary

Constructors
Constructor and Description

AxonConfiguration(Configurer configurer)
Initializes a new AxonConfiguration that uses the given configurer to build the configuration.

Constructors
Constructor and Description
`AxonConfiguration(Configurer configurer)` Initializes a new `AxonConfiguration` that uses the given `configurer` to build the configuration.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()`
`CommandBus`	`commandBus()` Returns the Command Bus defined in this Configuration.
`CommandGateway`	`commandGateway(CommandBus commandBus)` Returns the CommandGateway used to send commands to command handlers.
`List<CorrelationDataProvider>`	`correlationDataProviders()` Returns the Correlation Data Providers defined in this Configuration.
`CommandBus`	`defaultCommandBus()`
`EventBus`	`defaultEventBus()`
`QueryBus`	`defaultQueryBus()`
`QueryUpdateEmitter`	`defaultQueryUpdateEmitter()`
`EventBus`	`eventBus()` Retrieves the Event Bus defined in this Configuration.
`EventProcessingConfiguration`	`eventProcessingConfiguration()` Returns the `EventProcessingConfiguration` defined in this Configuration.
`Serializer`	`eventSerializer()` Returns the `Serializer` defined in this Configuration to be used for serializing Event Message payload and their metadata.
`<T> T`	`getComponent(Class<T> componentType, Supplier<T> defaultImpl)` Returns the Component declared under the given `componentType`, typically the interface the component implements, reverting to the given `defaultImpl` if no such component is defined.
`List<ModuleConfiguration>`	`getModules()` Returns all modules that have been registered with this Configuration.
`int`	`getPhase()`
`HandlerDefinition`	`handlerDefinition(Class<?> inspectedType)` Returns the Handler Definition defined in this Configuration for the given `inspectedType`.
`boolean`	`isAutoStartup()`
`boolean`	`isRunning()`
`<M extends Message<?>> MessageMonitor<? super M>`	`messageMonitor(Class<?> componentType, String componentName)` Returns the message monitor configured for a component of given `componentType` and `componentName`.
`Serializer`	`messageSerializer()` Returns the `Serializer` defined in this Configuration to be used for serializing Message payloads and metadata.
`void`	`onShutdown(int phase, Runnable shutdownHandler)` Registers a handler to be executed when the Configuration is shut down.
`void`	`onStart(int phase, Runnable startHandler)` Registers a handler to be executed when this Configuration is started.
`QueryBus`	`queryBus()`
`QueryGateway`	`queryGateway(QueryBus queryBus)`
`QueryUpdateEmitter`	`queryUpdateEmitter()` Returns the Query Update Emitter in this Configuration.
`<T> Repository<T>`	`repository(Class<T> aggregateType)` Returns the Repository configured for the given `aggregateType`.
`ResourceInjector`	`resourceInjector()` Returns the ResourceInjector used to provide resources to Saga instances.
`void`	`setApplicationContext(org.springframework.context.ApplicationContext applicationContext)`
`void`	`shutdown()` Shuts down the components defined in this Configuration
`void`	`start()` Starts this configuration.
`void`	`stop()`
`void`	`stop(Runnable callback)`
`EventUpcasterChain`	`upcasterChain()` Returns the EventUpcasterChain with all registered upcasters.

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.Configuration
commandGateway, deadlineManager, eventStore, findModules, getComponent, onShutdown, onStart, parameterResolverFactory, queryGateway, serializer

- Constructor Detail
  - AxonConfiguration
```
public AxonConfiguration(Configurer configurer)
```
    Initializes a new AxonConfiguration that uses the given configurer to build the configuration.
    
    Parameters:
    
    configurer - Configuration builder for the AxonConfiguration.
- Method Detail
  - commandBus
```
public CommandBus commandBus()
```
    Description copied from interface: Configuration
    
    Returns the Command Bus defined in this Configuration. Note that this Configuration should be started (see Configuration.start()) before sending Commands over the Command Bus.
    
    Specified by:
    
    commandBus in interface Configuration
    
    Returns:
    
    the CommandBus defined in this configuration
  - queryBus
```
public QueryBus queryBus()
```
    Specified by:
    
    queryBus in interface Configuration
  - eventBus
```
public EventBus eventBus()
```
    Description copied from interface: Configuration
    
    Retrieves the Event Bus defined in this Configuration.
    
    Specified by:
    
    eventBus in interface Configuration
    
    Returns:
    
    the Event Bus defined in this Configuration
  - queryUpdateEmitter
```
public QueryUpdateEmitter queryUpdateEmitter()
```
    Description copied from interface: Configuration
    
    Returns the Query Update Emitter in this Configuration. Note that this Configuration should be started (see Configuration.start() before emitting updates over Query Update Emitter.
    
    Specified by:
    
    queryUpdateEmitter in interface Configuration
    
    Returns:
    
    the QueryUpdateEmitter defined in this configuration
  - defaultQueryBus
```
@Bean(value="queryBus")
public QueryBus defaultQueryBus()
```
  - defaultQueryUpdateEmitter
```
@Bean(value="queryUpdateEmitter")
public QueryUpdateEmitter defaultQueryUpdateEmitter()
```
  - defaultCommandBus
```
@Bean(value="commandBus")
public CommandBus defaultCommandBus()
```
  - defaultEventBus
```
@Bean(value="eventBus")
public EventBus defaultEventBus()
```
  - resourceInjector
```
public ResourceInjector resourceInjector()
```
    Description copied from interface: Configuration
    
    Returns the ResourceInjector used to provide resources to Saga instances.
    
    Specified by:
    
    resourceInjector in interface Configuration
    
    Returns:
    
    the ResourceInjector used to provide resources to Saga instances
  - eventProcessingConfiguration
```
public EventProcessingConfiguration eventProcessingConfiguration()
```
    Description copied from interface: Configuration
    
    Returns the EventProcessingConfiguration defined in this Configuration. If there aren't any defined, null will be returned. If there is exactly one, it will be returned. For case when there are multiple, an AxonConfigurationException is thrown and the Configuration.getModules() API should be used instead.
    
    Specified by:
    
    eventProcessingConfiguration in interface Configuration
    
    Returns:
    
    the EventProcessingConfiguration defined in this Configuration
  - commandGateway
```
@Bean
public CommandGateway commandGateway(CommandBus commandBus)
```
    Returns the CommandGateway used to send commands to command handlers.
    
    Parameters:
    
    commandBus - the command bus to be used by the gateway
    
    Returns:
    
    the CommandGateway used to send commands to command handlers
  - queryGateway
```
@Bean
public QueryGateway queryGateway(QueryBus queryBus)
```
  - repository
```
public <T> Repository<T> repository(Class<T> aggregateType)
```
    Description copied from interface: Configuration
    
    Returns the Repository configured for the given aggregateType.
    
    Specified by:
    
    repository in interface Configuration
    
    Type Parameters:
    
    T - The aggregate type
    
    Parameters:
    
    aggregateType - The aggregate type to find the repository for
    
    Returns:
    
    the repository from which aggregates of the given type can be loaded
  - getComponent
```
public <T> T getComponent(Class<T> componentType,
                          Supplier<T> defaultImpl)
```
    Description copied from interface: Configuration
    
    Returns the Component declared under the given componentType, typically the interface the component implements, reverting to the given defaultImpl if no such component is defined.
    When no component was previously registered, the default is then configured as the component for the given type.
    
    Specified by:
    
    getComponent in interface Configuration
    
    Type Parameters:
    
    T - The type of component
    
    Parameters:
    
    componentType - The type of component
    
    defaultImpl - The supplier of the default to return if no component was registered
    
    Returns:
    
    the component registered for the given type, or the value returned by the defaultImpl supplier, if no component was registered
  - messageMonitor
```
public <M extends Message<?>> MessageMonitor<? super M> messageMonitor(Class<?> componentType,
                                                                       String componentName)
```
    Description copied from interface: Configuration
    
    Returns the message monitor configured for a component of given componentType and componentName.
    
    Specified by:
    
    messageMonitor in interface Configuration
    
    Type Parameters:
    
    M - The type of message the monitor can deal with
    
    Parameters:
    
    componentType - The type of component to return the monitor for
    
    componentName - The name of the component
    
    Returns:
    
    The monitor to be used for the described component
  - eventSerializer
```
public Serializer eventSerializer()
```
    Description copied from interface: Configuration
    
    Returns the Serializer defined in this Configuration to be used for serializing Event Message payload and their metadata.
    
    Specified by:
    
    eventSerializer in interface Configuration
    
    Returns:
    
    the event serializer defined in this Configuration.
  - messageSerializer
```
public Serializer messageSerializer()
```
    Description copied from interface: Configuration
    
    Returns the Serializer defined in this Configuration to be used for serializing Message payloads and metadata.
    
    Specified by:
    
    messageSerializer in interface Configuration
    
    Returns:
    
    the message serializer defined in this Configuration.
  - correlationDataProviders
```
public List<CorrelationDataProvider> correlationDataProviders()
```
    Description copied from interface: Configuration
    
    Returns the Correlation Data Providers defined in this Configuration.
    
    Specified by:
    
    correlationDataProviders in interface Configuration
    
    Returns:
    
    the Correlation Data Providers defined in this Configuration
  - handlerDefinition
```
public HandlerDefinition handlerDefinition(Class<?> inspectedType)
```
    Description copied from interface: Configuration
    
    Returns the Handler Definition defined in this Configuration for the given inspectedType.
    
    Specified by:
    
    handlerDefinition in interface Configuration
    
    Parameters:
    
    inspectedType - The class to being inspected for handlers
    
    Returns:
    
    the Handler Definition defined in this Configuration
  - upcasterChain
```
public EventUpcasterChain upcasterChain()
```
    Description copied from interface: Configuration
    
    Returns the EventUpcasterChain with all registered upcasters.
    
    Specified by:
    
    upcasterChain in interface Configuration
    
    Returns:
    
    the EventUpcasterChain with all registered upcasters
  - getModules
```
public List<ModuleConfiguration> getModules()
```
    Description copied from interface: Configuration
    
    Returns all modules that have been registered with this Configuration.
    
    Specified by:
    
    getModules in interface Configuration
    
    Returns:
    
    all modules that have been registered with this Configuration
  - onStart
```
public void onStart(int phase,
                    Runnable startHandler)
```
    Description copied from interface: Configuration
    
    Registers a handler to be executed when this Configuration is started.
    The behavior for handlers that are registered when the Configuration is already started is undefined.
    
    Specified by:
    
    onStart in interface Configuration
    
    Parameters:
    
    phase - defines a phase in which the start handler 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.
    
    startHandler - The handler to execute when the configuration is started
    
    See Also:
    
    Configuration.start(), Configuration.onShutdown(Runnable)
  - onShutdown
```
public void onShutdown(int phase,
                       Runnable shutdownHandler)
```
    Description copied from interface: Configuration
    
    Registers a handler to be executed when the Configuration is shut down.
    The behavior for handlers that are registered when the Configuration is already shut down is undefined.
    
    Specified by:
    
    onShutdown in interface Configuration
    
    Parameters:
    
    phase - defines a phase in which the shutdown handler 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.
    
    shutdownHandler - The handler to execute when the Configuration is shut down
    
    See Also:
    
    Configuration.shutdown(), Configuration.onStart(Runnable)
  - start
```
public void start()
```
    Description copied from interface: Configuration
    
    Starts this configuration. All components defined in this Configuration will be started.
    
    Specified by:
    
    start in interface Configuration
    
    Specified by:
    
    start in interface org.springframework.context.Lifecycle
  - shutdown
```
public void shutdown()
```
    Description copied from interface: Configuration
    
    Shuts down the components defined in this Configuration
    
    Specified by:
    
    shutdown in interface Configuration
  - stop
```
public void stop()
```
    Specified by:
    
    stop in interface org.springframework.context.Lifecycle
  - isRunning
```
public boolean isRunning()
```
    Specified by:
    
    isRunning in interface org.springframework.context.Lifecycle
  - isAutoStartup
```
public boolean isAutoStartup()
```
    Specified by:
    
    isAutoStartup in interface org.springframework.context.SmartLifecycle
  - stop
```
public void stop(Runnable callback)
```
    Specified by:
    
    stop in interface org.springframework.context.SmartLifecycle
  - getPhase
```
public int getPhase()
```
    Specified by:
    
    getPhase in interface org.springframework.context.Phased
    
    Specified by:
    
    getPhase in interface org.springframework.context.SmartLifecycle
  - afterPropertiesSet
```
public void afterPropertiesSet()
```
    Specified by:
    
    afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
  - 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

Class AxonConfiguration

Field Summary

Fields inherited from interface org.springframework.context.SmartLifecycle

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.axonframework.config.Configuration

Constructor Detail

AxonConfiguration

Method Detail

commandBus

queryBus

eventBus

queryUpdateEmitter

defaultQueryBus

defaultQueryUpdateEmitter

defaultCommandBus

defaultEventBus

resourceInjector

eventProcessingConfiguration

commandGateway

queryGateway

repository

getComponent

messageMonitor

eventSerializer

messageSerializer

correlationDataProviders

handlerDefinition

upcasterChain

getModules

onStart

onShutdown

start

shutdown

stop

isRunning

isAutoStartup

stop

getPhase

afterPropertiesSet

setApplicationContext