server/io.spine.server.aggregate/AggregatePart

AggregatePart

public abstract class AggregatePart<I, S extends EntityState, B extends ValidatingBuilder<S>, R extends AggregateRoot> extends Aggregate<I, S, B>

A part of a larger aggregate.

Some business logic objects may be big enough. If not all parts of such a business object need to be preserved at the same time as business logic invariants, such an object can be split into several parts.

Each such part would:

be a class derived from AggregatePart
have the same aggregate ID as other parts belonging to the same business object
have own state defined as a Protobuf message
managed by a separate repository class derived from AggregateRepository

To access parts of the aggregate, AggregateRoot should be used.

If your business logic cannot be split into parts, it can be modified separately. Consider extending Aggregate instead of several AggregateParts.

Parameters

the type for IDs of this class of aggregates

<S>

the type of the state held by the aggregate part

the type of the aggregate part state builder

<R>

the type of the aggregate root

Constructors

AggregatePart

protected void AggregatePart(R root)

Creates a new instance of the aggregate part.

Types

GenericParameter

public enum GenericParameter

Enumeration of generic type parameters of this class.

Inherited properties

lifecycleFlags

public volatile LifecycleFlags lifecycleFlags

The lifecycle flags of the entity.

Functions

modelClass

protected final AggregatePartClass<? extends Object> modelClass()

Obtains the model class.

partState

protected P partState(Class partStateClass)

Obtains a state of another AggregatePart by its class.

thisClass

protected AggregatePartClass<? extends Object> thisClass()

Obtains model class for this aggregate part.

Inherited functions

afterInvoke

public void afterInvoke(HandlerMethod<? extends Object, ? extends Object, ? extends Object, ? extends Object> method)

A callback for a handler method invocation end.

public final Api at(Level logLevel)

Obtains a new fluent logging API at the given level.

beforeInvoke

public void beforeInvoke(HandlerMethod<? extends Object, ? extends Object, ? extends Object, ? extends Object> method)

A callback for a handler method invocation start.

builder

protected final B builder()

Obtains the instance of the state builder.

changed

public final boolean changed()

Determines whether the state of this entity or its lifecycle flags have been modified since this entity instance creation.

checkEntityState

protected final List<ConstraintViolation> checkEntityState(S newState)

Verifies the new entity state and returns ConstraintViolations, if any.

checkNotArchived

protected void checkNotArchived()

Ensures that the entity is not marked as archived.

checkNotDeleted

protected void checkNotDeleted()

Ensures that the entity is not marked as deleted.

clearRecentHistory

protected final void clearRecentHistory()

Clears #recentHistory() recent history.

defaultState

protected final S defaultState()

Obtains the default state of the entity.

dispatchCommand

protected DispatchOutcome dispatchCommand(CommandEnvelope command)

Obtains a method for the passed command and invokes it.

protected abstract DispatchOutcome dispatchCommand(CommandEnvelope cmd)

Dispatches the passed command to appropriate handler.

ensureAccessToState

protected void ensureAccessToState()

Prohibits invoking state() method from within an applier method.

equals

public boolean equals(Object o)

expectedDefault

protected ValueMismatch expectedDefault(Message actual, Message newValue)

Creates ValueMismatch for the case of discovering a non-default value when the default value was expected by a command.

expectedEmpty

protected ValueMismatch expectedEmpty(String actual, String newValue)

Creates ValueMismatch for the case of discovering a non-empty value, when an empty string was expected by a command.

expectedNotDefault

protected ValueMismatch expectedNotDefault(Message expected)

Creates a ValueMismatch for a command that wanted to clear a value, but discovered that the field already has the default value.

protected ValueMismatch expectedNotDefault(Message expected, Message newValue)

Creates a ValueMismatch for a command that wanted to change a field value, but discovered that the field has the default value.

expectedNotEmpty

protected ValueMismatch expectedNotEmpty(String expected)

Creates a ValueMismatch for a command that wanted to clear a string value but discovered that the field is already empty.

forTransactionOf

public static EventPlayer forTransactionOf(TransactionalEntity<? extends Object, ? extends Object, ? extends Object> entity)

Creates a transactional EventPlayer for the given entity.

getLifecycleFlags

public final LifecycleFlags getLifecycleFlags()

Obtains the current state of the entity lifecycle flags.

hashCode

public int hashCode()

historyBackward

protected final Iterator<Event> historyBackward()

Creates an iterator of the aggregate event history with reverse traversal.

historyContains

protected final boolean historyContains(Predicate<Event> predicate)

Verifies if the aggregate history contains an event which satisfies the passed predicate.

public I id()

Obtains the identifier of the entity.

idAsString

public String idAsString()

Obtains ID of the entity in the string form.

isActive

public boolean isActive()

Verifies if any of the lifecycle attributes is set.

isArchived

public final boolean isArchived()

Tests whether the entity is marked as archived.

isDeleted

public final boolean isDeleted()

Tests whether the entity is marked as deleted.

lifecycleFlags

public LifecycleFlags lifecycleFlags()

Obtains current lifecycle flags.

lifecycleFlagsChanged

public boolean lifecycleFlagsChanged()

Tells whether lifecycle flags of the entity changed since its initialization.

missingTxMessage

protected final String missingTxMessage()

Instructs to modify the state of an aggregate only within an event applier method.

modelClass

protected EntityClass<? extends Object> modelClass()

Obtains the model class.

nothing

public Nothing nothing()

Obtains the io.spine.server.model.

play

public final BatchDispatchOutcome play(Iterable<Event> events)

Plays the given events against the underlying entity.

public DispatchOutcome play(Event event)

Plays the given event.

producedEvents

public ImmutableSet<EventClass> producedEvents()

Obtains classes of the events produced by this object.

producerId

public Any producerId()

The object identity packed into Any.

recentHistory

protected final RecentHistory recentHistory()

Obtains recent history of events of this entity.

remember

protected void remember(Iterable<Event> events)

Adds events to the recent history.

setArchived

protected final void setArchived(boolean archived)

Sets archived} status flag to the passed value.

setDeleted

protected final void setDeleted(boolean deleted)

Sets deleted} status flag to the passed value.

setInitialState

protected final void setInitialState(S initialState, Version version)

Sets an initial state for the entity.

state

public final S state()

Obtains the state of the entity.

thisClass

protected EntityClass<? extends Object> thisClass()

Obtains model class for this entity.

toString

public String toString()

protected Transaction<I, ? extends TransactionalEntity<I, S, B>, S, B> tx()

Obtains the transaction used for modifying the entity.

unexpectedValue

protected ValueMismatch unexpectedValue(Message expected, Message actual, Message newValue)

Creates ValueMismatch for the case of discovering a value different than by a command.

protected ValueMismatch unexpectedValue(String expected, String actual, String newValue)

Creates ValueMismatch for the case of discovering a value different than expected by a command.

version

public Version version()

Obtains the version of the entity.

versionNumber

protected final int versionNumber()

Obtains the version number of the entity.

whenModified

public Timestamp whenModified()

Obtains timestamp of the entity version.

AggregatePart

Parameters

See also

Constructors

Types

Inherited properties

Functions

Inherited functions