server/io.spine.server.command/CommandHandlingEntity

CommandHandlingEntity

public abstract class CommandHandlingEntity<I, S extends EntityState, B extends ValidatingBuilder<S>> extends TransactionalEntity<I, S, B> implements CommandHandler

An entity that handles commands.

Inheritors

Aggregate

ProcessManager

Constructors

CommandHandlingEntity

protected void CommandHandlingEntity()

protected void CommandHandlingEntity(I id)

Creates a new entity with the passed ID.

Inherited properties

lifecycleFlags

public volatile LifecycleFlags lifecycleFlags

The lifecycle flags of the entity.

Functions

dispatchCommand

protected abstract DispatchOutcome dispatchCommand(CommandEnvelope cmd)

Dispatches the passed command to appropriate handler.

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.

producerId

public Any producerId()

The object identity packed into Any.

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.

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 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 void clearRecentHistory()

Clears recent history.

defaultState

protected final S defaultState()

Obtains the default state of the entity.

ensureAccessToState

protected void ensureAccessToState()

Ensures that the callee is allowed to access Entity's state() method.

equals

public boolean equals(Object o)

getLifecycleFlags

public final LifecycleFlags getLifecycleFlags()

Obtains the current state of the entity lifecycle flags.

hashCode

public int hashCode()

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 String missingTxMessage()

Provides error message text for the case of not having an active transaction when a state modification call is made.

modelClass

protected EntityClass<? extends Object> modelClass()

Obtains the model class.

nothing

public Nothing nothing()

Obtains the io.spine.server.model.

producedEvents

public abstract ImmutableSet<EventClass> producedEvents()

Obtains classes of the events produced by this object.

recentHistory

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

version

public Version version()

Obtains the version of the entity.

versionNumber

protected int versionNumber()

Obtains the version number of the entity.

whenModified

public Timestamp whenModified()

Obtains timestamp of the entity version.

CommandHandlingEntity

See also

Inheritors

Constructors

Inherited properties

Functions

Inherited functions