com.haulmont.cuba.core.sys

Class TransactionalActionBean

java.lang.Object

com.haulmont.cuba.core.sys.TransactionalActionBean

All Implemented Interfaces:

TransactionalAction

@Component(value="cuba_TransactionalAction")
 @Scope(value="prototype")
public class TransactionalActionBean
extends java.lang.Object
implements TransactionalAction

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.function.Consumer<CommitContext>	afterCommitAction
protected CommitContext	commitContext
protected DataManager	dataManager
protected java.util.function.Supplier<CommitContext>	getCommitContextAction
protected boolean	joinTransaction
protected java.util.function.BiConsumer<CommitContext,java.lang.Throwable>	onFailAction
protected java.util.function.Consumer<EntitySet>	onSuccessAction

Fields inherited from interface com.haulmont.cuba.core.global.TransactionalAction

NAME

Constructor Summary

Constructors

Constructor and Description
TransactionalActionBean()

Method Summary

Modifier and Type	Method and Description
TransactionalAction	afterCompletion(java.util.function.Consumer<CommitContext> consumer) Specifies the action to be performed after the commit (regardless of whether it is successful or not).
CommitContext	getCommitContext()
boolean	isJoinTransaction()
TransactionalAction	onFail(java.util.function.BiConsumer<CommitContext,java.lang.Throwable> consumer) Specifies the action to be performed right after the unsuccessful commit.
TransactionalAction	onSuccess(java.util.function.Consumer<EntitySet> consumer) Specifies the action to be performed right after the successful commit.
EntitySet	perform() Terminal operation.
TransactionalAction	setJoinTransaction(boolean joinTransaction) Specifies the joinTransaction parameter.
TransactionalAction	withCommitContext(CommitContext commitContext) Specifies the CommitContext with all required changes (created, updated, deleted entities).
TransactionalAction	withCommitContext(java.util.function.Supplier<CommitContext> supplier) Specifies the action to retrieve the CommitContext with all required changes (created, updated, deleted entities).

Methods inherited from class java.lang.Object

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

Field Detail

dataManager

@Inject
protected DataManager dataManager

commitContext

protected CommitContext commitContext

getCommitContextAction

protected java.util.function.Supplier<CommitContext> getCommitContextAction

onSuccessAction

protected java.util.function.Consumer<EntitySet> onSuccessAction

onFailAction

protected java.util.function.BiConsumer<CommitContext,java.lang.Throwable> onFailAction

afterCommitAction

protected java.util.function.Consumer<CommitContext> afterCommitAction

joinTransaction

protected boolean joinTransaction

Constructor Detail

TransactionalActionBean

public TransactionalActionBean()

Method Detail

onSuccess

public TransactionalAction onSuccess(java.util.function.Consumer<EntitySet> consumer)

Description copied from interface: TransactionalAction

Specifies the action to be performed right after the successful commit.

Entities in the EntitySet can be modified but these modifications don't change entities in a database.

Method returns the same instance of TransactionalAction so it can be used for method chaining.

Specified by:

onSuccess in interface TransactionalAction

Parameters:

consumer - implementation of Consumer interface

Returns:

the same instance to which the method was applied

onFail

public TransactionalAction onFail(java.util.function.BiConsumer<CommitContext,java.lang.Throwable> consumer)

Description copied from interface: TransactionalAction

Specifies the action to be performed right after the unsuccessful commit.

If this action is specified (not null) and an exception occurs during commit then this exception won't be re-thrown during perform() execution. In this case null value will be returned by perform() method

Method returns the same instance of TransactionalAction so it can be used for method chaining.

Specified by:

onFail in interface TransactionalAction

Parameters:

consumer - implementation of BiConsumer interface. The first parameter - CommitContext that was used for unsuccessful commit. The second parameter - Throwable that was thrown during the commit

Returns:

the same instance to which the method was applied

afterCompletion

public TransactionalAction afterCompletion(java.util.function.Consumer<CommitContext> consumer)

Description copied from interface: TransactionalAction

Specifies the action to be performed after the commit (regardless of whether it is successful or not).

All changes of the CommitContext won't be saved in a database.

Method returns the same instance of TransactionalAction so it can be used for method chaining.

Specified by:

afterCompletion in interface TransactionalAction

Parameters:

consumer - implementation of Consumer interface

Returns:

the same instance to which the method was applied

withCommitContext

public TransactionalAction withCommitContext(java.util.function.Supplier<CommitContext> supplier)

Description copied from interface: TransactionalAction

Specifies the action to retrieve the CommitContext with all required changes (created, updated, deleted entities).

Method returns the same instance of TransactionalAction so it can be used for method chaining.

Specified by:

withCommitContext in interface TransactionalAction

Parameters:

supplier - implementation of Supplier interface

Returns:

the same instance to which the method was applied

withCommitContext

public TransactionalAction withCommitContext(CommitContext commitContext)

Description copied from interface: TransactionalAction

Specifies the CommitContext with all required changes (created, updated, deleted entities).

If this method is used with commitContext != null then action from withCommitContext(Supplier<CommitContext> supplier) will be ignored

Method returns the same instance of TransactionalAction so it can be used for method chaining.

Specified by:

withCommitContext in interface TransactionalAction

Parameters:

commitContext - contains all required changes (created, updated and deleted entities)

Returns:

the same instance to which the method was applied

perform

public EntitySet perform()

Description copied from interface: TransactionalAction

Terminal operation. This method must be invoked to perform the commit and all specified additional actions.

Actions are invoked in the following order:
      1)  withCommitContext action to retrieve the commitContext;
      2)  beforeCommit action;
      3.1) if the commit was successful then  onSuccess action;
      3.2) if the commit was unsuccessful then  onFail action;
      4)  afterCompletion action.

If onFail action is specified (not null) and an exception occurs during commit then this exception won't be re-thrown by perform() method. In this case null value will be returned as a result

Specified by:

perform in interface TransactionalAction

Returns:

EntitySet with all committed entities. This EntitySet might be modified by onSuccess action

getCommitContext

public CommitContext getCommitContext()

Specified by:

getCommitContext in interface TransactionalAction

Returns:

commitContext that was specified by withCommitContext(CommitContext commitContext) method

isJoinTransaction

public boolean isJoinTransaction()

Specified by:

isJoinTransaction in interface TransactionalAction

Returns:

joinTransaction parameter

setJoinTransaction

public TransactionalAction setJoinTransaction(boolean joinTransaction)

Description copied from interface: TransactionalAction

Specifies the joinTransaction parameter.

Method returns the same instance of TransactionalAction so it can be used for method chaining.

Specified by:

setJoinTransaction in interface TransactionalAction

Parameters:

joinTransaction - defines should CommitContext be joined to existing transaction or not. Default value = false

Returns:

the same instance to which the method was applied