server/io.spine.server.entity/Repository

Repository

public abstract class Repository<I, E extends Entity<I, ? extends Object>> implements ContextAware, Closeable

Abstract base class for repositories.

Inheritors

RecordBasedRepository

AggregateRepository

Constructors

protected void Repository()

Creates the repository.

Functions

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.

protected final BoundedContext context()

Obtains the BoundedContext to which this repository belongs.

public abstract E create(I id)

Create a new entity instance with its default state.

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.

public final Class<E> entityClass()

Returns the class of entities managed by 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 EventFilter eventFilter()

Creates an EventFilter for this repository.

public abstract Optional<E> find(I id)

Finds an entity with the passed ID.

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 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.

public void registerWith(BoundedContext context)

Assigns a BoundedContext to this repository.

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

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.

protected abstract void store(E obj)

Stores the passed object.

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

Obtains a model class for the passed entity class value.

Inherited functions

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.