server/io.spine.server.entity

Package-level declarations

This package contains classes and interfaces defining entity-oriented API and base functionality.

Types

AbstractEntity

public abstract class AbstractEntity<I, S extends EntityState> implements Entity<I, S>, HandlerLifecycle

Abstract base for entities.

CommandDispatchingPhase

public final class CommandDispatchingPhase extends Phase

A phase that dispatched a command to the entity in transaction.

CompositeEventFilter

public final class CompositeEventFilter implements EventFilter

An EventFilter which composes several other filters.

DefaultEntityFactory

public final class DefaultEntityFactory<E extends Entity> extends AbstractEntityFactory<E>

Default implementation of entity factory which creates entities by invoking constructor which accepts entity ID.

DefaultRecordBasedRepository

public abstract class DefaultRecordBasedRepository<I, E extends AbstractEntity<I, S>, S extends EntityState> extends RecordBasedRepository<I, E, S>

Implementation of RecordBasedRepository that manages entities derived from AbstractEntity.

Entity

public interface Entity<I, S extends EntityState> implements WithLifecycle

A server-side object with an identity.

EntityFactory

public interface EntityFactory<E extends Entity> implements Serializable

Base interface for objects that can create entities.

EntityLifecycle

public class EntityLifecycle

The lifecycle callbacks of an Entity.

EntityLifecycleMonitor

public final class EntityLifecycleMonitor implements TransactionListener

An implementation of TransactionListener which monitors the transaction flow and triggers the EntityLifecycle.

EntityMessageEndpoint

public abstract class EntityMessageEndpoint<I, E extends Entity<I, ? extends Object>, M extends SignalEnvelope<? extends Object, ? extends Object, ? extends Object>> extends AbstractMessageEndpoint<I, M>

Abstract base for endpoints handling messages sent to entities.

EntityVisibility

public final class EntityVisibility implements Serializable

The visibility of an entity type.

EventBlackList

public final class EventBlackList implements EventFilter

An EventFilter which allows any events except for the events of given types.

EventDispatchingPhase

public final class EventDispatchingPhase<I, E extends TransactionalEntity<I, ? extends Object, ? extends Object>> extends Phase

A phase that dispatches an event to the entity in transaction.

EventDispatchingRepository

public abstract class EventDispatchingRepository<I, E extends AbstractEntity<I, S>, S extends EntityState> extends DefaultRecordBasedRepository<I, E, S> implements EventDispatcher

Abstract base for repositories that deliver events to entities they manage.

EventFieldFilter

public final class EventFieldFilter implements EventFilter

An EventFilter which allows all the events but trims some of their message fields.

EventFilter

@FunctionalInterface()

public interface EventFilter

A filter accepting Events posted by a Repository.

EventPlayer

public interface EventPlayer

Plays events upon a certain entity.

EventPlayingTransaction

public abstract class EventPlayingTransaction<I, E extends TransactionalEntity<I, S, B>, S extends EntityState, B extends ValidatingBuilder<S>> extends Transaction<I, E, S, B>

A transaction that supports event playing.

EventProducingRepository

public interface EventProducingRepository

Operations common for repositories that can post to EventBus.

EventWhiteList

public final class EventWhiteList implements EventFilter

An EventFilter which allows only events of given types.

FieldMasks

public final class FieldMasks

A utility class for creating instances of FieldMask and processing them against instances of Message.

HasLifecycleColumns

public interface HasLifecycleColumns<I, S extends EntityState> implements Entity<I, S>

Marks an Entity that declares columns for lifecycle flags.

HasVersionColumn

public interface HasVersionColumn<I, S extends EntityState> implements Entity<I, S>

Marks an Entity that declares a Version column.

InvalidEntityStateException

public final class InvalidEntityStateException

Signals that an entity state does not pass validation.

Migration

public abstract class Migration<I, E extends TransactionalEntity<I, S, ? extends Object>, S extends EntityState> implements Function<T, R>

A stored Entity transformation done to account for the domain model changes.

Phase

public abstract class Phase

An atomic entity state change which advances the entity version.

RecentHistory

public final class RecentHistory

A copy of recent history of an event-sourced entity.

RecordBasedRepository

public abstract class RecordBasedRepository<I, E extends Entity<I, S>, S extends EntityState> extends Repository<I, E>

The base class for repositories that store entities as records.

Repository

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

Abstract base class for repositories.

RepositoryCache

public final class RepositoryCache<I, E extends Entity<I, ? extends Object>>

The cache of Entity objects for a certain Repository and selected identifiers.

StorageConverter

public abstract class StorageConverter<I, E extends Entity<I, S>, S extends EntityState> implements Serializable

An abstract base for converters of entities into EntityRecord.

Transaction

public abstract class Transaction<I, E extends TransactionalEntity<I, S, B>, S extends EntityState, B extends ValidatingBuilder<S>>

The abstract class for the entity transactions.

TransactionalEntity

public abstract class TransactionalEntity<I, S extends EntityState, B extends ValidatingBuilder<S>> extends AbstractEntity<I, S>

A base for entities, perform transactions events.

TransactionListener

public interface TransactionListener

A common contract for the transaction listeners.

VersionIncrement

public abstract class VersionIncrement

A strategy for incrementing a version of an entity being modified in a transaction.

WithLifecycle

public interface WithLifecycle

Something with LifecycleFlags.