AggregateRepository (server 1.8.2 API)

java.lang.Object
- io.spine.server.entity.Repository<I,A>
- - io.spine.server.aggregate.AggregateRepository<I,A>

Type Parameters:

I - the type of the aggregate IDs

A - the type of the aggregates managed by this repository

All Implemented Interfaces:

io.spine.logging.Logging, MessageDispatcher<CommandClass,CommandEnvelope>, UnicastDispatcher<CommandClass,CommandEnvelope>, Closeable, CommandDispatcher, EventProducingRepository, java.lang.AutoCloseable

Direct Known Subclasses:

AggregatePartRepository
```
public abstract class AggregateRepository<I,A extends Aggregate<I,?,?>>
extends Repository<I,A>
implements CommandDispatcher, EventProducingRepository
```
The repository which manages instances of Aggregates.

See Also:

Aggregate

Constructor Summary

Constructors
Modifier Constructor and Description

protected AggregateRepository()
Creates a new instance.

Constructors
Modifier	Constructor and Description
`protected`	`AggregateRepository()` Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected AggregateClass<A>`	`aggregateClass()` Obtains class information of aggregates managed by this repository.
`protected AggregateStorage<I>`	`aggregateStorage()` Returns the storage assigned to this aggregate.
`void`	`close()` Closes the repository by closing the underlying storage.
`A`	`create(I id)` Create a new entity instance with its default state.
`protected AggregateStorage<I>`	`createStorage()` Creates aggregate storage for the repository.
`void`	`dispatch(CommandEnvelope cmd)` Dispatches the passed command to an aggregate.
`void`	`dispatchEvent(EventEnvelope event)` Dispatches event to one or more aggregates reacting on the event.
`protected A`	`doLoadOrCreate(I id)`
`com.google.common.collect.ImmutableSet<EventClass>`	`domesticEvents()`
`protected void`	`doStore(A aggregate)`
`EventBus`	`eventBus()` Obtains the `EventBus` to which the repository posts.
`com.google.common.collect.ImmutableSet<EventClass>`	`events()`
`com.google.common.collect.ImmutableSet<EventClass>`	`externalEvents()`
`java.util.Optional<A>`	`find(I id)` Loads an aggregate by the passed ID.
`com.google.common.collect.ImmutableSet<EventClass>`	`importableEvents()` Obtains classes of events that can be imported by aggregates of this repository.
`com.google.common.collect.ImmutableSet<CommandClass>`	`messageClasses()` Obtains a set of message classes that can be processed by this dispatcher.
`com.google.common.collect.ImmutableSet<EventClass>`	`outgoingEvents()` Obtains classes of the events produced by entities of this repository.
`protected A`	`play(I id, io.spine.server.aggregate.AggregateHistory history)` Plays the given Aggregate history for an instance of `Aggregate` with the given ID.
`void`	`registerWith(BoundedContext context)` Initializes the repository during its registration with its context.
`protected void`	`setSnapshotTrigger(int snapshotTrigger)` Changes the number of events between making aggregate snapshots to the passed value.
`protected void`	`setupCommandRouting(CommandRouting<I> routing)` A callback for derived classes to customize routing schema for commands.
`protected void`	`setupEventRouting(EventRouting<I> routing)` A callback for derived classes to customize routing schema for events.
`protected void`	`setupImportRouting(EventRouting<I> routing)` A callback for derived classes to customize routing schema for importable events.
`protected int`	`snapshotTrigger()` Returns the number of events until a next `Snapshot` is made.
`protected void`	`store(A aggregate)` Stores the passed aggregate and commits its uncommitted events.
`protected AggregateClass<A>`	`toModelClass(java.lang.Class<A> cls)` Obtains a model class for the passed entity class value.

Methods inherited from class io.spine.server.entity.Repository
checkStorage, context, entityClass, entityStateType, eventFilter, hasContext, idClass, index, isOpen, isRegistered, iterator, onRegistered, open, storage, storageAssigned

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

Methods inherited from interface io.spine.server.commandbus.CommandDispatcher
dispatchesCommands

Methods inherited from interface io.spine.server.bus.MessageDispatcher
canDispatch

Methods inherited from interface io.spine.server.entity.EventProducingRepository
eventFilter, filter, postEvents, postIfCommandRejected

Methods inherited from interface io.spine.server.Closeable
checkOpen

Methods inherited from interface io.spine.logging.Logging
_config, _debug, _error, _fine, _finer, _finest, _info, _severe, _trace, _warn, debugLevel, errorLevel, logger, loggerFor

- Constructor Detail
 - AggregateRepository
```
protected AggregateRepository()
```
 Creates a new instance.
- Method Detail
 - registerWith
```
@OverridingMethodsMustInvokeSuper
public void registerWith(BoundedContext context)
```
 Initializes the repository during its registration with its context.
 Verifies that the class of aggregates of this repository subscribes to at least one type of messages.
 Registers itself with CommandBus, EventBus, and ImportBus of the context for dispatching messages to its aggregates.
 
 Overrides:
 
 registerWith in class Repository<I,A extends Aggregate<I,?,?>>
 
 Parameters:
 
 context - the context of this repository
 
 Throws:
 
 java.lang.IllegalStateException - if the aggregate class does not handle any messages
 - eventBus
```
public final EventBus eventBus()
```
 Description copied from interface: EventProducingRepository
 
 Obtains the EventBus to which the repository posts.
 
 Specified by:
 
 eventBus in interface EventProducingRepository
 - setupCommandRouting
```
protected void setupCommandRouting(CommandRouting routing)
```
 A callback for derived classes to customize routing schema for commands.
 Default routing returns the value of the first field of a command message.
 
 Parameters:
 
 routing - the routing schema to customize
 - setupEventRouting
```
protected void setupEventRouting(EventRouting routing)
```
 A callback for derived classes to customize routing schema for events.
 Default routing returns the ID of the entity which produced the event. This allows to “link” different kinds of entities by having the same class of IDs. More complex scenarios (e.g. one-to-many relationships) may require custom routing schemas.
 
 Parameters:
 
 routing - the routing schema to customize
 - setupImportRouting
```
protected void setupImportRouting(EventRouting routing)
```
 A callback for derived classes to customize routing schema for importable events.
 The default routing uses producer ID of the event as the ID of the target aggregate.
 This default routing requires that Event instances Bus.post(io.spine.core.Signal, io.grpc.stub.StreamObserver) posted} for import must contain the ID of the target aggregate. Not providing a valid aggregate ID would result in RuntimeException.
 Some aggregates may produce events with the aggregate ID as the first field of an event message. To set the default routing for repositories of such aggregates, please use the code below:
```
 routing.replaceDefault(EventRoute.byFirstMessageField(SomeId.class));
 
```
 Parameters:
 
 routing - the routing schema to customize.
 - create
```
public A create(I id)
```
 Description copied from class: Repository
 
 Create a new entity instance with its default state.
 
 Specified by:
 
 create in class Repository<I,A extends Aggregate<I,?,?>>
 
 Parameters:
 
 id - the id of the entity
 
 Returns:
 
 new entity instance
 - aggregateClass
```
protected final AggregateClass<A> aggregateClass()
```
 Obtains class information of aggregates managed by this repository.
 - toModelClass
```
protected AggregateClass<A> toModelClass(java.lang.Class<A> cls)
```
 Description copied from class: Repository
 
 Obtains a model class for the passed entity class value.
 
 Overrides:
 
 toModelClass in class Repository<I,A extends Aggregate<I,?,?>>
 - store
```
protected final void store(A aggregate)
```
 Stores the passed aggregate and commits its uncommitted events.
 
 Specified by:
 
 store in class Repository<I,A extends Aggregate<I,?,?>>
 
 Parameters:
 
 aggregate - an instance to store
 - doStore
```
protected void doStore(A aggregate)
```
 - createStorage
```
protected AggregateStorage createStorage()
```
 Creates aggregate storage for the repository.
 
 Specified by:
 
 createStorage in class Repository<I,A extends Aggregate<I,?,?>>
 
 Returns:
 
 new storage
 - messageClasses
```
public final com.google.common.collect.ImmutableSet<CommandClass> messageClasses()
```
 Description copied from interface: MessageDispatcher
 
 Obtains a set of message classes that can be processed by this dispatcher.
 
 Specified by:
 
 messageClasses in interface MessageDispatcher<CommandClass,CommandEnvelope>
 
 Returns:
 
 non-empty set of message classes
 - dispatch
```
public final void dispatch(CommandEnvelope cmd)
```
 Dispatches the passed command to an aggregate.
 The aggregate ID is obtained from the passed command.
 The repository loads the aggregate by this ID, or creates a new aggregate if there is no aggregate with such ID.
 
 Specified by:
 
 dispatch in interface MessageDispatcher<CommandClass,CommandEnvelope>
 
 Parameters:
 
 cmd - the command to dispatch
 - events
```
public com.google.common.collect.ImmutableSet<EventClass> events()
```
 - domesticEvents
```
public com.google.common.collect.ImmutableSet<EventClass> domesticEvents()
```
 - externalEvents
```
public com.google.common.collect.ImmutableSet<EventClass> externalEvents()
```
 - importableEvents
```
public com.google.common.collect.ImmutableSet<EventClass> importableEvents()
```
 Obtains classes of events that can be imported by aggregates of this repository.
 - outgoingEvents
```
public com.google.common.collect.ImmutableSet<EventClass> outgoingEvents()
```
 Description copied from interface: EventProducingRepository
 
 Obtains classes of the events produced by entities of this repository.
 
 Specified by:
 
 outgoingEvents in interface EventProducingRepository
 - dispatchEvent
```
public void dispatchEvent(EventEnvelope event)
```
 Dispatches event to one or more aggregates reacting on the event.
 
 Parameters:
 
 event - the event to dispatch
 - snapshotTrigger
```
protected int snapshotTrigger()
```
 Returns the number of events until a next Snapshot is made.
 
 Returns:
 
 a positive integer value
 
 See Also:
 
 AggregateRepository.DEFAULT_SNAPSHOT_TRIGGER
 - setSnapshotTrigger
```
protected void setSnapshotTrigger(int snapshotTrigger)
```
 Changes the number of events between making aggregate snapshots to the passed value.
 The default value is defined in AggregateRepository.DEFAULT_SNAPSHOT_TRIGGER.
 NOTE: repository read operations are optimized around the current snapshot trigger. Setting the snapshot trigger to a new value may cause read operations to perform sub-optimally, until a new snapshot is created. This doesn't apply to newly created repositories.
 
 Parameters:
 
 snapshotTrigger - a positive number of the snapshot trigger
 - aggregateStorage
```
protected AggregateStorage aggregateStorage()
```
 Returns the storage assigned to this aggregate.
 
 Returns:
 
 storage instance
 
 Throws:
 
 java.lang.IllegalStateException - if the storage is null
 - doLoadOrCreate
```
protected A doLoadOrCreate(I id)
```
 - play
```
protected A play(I id,
 io.spine.server.aggregate.AggregateHistory history)
```
 Plays the given Aggregate history for an instance of Aggregate with the given ID.
 
 Parameters:
 
 id - the ID of the Aggregate to load
 
 history - the state record of the Aggregate to load
 
 Returns:
 
 an instance of Aggregate
 - find
```
public java.util.Optional<A> find(I id)
 throws java.lang.IllegalStateException
```
 Loads an aggregate by the passed ID.
 An aggregate will be loaded even if archived or deleted lifecycle attribute, or both of them, are set to true.
 
 Specified by:
 
 find in class Repository<I,A extends Aggregate<I,?,?>>
 
 Parameters:
 
 id - the ID of the aggregate to load
 
 Returns:
 
 the aggregate instance, or empty() if there is no aggregate with such ID
 
 Throws:
 
 java.lang.IllegalStateException
 - close
```
@OverridingMethodsMustInvokeSuper
public void close()
```
 Description copied from class: Repository
 
 Closes the repository by closing the underlying storage.
 The reference to the storage becomes null after this call.
 
 Specified by:
 
 close in interface java.lang.AutoCloseable
 
 Overrides:
 
 close in class Repository<I,A extends Aggregate<I,?,?>>

Class AggregateRepository<I,A extends Aggregate<I,?,?>>

Constructor Summary

Method Summary

Methods inherited from class io.spine.server.entity.Repository

Methods inherited from class java.lang.Object

Methods inherited from interface io.spine.server.commandbus.CommandDispatcher

Methods inherited from interface io.spine.server.bus.MessageDispatcher

Methods inherited from interface io.spine.server.entity.EventProducingRepository

Methods inherited from interface io.spine.server.Closeable

Methods inherited from interface io.spine.logging.Logging

Constructor Detail

AggregateRepository

Method Detail

registerWith

eventBus

setupCommandRouting

setupEventRouting

setupImportRouting

create

aggregateClass

toModelClass

store

doStore

createStorage

messageClasses

dispatch

events

domesticEvents

externalEvents

importableEvents

outgoingEvents

dispatchEvent

snapshotTrigger

setSnapshotTrigger

aggregateStorage

doLoadOrCreate

play

find

close