AggregateConfigurer (Axon Framework 4.1.1 API)

java.lang.Object
- org.axonframework.config.AggregateConfigurer<A>

Type Parameters:

A - The type of Aggregate configured

All Implemented Interfaces:

AggregateConfiguration<A>, ModuleConfiguration
```
public class AggregateConfigurer<A>
extends Object
implements AggregateConfiguration<A>
```
Axon Configuration API extension that allows the definition of an Aggregate. This component will automatically setup all components required for the Aggregate to operate.

Constructor Summary

Constructors
Modifier Constructor and Description

protected AggregateConfigurer(Class<A> aggregate)
Creates a default configuration as described in defaultConfiguration(Class).

Constructors
Modifier	Constructor and Description
`protected`	`AggregateConfigurer(Class<A> aggregate)` Creates a default configuration as described in `defaultConfiguration(Class)`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Class<A>`	`aggregateType()` Returns the type of Aggregate defined in this Configuration.
`AggregateConfigurer<A>`	`configureAggregateFactory(Function<Configuration,AggregateFactory<A>> aggregateFactoryBuilder)` Defines the factory to use to to create new Aggregates instances of the type under configuration.
`AggregateConfigurer<A>`	`configureCommandHandler(Function<Configuration,AggregateAnnotationCommandHandler> aggregateCommandHandlerBuilder)` Defines the AggregateAnnotationCommandHandler instance to use.
`AggregateConfigurer<A>`	`configureCommandTargetResolver(Function<Configuration,CommandTargetResolver> commandTargetResolverBuilder)` Defines the CommandTargetResolver to use for the Aggregate type under configuration.
`AggregateConfigurer<A>`	`configureRepository(Function<Configuration,Repository<A>> repositoryBuilder)` Defines the repository to use to load and store Aggregates of this type.
`AggregateConfigurer<A>`	`configureSnapshotTrigger(Function<Configuration,SnapshotTriggerDefinition> snapshotTriggerDefinition)` Configures snapshotting for the Aggregate type under configuration.
`static <A> AggregateConfigurer<A>`	`defaultConfiguration(Class<A> aggregateType)` Creates a default Configuration for an aggregate of the given `aggregateType`.
`void`	`initialize(Configuration parent)` Initialize the module configuration using the given global `config`
`static <A> AggregateConfigurer<A>`	`jpaMappedConfiguration(Class<A> aggregateType)` Creates a Configuration for an aggregate of given `aggregateType`, which is mapped to a relational database using an EntityManager obtained from the main configuration.
`static <A> AggregateConfigurer<A>`	`jpaMappedConfiguration(Class<A> aggregateType, EntityManagerProvider entityManagerProvider)` Creates a Configuration for an aggregate of given `aggregateType`, which is mapped to a relational database using an EntityManager provided by given `entityManagerProvider`.
`Repository<A>`	`repository()` Returns the repository defined to load instances of the Aggregate type defined in this configuration
`void`	`shutdown()` Invoked prior to shutdown of the application.
`void`	`start()` Invoked when the Configuration is started.

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.ModuleConfiguration
isType, phase, unwrap

- Constructor Detail
  - AggregateConfigurer
```
protected AggregateConfigurer(Class<A> aggregate)
```
    Creates a default configuration as described in defaultConfiguration(Class). This constructor is available for subclasses that provide additional configuration possibilities.
    
    Parameters:
    
    aggregate - The type of aggregate to configure
- Method Detail
  - defaultConfiguration
```
public static <A> AggregateConfigurer<A> defaultConfiguration(Class<A> aggregateType)
```
    Creates a default Configuration for an aggregate of the given aggregateType. This required either a Repository to be configured using configureRepository(Function), or that the Global Configuration contains an Event Store and the Aggregate support Event Sourcing.
    
    Type Parameters:
    
    A - The type of Aggregate to configure
    
    Parameters:
    
    aggregateType - The type of Aggregate to configure
    
    Returns:
    
    An AggregateConfigurer instance for further configuration of the Aggregate
  - jpaMappedConfiguration
```
public static <A> AggregateConfigurer<A> jpaMappedConfiguration(Class<A> aggregateType)
```
    Creates a Configuration for an aggregate of given aggregateType, which is mapped to a relational database using an EntityManager obtained from the main configuration. The given aggregateType is expected to be a proper JPA Entity.
    The EntityManagerProvider is expected to have been registered with the Configurer (which would be the case when using DefaultConfigurer.jpaConfiguration(EntityManagerProvider). If that is not the case, consider using jpaMappedConfiguration(Class, EntityManagerProvider) instead.
    
    Type Parameters:
    
    A - The type of Aggregate to configure
    
    Parameters:
    
    aggregateType - The type of Aggregate to configure
    
    Returns:
    
    An AggregateConfigurer instance for further configuration of the Aggregate
  - jpaMappedConfiguration
```
public static <A> AggregateConfigurer<A> jpaMappedConfiguration(Class<A> aggregateType,
                                                                EntityManagerProvider entityManagerProvider)
```
    Creates a Configuration for an aggregate of given aggregateType, which is mapped to a relational database using an EntityManager provided by given entityManagerProvider. The given aggregateType is expected to be a proper JPA Entity.
    
    Type Parameters:
    
    A - The type of Aggregate to configure
    
    Parameters:
    
    aggregateType - The type of Aggregate to configure
    
    entityManagerProvider - The provider for Axon to retrieve the EntityManager from
    
    Returns:
    
    An AggregateConfigurer instance for further configuration of the Aggregate
  - configureRepository
```
public AggregateConfigurer<A> configureRepository(Function<Configuration,Repository<A>> repositoryBuilder)
```
    Defines the repository to use to load and store Aggregates of this type. The builder function receives the global configuration object from which it can retrieve components the repository depends on.
    
    Parameters:
    
    repositoryBuilder - The builder function for the repository
    
    Returns:
    
    this configurer instance for chaining
  - configureAggregateFactory
```
public AggregateConfigurer<A> configureAggregateFactory(Function<Configuration,AggregateFactory<A>> aggregateFactoryBuilder)
```
    Defines the factory to use to to create new Aggregates instances of the type under configuration.
    
    Parameters:
    
    aggregateFactoryBuilder - The builder function for the AggregateFactory
    
    Returns:
    
    this configurer instance for chaining
  - configureCommandHandler
```
public AggregateConfigurer<A> configureCommandHandler(Function<Configuration,AggregateAnnotationCommandHandler> aggregateCommandHandlerBuilder)
```
    Defines the AggregateAnnotationCommandHandler instance to use.
    
    Parameters:
    
    aggregateCommandHandlerBuilder - The builder function for the AggregateCommandHandler
    
    Returns:
    
    this configurer instance for chaining
  - configureCommandTargetResolver
```
public AggregateConfigurer<A> configureCommandTargetResolver(Function<Configuration,CommandTargetResolver> commandTargetResolverBuilder)
```
    Defines the CommandTargetResolver to use for the Aggregate type under configuration. The CommandTargetResolver defines which Aggregate instance must be loaded to handle a specific Command.
    
    Parameters:
    
    commandTargetResolverBuilder - the builder function for the CommandTargetResolver.
    
    Returns:
    
    this configurer instance for chaining
  - configureSnapshotTrigger
```
public AggregateConfigurer<A> configureSnapshotTrigger(Function<Configuration,SnapshotTriggerDefinition> snapshotTriggerDefinition)
```
    Configures snapshotting for the Aggregate type under configuration.
    Note that this configuration is ignored if a custom repository instance is configured.
    
    Parameters:
    
    snapshotTriggerDefinition - The function creating the SnapshotTriggerDefinition
    
    Returns:
    
    this configurer instance for chaining
  - initialize
```
public void initialize(Configuration parent)
```
    Description copied from interface: ModuleConfiguration
    
    Initialize the module configuration using the given global config
    
    Specified by:
    
    initialize in interface ModuleConfiguration
    
    Parameters:
    
    parent - the global configuration, providing access to generic components
  - start
```
public void start()
```
    Description copied from interface: ModuleConfiguration
    
    Invoked when the Configuration is started.
    
    Specified by:
    
    start in interface ModuleConfiguration
    
    See Also:
    
    Configuration.start()
  - shutdown
```
public void shutdown()
```
    Description copied from interface: ModuleConfiguration
    
    Invoked prior to shutdown of the application.
    
    Specified by:
    
    shutdown in interface ModuleConfiguration
    
    See Also:
    
    Configuration.shutdown()
  - repository
```
public Repository<A> repository()
```
    Description copied from interface: AggregateConfiguration
    
    Returns the repository defined to load instances of the Aggregate type defined in this configuration
    
    Specified by:
    
    repository in interface AggregateConfiguration<A>
    
    Returns:
    
    the repository to load aggregates
  - aggregateType
```
public Class<A> aggregateType()
```
    Description copied from interface: AggregateConfiguration
    
    Returns the type of Aggregate defined in this Configuration.
    
    Specified by:
    
    aggregateType in interface AggregateConfiguration<A>
    
    Returns:
    
    the type of Aggregate defined in this Configuration

Class AggregateConfigurer<A>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.axonframework.config.ModuleConfiguration

Constructor Detail

AggregateConfigurer

Method Detail

defaultConfiguration

jpaMappedConfiguration

jpaMappedConfiguration

configureRepository

configureAggregateFactory

configureCommandHandler

configureCommandTargetResolver

configureSnapshotTrigger

initialize

start

shutdown

repository

aggregateType