Package ch.tocco.nice2.persist.core.api.util

Class AfterCommitTask

java.lang.Object

ch.tocco.nice2.persist.core.api.util.AfterCommitTask

All Implemented Interfaces:

PersistTask<Object,Void>

public abstract class AfterCommitTask
extends Object
implements PersistTask<Object,Void>

Constructor Summary

Constructors

Constructor	Description
AfterCommitTask()

Method Summary

Modifier and Type	Method	Description
final Context	getContext()	Use this method to retrieve the context.
protected final Iterable<Entity>	getCreatedEntities()	get all entities that were created during the transaction
protected final Iterable<EntityId>	getCreatedEntityIds()
protected final Iterable<EntityId>	getDeletedEntities()	get all entities that were deleted during the transaction
protected final Iterable<Entity>	getUpdatedEntities()	get all entities that were update during the transaction
protected final Iterable<EntityId>	getUpdatedEntityIds()
protected final <V> V	getValue(Mode.Key<V> key)
protected final <V> V	getValueOrNull(Mode.Key<V> key)
abstract void	onAfterCommit(CommandContext commandContext)	Implement this method for logic to be executed asynchronously after the commit.
final Void	run(Optional<Object> a, CommandContext commandContext)
protected void	setCollectedEntities(Set<EntityId> createdEntities, Set<EntityId> updatedEntities, Set<EntityId> deletedEntities)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ch.tocco.nice2.persist.core.api.exec.PersistTask

andThenDo, compose, compose2, composeWhen, discardResult, expand, expand, getDescription, ifElse, orWhen, orWhenNot, passWhen, passWhenNot, skipErrors, unwrap

Constructor Details

AfterCommitTask

public AfterCommitTask()

Method Details

run

public final Void run(Optional<Object> a,
 CommandContext commandContext)
               throws Exception

Specified by:

run in interface PersistTask<Object,Void>

Throws:

Exception

getValue

protected final <V> V getValue(Mode.Key<V> key)

getValueOrNull

@Nullable
protected final <V> V getValueOrNull(Mode.Key<V> key)

onAfterCommit

public abstract void onAfterCommit(CommandContext commandContext)
                            throws Exception

Implement this method for logic to be executed asynchronously after the commit. To retrieve the affected entities consider the below methods.

Parameters:

commandContext - commandContext

Throws:

Exception

See Also:

• getCreatedEntities()
• getDeletedEntities()
• getUpdatedEntities()

getContext

public final Context getContext()

Use this method to retrieve the context.
Important note: Do not inject your own context, but always use the one returned by this method.

Returns:

a context to work with

getCreatedEntities

protected final Iterable<Entity> getCreatedEntities()

get all entities that were created during the transaction

Returns:

-

getCreatedEntityIds

protected final Iterable<EntityId> getCreatedEntityIds()

getUpdatedEntities

protected final Iterable<Entity> getUpdatedEntities()

get all entities that were update during the transaction

Returns:

-

getUpdatedEntityIds

protected final Iterable<EntityId> getUpdatedEntityIds()

getDeletedEntities

protected final Iterable<EntityId> getDeletedEntities()

get all entities that were deleted during the transaction

Returns:

-

setCollectedEntities

protected void setCollectedEntities(Set<EntityId> createdEntities,
 Set<EntityId> updatedEntities,
 Set<EntityId> deletedEntities)