Package org.broadleafcommerce.common.util

Class StreamingTransactionCapableUtil

java.lang.Object

org.broadleafcommerce.common.util.StreamingTransactionCapableUtil

All Implemented Interfaces:

StreamingTransactionCapable

@Component("blStreamingTransactionCapableUtil")
@Scope("prototype")
public class StreamingTransactionCapableUtil
extends Object
implements StreamingTransactionCapable

Author:

Jeff Fischer

Field Summary

Fields

Modifier and Type	Field	Description
protected jakarta.persistence.EntityManagerFactory	emf
protected int	pageSize
protected org.springframework.transaction.PlatformTransactionManager	platformTransactionManager
protected int	retryMax

Constructor Summary

Constructors

Constructor	Description
StreamingTransactionCapableUtil()

Method Summary

Modifier and Type	Method	Description
protected <G extends Throwable> void	endTransaction(org.springframework.transaction.TransactionStatus status, boolean error, Class<G> exceptionType, org.springframework.transaction.PlatformTransactionManager transactionManager)
int	getPageSize()	The result set size per page of data when streaming.
int	getRetryMax()
org.springframework.transaction.PlatformTransactionManager	getTransactionManager()
void	init()
void	runOptionalEntityManagerInViewOperation(Runnable runnable)	Executes the Runnable operation in the scope of an Entity-Manager-In-View pattern, if there is not already an EntityManager on the thread.
<G extends Throwable> void	runOptionalTransactionalOperation(StreamCapableTransactionalOperation operation, Class<G> exceptionType, boolean useTransaction)	Run an operation inside of a single transaction.
<G extends Throwable> void	runOptionalTransactionalOperation(StreamCapableTransactionalOperation operation, Class<G> exceptionType, boolean useTransaction, int transactionBehavior, int isolationLevel)
<G extends Throwable> void	runOptionalTransactionalOperation(StreamCapableTransactionalOperation operation, Class<G> exceptionType, boolean useTransaction, int transactionBehavior, int isolationLevel, boolean readOnly, org.springframework.transaction.PlatformTransactionManager transactionManager)
<G extends Throwable> void	runStreamingTransactionalOperation(StreamCapableTransactionalOperation streamOperation, Class<G> exceptionType)	Run a streaming operation inside a transaction.
<G extends Throwable> void	runStreamingTransactionalOperation(StreamCapableTransactionalOperation streamOperation, Class<G> exceptionType, int transactionBehavior, int isolationLevel)
<G extends Throwable> void	runTransactionalOperation(StreamCapableTransactionalOperation operation, Class<G> exceptionType)	Run an operation inside of a single transaction.
<G extends Throwable> void	runTransactionalOperation(StreamCapableTransactionalOperation operation, Class<G> exceptionType, int transactionBehavior, int isolationLevel)
<G extends Throwable> void	runTransactionalOperation(StreamCapableTransactionalOperation operation, Class<G> exceptionType, org.springframework.transaction.PlatformTransactionManager transactionManager)
void	setPageSize(int pageSize)
void	setRetryMax(int retryMax)
void	setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)
protected org.springframework.transaction.TransactionStatus	startTransaction(int propagationBehavior, int isolationLevel, boolean isReadOnly, org.springframework.transaction.PlatformTransactionManager transactionManager)

Methods inherited from class java.lang.Object

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

Field Details

platformTransactionManager

protected org.springframework.transaction.PlatformTransactionManager platformTransactionManager

emf

protected jakarta.persistence.EntityManagerFactory emf

retryMax

@Value("${streaming.transaction.lock.retry.max}")
protected int retryMax

pageSize

@Value("${streaming.transaction.item.page.size}")
protected int pageSize

Constructor Details

StreamingTransactionCapableUtil

public StreamingTransactionCapableUtil()

Method Details

init

@PostConstruct
public void init()

runStreamingTransactionalOperation

public <G extends Throwable> void runStreamingTransactionalOperation(StreamCapableTransactionalOperation streamOperation,
 Class<G> exceptionType)
                                                              throws G

Description copied from interface: StreamingTransactionCapable

Run a streaming operation inside a transaction. Uses the StreamCapableTransactionalOperation API to determine the page of data to work on within the transaction scope.

Specified by:

runStreamingTransactionalOperation in interface StreamingTransactionCapable

Throws:

G

runStreamingTransactionalOperation

public <G extends Throwable> void runStreamingTransactionalOperation(StreamCapableTransactionalOperation streamOperation,
 Class<G> exceptionType,
 int transactionBehavior,
 int isolationLevel)
                                                              throws G

Specified by:

runStreamingTransactionalOperation in interface StreamingTransactionCapable

Throws:

G extends Throwable

runTransactionalOperation

public <G extends Throwable> void runTransactionalOperation(StreamCapableTransactionalOperation operation,
 Class<G> exceptionType)
                                                     throws G

Description copied from interface: StreamingTransactionCapable

Run an operation inside of a single transaction. This is not a streaming use case and represents a basic operation to perform in a transaction. See TransactionalOperation.execute().

Specified by:

runTransactionalOperation in interface StreamingTransactionCapable

Throws:

G

runTransactionalOperation

public <G extends Throwable> void runTransactionalOperation(StreamCapableTransactionalOperation operation,
 Class<G> exceptionType,
 org.springframework.transaction.PlatformTransactionManager transactionManager)
                                                     throws G

Specified by:

runTransactionalOperation in interface StreamingTransactionCapable

Throws:

G extends Throwable

runTransactionalOperation

public <G extends Throwable> void runTransactionalOperation(StreamCapableTransactionalOperation operation,
 Class<G> exceptionType,
 int transactionBehavior,
 int isolationLevel)
                                                     throws G

Specified by:

runTransactionalOperation in interface StreamingTransactionCapable

Throws:

G extends Throwable

runOptionalTransactionalOperation

public <G extends Throwable> void runOptionalTransactionalOperation(StreamCapableTransactionalOperation operation,
 Class<G> exceptionType,
 boolean useTransaction)
                                                             throws G

Description copied from interface: StreamingTransactionCapable

Run an operation inside of a single transaction. This is not a streaming use case and represents a basic operation to perform in a transaction. See TransactionalOperation.execute(). The useTransaction parameter allows the inclusion of some logic to determine whether or not the creation of the transaction is required for the operation. This is useful in situations where there may already be an active transaction that you want to use, if available.

Specified by:

runOptionalTransactionalOperation in interface StreamingTransactionCapable

Throws:

G

runOptionalTransactionalOperation

public <G extends Throwable> void runOptionalTransactionalOperation(StreamCapableTransactionalOperation operation,
 Class<G> exceptionType,
 boolean useTransaction,
 int transactionBehavior,
 int isolationLevel)
                                                             throws G

Specified by:

runOptionalTransactionalOperation in interface StreamingTransactionCapable

Throws:

G extends Throwable

runOptionalEntityManagerInViewOperation

public void runOptionalEntityManagerInViewOperation(Runnable runnable)

Description copied from interface: StreamingTransactionCapable

Executes the Runnable operation in the scope of an Entity-Manager-In-View pattern, if there is not already an EntityManager on the thread. This is useful for operations that may be susceptible to lazy init exceptions if there is not an EntityManager available on the thread.

Specified by:

runOptionalEntityManagerInViewOperation in interface StreamingTransactionCapable

runOptionalTransactionalOperation

public <G extends Throwable> void runOptionalTransactionalOperation(StreamCapableTransactionalOperation operation,
 Class<G> exceptionType,
 boolean useTransaction,
 int transactionBehavior,
 int isolationLevel,
 boolean readOnly,
 org.springframework.transaction.PlatformTransactionManager transactionManager)
                                                             throws G

Specified by:

runOptionalTransactionalOperation in interface StreamingTransactionCapable

Throws:

G extends Throwable

getPageSize

public int getPageSize()

Description copied from interface: StreamingTransactionCapable

The result set size per page of data when streaming. See StreamingTransactionCapable.runStreamingTransactionalOperation(StreamCapableTransactionalOperation, Class).

Specified by:

getPageSize in interface StreamingTransactionCapable

Returns:

setPageSize

public void setPageSize(int pageSize)

Specified by:

setPageSize in interface StreamingTransactionCapable

getTransactionManager

public org.springframework.transaction.PlatformTransactionManager getTransactionManager()

Specified by:

getTransactionManager in interface StreamingTransactionCapable

setTransactionManager

public void setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)

Specified by:

setTransactionManager in interface StreamingTransactionCapable

getRetryMax

public int getRetryMax()

Specified by:

getRetryMax in interface StreamingTransactionCapable

setRetryMax

public void setRetryMax(int retryMax)

Specified by:

setRetryMax in interface StreamingTransactionCapable

endTransaction

protected <G extends Throwable> void endTransaction(org.springframework.transaction.TransactionStatus status,
 boolean error,
 Class<G> exceptionType,
 org.springframework.transaction.PlatformTransactionManager transactionManager)
                                             throws G

Throws:

G extends Throwable

startTransaction

protected org.springframework.transaction.TransactionStatus startTransaction(int propagationBehavior,
 int isolationLevel,
 boolean isReadOnly,
 org.springframework.transaction.PlatformTransactionManager transactionManager)