server/io.spine.system.server/MirrorRepository

MirrorRepository

public final class MirrorRepository extends ProjectionRepository<I, P, S>

The repository for Mirror projections.

The mirrored entity types are gathered at runtime and are usually registered by the corresponding entity repositories.

The catch-up is disabled for the instances of this repository.

Constructors

MirrorRepository

public void MirrorRepository()

Functions

protected TypeUrl inboxStateType()

Returns the custom type URL for Mirror type to use during the Inbox registration in Delivery.

isCatchUpEnabled

protected boolean isCatchUpEnabled()

Tells whether the catch-up feature is enabled for this repository.

public boolean isMirroring(TypeUrl type)

Returns true if the given type is mirrored by this MirrorRepository.

registerMirroredType

public void registerMirroredType(Repository<? extends Object, ? extends Object> repository)

Registers a repository state type as mirrored by this MirrorRepository.

setupEventRouting

protected void setupEventRouting(EventRouting<MirrorId> routing)

A callback for derived repository classes to customize routing schema for events.

Inherited functions

public final void applyMigration<T extends TransactionalEntity<I, S, ? extends Object>>(I id, Migration<I, T, S> migration)

Applies a given Migration to an entity with the given ID.

public final void applyMigration<T extends TransactionalEntity<I, S, ? extends Object>>(Set<I> ids, Migration<I, T, S> migration)

Applies a Migration to several entities in batch.

public boolean canDispatch(E envelope)

public final boolean canDispatch(EventEnvelope event)

Checks if this dispatcher can dispatch the given message.

public CatchUpId catchUp(Timestamp since, Set<I> ids)

Repeats the dispatching of the events from the event log to the requested entities since the specified time.

public CatchUpId catchUpAll(Timestamp since)

Starts the catch-up of all entities in this repository.

checkNotRegistered

public void checkNotRegistered()

Verifies that this instance is NOT registered yet.

public void checkOpen()

Ensures that the object is open.

checkRegistered

public void checkRegistered()

Verifies that this instance is already registered.

protected static S checkStorage<S extends AutoCloseable>(S storage)

Ensures that the storage is not null.

public void close()

Closes the repository by closing the underlying storage.

public abstract void close()

protected final BoundedContext context()

Obtains the BoundedContext to which this repository belongs.

public E create(I id)

public P create(I id)

Create a new entity instance with its default state.

protected RecordStorage<I> createStorage()

protected abstract Storage<I, ? extends Object, ? extends Object> createStorage()

protected final ProjectionStorage<I> createStorage()

Creates the storage for this repository.

defaultStorageFactory

protected static StorageFactory defaultStorageFactory()

Obtains StorageFactory associated with the ServerEnvironment for creating standard storages.

public abstract DispatchOutcome dispatch(E envelope)

Dispatches the message contained in the passed envelope and returns the outcome.

public final DispatchOutcome dispatch(EventEnvelope event)

Dispatches the event to the corresponding entities.

dispatchesEvents

public boolean dispatchesEvents()

Verifies if this instance dispatches at least one event.

dispatchesExternalEvents

public boolean dispatchesExternalEvents()

Verifies if this instance dispatches at least one external event.

protected final DispatchOutcome dispatchTo(Set<I> ids, EventEnvelope event)

Dispatches the given event to entities with the given identifiers, and returns the dispatch outcome.

domesticEventClasses

public final ImmutableSet<EventClass> domesticEventClasses()

Obtains classes of domestic events processed by this dispatcher.

public final Class<E> entityClass()

Returns the class of entities managed by this repository.

protected EntityFactory<E> entityFactory()

Obtains EntityFactory associated with this repository.

entityModelClass

public EntityClass<E> entityModelClass()

Obtains model class for the entities managed by this repository.

entityStateType

public final TypeUrl entityStateType()

Obtains the TypeUrl for the state objects wrapped by entities managed by this repository.

public ImmutableSet<EventClass> eventClasses()

Obtains classes of all events processed by this dispatcher.

public EventFilter eventFilter()

Creates an EventFilter for this repository.

externalEventClasses

public final ImmutableSet<EventClass> externalEventClasses()

Obtains classes of external events processed by this dispatcher.

public Optional<E> find(I id)

Finds an entity with the passed ID.

public Iterator<E> find(TargetFilters filters, ResponseFormat format)

Finds the entities passing the given filters and applies the given FieldMask to the results.

public Optional<E> findActive(I id)

Finds an entity with the passed ID even if the entity is active.

protected E findOrCreate(I id)

protected final P findOrCreate(I id)

Loads an entity by the passed ID or creates a new one, if the entity was not found.

public Iterator<EntityRecord> findRecords(TargetFilters filters, ResponseFormat format)

Obtains iterator over entity records matching the passed filters.

protected final boolean hasContext()

Verifies whether the repository is registered with a BoundedContext.

public final Class<I> idClass()

Returns the class of IDs used by this repository.

public Iterator<I> index()

Returns an iterator over the identifiers of all the entities managed by this repository.

public final boolean isOpen()

Verifies if the repository is open.

public boolean isRegistered()

Tells if the repository is registered in a BoundedContext.

protected boolean isTypeSupplier()

Tells if this repository should be registered as a type supplier with a Stand of the BoundedContext to which this repository belongs.

public Iterator<E> iterator(Predicate<E> filter)

Returns an iterator over the entities managed by the repository that match the passed filter.

public EntityLifecycle lifecycleOf(I id)

Obtains an instance of EntityLifecycle for the entity with the given ID.

public Iterator<E> loadAll(ResponseFormat format)

public Iterator<E> loadAll(Iterable<I> ids, FieldMask fieldMask)

Loads all the entities in this repository with IDs, contained within the passed ids values.

public Iterator<EntityRecord> loadAllRecords(ResponseFormat format)

Obtains iterator over all present entity records.

public abstract ImmutableSet<C> messageClasses()

public final ImmutableSet<EventClass> messageClasses()

Obtains a set of message classes that can be processed by this dispatcher.

public void onRegistered()

The callback is invoked by a BoundedContext when adding the repository.

onRoutingFailed

protected void onRoutingFailed(SignalEnvelope<? extends Object, ? extends Object, ? extends Object> envelope, Throwable cause)

A callback invoked when an exception is thrown from message routing.

protected final void open()

Initializes the storage of the repository.

protected final RecordStorage<I> recordStorage()

Ensures that the repository has the storage.

public void registerWith(BoundedContext context)

Initializes the repository.

protected Set<I> route(EventEnvelope event)

Determines the targets of the given event.

protected final Optional<R> route<M extends Message, C extends MessageContext, R>(Route<M, C, R> routing, SignalEnvelope<? extends Object, ? extends Object, C> envelope)

setupStateRouting

protected void setupStateRouting(StateUpdateRouting<I> routing)

A callback for derived repository classes to customize routing schema for delivering updated state to subscribed entities, if the default schema does not satisfy the routing needs.

protected final Stand stand()

Obtains the Stand from the BoundedContext of this repository.

protected final Storage<I, ? extends Object, ? extends Object> storage()

Returns the storage assigned to this repository.

storageAssigned

public final boolean storageAssigned()

Returns true if the storage is assigned, false otherwise.

storageConverter

protected final StorageConverter<I, E, S> storageConverter()

Obtains StorageConverter associated with this repository.

public void store(E entity)

protected abstract void store(E obj)

public final void store(P entity)

Stores the passed object.

public void store(Collection<E> entities)

Stores Entities in bulk.

protected E toEntity(EntityRecord record)

Converts the passed record into an entity.

protected EntityClass<E> toModelClass(Class<E> cls)

protected final ProjectionClass<P> toModelClass(Class<P> cls)

Obtains a model class for the passed entity class value.