ProcessManager

public abstract class ProcessManager<I, S extends EntityState, B extends ValidatingBuilder<S>> extends CommandHandlingEntity<I, S, B> implements EventReactor, Commander, HasVersionColumn<I, S>, HasLifecycleColumns<I, S>

A central processing unit used to maintain the state of the business process and determine the next processing step based on intermediate results.

A process manager reacts to domain events in a cross-aggregate, eventually consistent manner.

Event and command handlers are invoked by the ProcessManagerRepository that manages instances of a process manager class.

For more information on Process Managers, please see:

Parameters

<I>

the type of the process manager IDs

<S>

the type of the process manager state

Constructors

Link copied to clipboard
protected void ProcessManager()
Creates a new instance.
protected void ProcessManager(I id)
Creates a new instance.

Inherited properties

Link copied to clipboard
public volatile LifecycleFlags lifecycleFlags
The lifecycle flags of the entity.
Link copied to clipboard
public volatile Version version
The version of the entity.

Functions

Link copied to clipboard
protected final B builder()
Obtains the instance of the state builder.
Link copied to clipboard
protected DispatchOutcome dispatchCommand(CommandEnvelope command)
Dispatches the command to the handling method.
Link copied to clipboard
Provides error message text for the case of not having an active transaction when a state modification call is made.
Link copied to clipboard
protected ProcessManagerClass<? extends Object> modelClass()
Obtains the model class.
Link copied to clipboard
public ImmutableSet<EventClass> producedEvents()
Obtains classes of the events produced by this object.
Link copied to clipboard
protected ProcessManagerClass<? extends Object> thisClass()
Obtains model class for this entity.
Link copied to clipboard
protected Transaction<I, ? extends TransactionalEntity<I, S, B>, S, B> tx()
Obtains the transaction used for modifying the entity.

Inherited functions

Link copied to clipboard
public void afterInvoke(HandlerMethod<? extends Object, ? extends Object, ? extends Object, ? extends Object> method)
A callback for a handler method invocation end.
Link copied to clipboard
public final Api at(Level logLevel)
Obtains a new fluent logging API at the given level.
Link copied to clipboard
public void beforeInvoke(HandlerMethod<? extends Object, ? extends Object, ? extends Object, ? extends Object> method)
A callback for a handler method invocation start.
Link copied to clipboard
public final boolean changed()
Determines whether the state of this entity or its lifecycle flags have been modified since this entity instance creation.
Link copied to clipboard
protected final List<ConstraintViolation> checkEntityState(S newState)
Verifies the new entity state and returns ConstraintViolations, if any.
Link copied to clipboard
protected void checkNotArchived()
Ensures that the entity is not marked as archived.
Link copied to clipboard
protected void checkNotDeleted()
Ensures that the entity is not marked as deleted.
Link copied to clipboard
protected void clearRecentHistory()
Link copied to clipboard
protected final S defaultState()
Obtains the default state of the entity.
Link copied to clipboard
public DoNothing doNothing()
Obtains the io.spine.server.model.
Link copied to clipboard
protected void ensureAccessToState()
Ensures that the callee is allowed to access Entity's state() method.
Link copied to clipboard
public boolean equals(Object o)
Link copied to clipboard
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.
Link copied to clipboard
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.
Link copied to clipboard
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.
Link copied to clipboard
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.
Link copied to clipboard
public boolean getArchived()
Obtains the value of archived flag.
Link copied to clipboard
public boolean getDeleted()
Obtains the value of deleted flag.
Link copied to clipboard
public final LifecycleFlags getLifecycleFlags()
Obtains the current state of the entity lifecycle flags.
Link copied to clipboard
public Version getVersion()
Obtains the version of the entity.
Link copied to clipboard
public int hashCode()
Link copied to clipboard
public I id()
Obtains the identifier of the entity.
Link copied to clipboard
public String idAsString()
Obtains ID of the entity in the string form.
Link copied to clipboard
public boolean isActive()
Verifies if any of the lifecycle attributes is set.
Link copied to clipboard
public final boolean isArchived()
Tests whether the entity is marked as archived.
Link copied to clipboard
public final boolean isDeleted()
Tests whether the entity is marked as deleted.
Link copied to clipboard
public LifecycleFlags lifecycleFlags()
Obtains current lifecycle flags.
Link copied to clipboard
public boolean lifecycleFlagsChanged()
Tells whether lifecycle flags of the entity changed since its initialization.
Link copied to clipboard
public Nothing nothing()
Obtains the io.spine.server.model.
Link copied to clipboard
public Any producerId()
The object identity packed into Any.
Link copied to clipboard
Obtains recent history of events of this entity.
Link copied to clipboard
protected void remember(Iterable<Event> events)
Adds events to the recent history.
Link copied to clipboard
protected final void setArchived(boolean archived)
Sets archived} status flag to the passed value.
Link copied to clipboard
protected final void setDeleted(boolean deleted)
Sets deleted} status flag to the passed value.
Link copied to clipboard
protected final void setInitialState(S initialState, Version version)
Sets an initial state for the entity.
Link copied to clipboard
public final S state()
Obtains the state of the entity.
Link copied to clipboard
public String toString()
Link copied to clipboard
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.
Link copied to clipboard
public Version version()
Obtains the version of the entity.
Link copied to clipboard
protected int versionNumber()
Obtains the version number of the entity.
Link copied to clipboard
public Timestamp whenModified()
Obtains timestamp of the entity version.