A callback method for configuring a recently created ProcessManager instance before it is returned by the repository as the result of creating a new process manager instance or finding existing one.

create

public P create(I id)

Create a new entity instance with its default state.

dispatchCommand

public final DispatchOutcome dispatchCommand(CommandEnvelope command)

Dispatches the command to a corresponding process manager.

dispatchTo

protected final DispatchOutcome dispatchTo(Set 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 to which the process managers managed by this repository react.

eventBus

public final EventBus eventBus()

Obtains the EventBus to which the repository posts.

externalEventClasses

public final ImmutableSet<EventClass> externalEventClasses()

Obtains classes of external events to which the process managers managed by this repository react.

findOrCreate

protected final P findOrCreate(I id)

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

messageClasses

public final ImmutableSet<EventClass> messageClasses()

Obtains a set of event classes to which process managers of this repository react.

onRoutingFailed

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

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

outgoingEvents

public ImmutableSet<EventClass> outgoingEvents()

Obtains classes of the events produced by entities of this repository.

registerWith

public void registerWith(BoundedContext context)

Registers itself as an event dispatcher with the parent BoundedContext}.

setupCommandRouting

protected void setupCommandRouting(CommandRouting routing)

A callback for derived classes to customize routing schema for commands.

setupEventRouting

protected void setupEventRouting(EventRouting routing)

Replaces default routing with the one which takes the target ID from the first field of an event message.

store

public final void store(P entity)

Stores the passed object.

toEntity

protected final P toEntity(EntityRecord record)

Creates and configures an instance of the process manager by the passed record.

toModelClass

protected final ProcessManagerClass toModelClass(Class cls)

Obtains a model class for the passed entity class value.

Inherited functions

applyMigration

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 ids, Migration<I, T, S> migration)

Applies a Migration to several entities in batch.

canDispatch

public boolean canDispatch(E envelope)

Checks if this dispatcher can dispatch the given message.

checkNotRegistered

public void checkNotRegistered()

Verifies that this instance is NOT registered yet.

checkOpen

public void checkOpen()

Ensures that the object is open.

checkRegistered

public void checkRegistered()

Verifies that this instance is already registered.

checkStorage

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

Ensures that the storage is not null.

public abstract void close()

context

protected final BoundedContext context()

Obtains the BoundedContext to which this repository belongs.

createStorage

protected RecordStorage createStorage()

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

Creates the storage for this repository.

defaultStorageFactory

protected static StorageFactory defaultStorageFactory()

Obtains StorageFactory associated with the ServerEnvironment for creating standard storages.

dispatch

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.

dispatchesCommands

public boolean dispatchesCommands()

Tells if this instance dispatches at least one command.

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.

entityClass

public final Class<E> entityClass()

Returns the class of entities managed by this repository.

entityFactory

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.

eventClasses

public ImmutableSet<EventClass> eventClasses()

Obtains classes of all events processed by this dispatcher.

eventFilter

public abstract EventFilter eventFilter()

Declared for mixing-in with eventFilter.

filter

public Iterable<Event> filter(Collection<Event> events)

Filters passed events using the eventFilter filter} of this repository.

find

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.

findActive

public Optional<E> findActive(I id)

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

findRecords

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

Obtains iterator over entity records matching the passed filters.

hasContext

protected final boolean hasContext()

Verifies whether the repository is registered with a BoundedContext.

idClass

public final Class idClass()

Returns the class of IDs used by this repository.

index

public Iterator index()

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

isOpen

public final boolean isOpen()

Verifies if the repository is open.

isRegistered

public boolean isRegistered()

Tells if the repository is registered in a BoundedContext.

isTypeSupplier

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.

iterator

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

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

lifecycleOf

public EntityLifecycle lifecycleOf(I id)

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

loadAll

public Iterator<E> loadAll(ResponseFormat format)

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

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

loadAllRecords

public Iterator<EntityRecord> loadAllRecords(ResponseFormat format)

Obtains iterator over all present entity records.

onRegistered

public void onRegistered()

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

open

protected final void open()

Initializes the storage of the repository.

postEvents

public void postEvents(Collection<Event> events)

Filters the passed events and posts the result to the EventBus.

postIfCommandRejected

public void postIfCommandRejected(SignalEnvelope<? extends Object, ? extends Object, ? extends Object> signal, Throwable cause)

If the passed signal is a command and the thrown cause is a rejection, posts the rejection to the associated EventBus.

recordStorage

protected RecordStorage recordStorage()

Ensures that the repository has the storage.

route

protected Set 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)

storage