com.phloc.db.jpa

Class JPAEnabledManager

java.lang.Object

com.phloc.db.jpa.JPAEnabledManager

Direct Known Subclasses:

JPAEnabledManagerH2, JPAEnabledManagerMySQL

@ThreadSafe
public class JPAEnabledManager
extends Object

JPA enabled manager with transaction handling etc. The IEntityManagerProvider required in the constructor should be a request singleton that ensures one EntityManager per thread. The main EntityManager objects are usually create from a subclass of AbstractGlobalEntityManagerFactory.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ALLOW_NESTED_TRANSACTIONS By default nested transactions are not allowed
static int	DEFAULT_EXECUTION_WARN_TIME_MS The default execution time after which a warning is emitted
static boolean	DEFAULT_SYNC_ENTITY_MGR By default the entity manager is not locked (changed in 3.0.0)
static boolean	DEFAULT_USE_TRANSACTIONS_FOR_SELECT By default no transaction is used for select statements
protected static ReadWriteLock	s_aRWLock

Constructor Summary

Constructors

Constructor and Description
JPAEnabledManager(IEntityManagerProvider aEntityManagerProvider)

Method Summary

Methods

Modifier and Type	Method and Description
<T> JPAExecutionResult<T>	doInTransaction(Callable<T> aCallable)
static <T> JPAExecutionResult<T>	doInTransaction(javax.persistence.EntityManager aEntityMgr, boolean bAllowNestedTransactions, Callable<T> aCallable)
static JPAExecutionResult<?>	doInTransaction(javax.persistence.EntityManager aEntityMgr, boolean bAllowNestedTransactions, com.phloc.commons.callback.IThrowingRunnable aRunnable)
static JPAExecutionResult<?>	doInTransaction(javax.persistence.EntityManager aEntityMgr, boolean bAllowNestedTransactions, Runnable aRunnable)
JPAExecutionResult<?>	doInTransaction(com.phloc.commons.callback.IThrowingRunnable aRunnable)
JPAExecutionResult<?>	doInTransaction(Runnable aRunnable)
<T> JPAExecutionResult<T>	doSelect(Callable<T> aCallable) Run a read-only query.
static <T> JPAExecutionResult<T>	doSelectStatic(Callable<T> aCallable) Perform a select, without a transaction
static com.phloc.commons.callback.IExceptionHandler<Throwable>	getCustomExceptionHandler() Get the custom exception handler.
static int	getDefaultExecutionWarnTime()
protected javax.persistence.EntityManager	getEntityManager()
static IExecutionTimeExceededHandler	getExecutionTimeExceededHandler() Get the custom exception handler.
static long	getSelectCountResult(javax.persistence.Query aQuery) Helper method to handle the execution of "SELECT COUNT(...) ..."
static Number	getSelectCountResultObj(javax.persistence.Query aQuery) Helper method to handle the execution of "SELECT COUNT(...) ..."
boolean	isAllowNestedTransactions()
boolean	isSyncEntityMgr()
boolean	isUseTransactionsForSelect()
static void	onExecutionTimeExceeded(String sMsg, long nExecutionMillis)
void	setAllowNestedTransactions(boolean bAllowNestedTransactions) Allow nested transaction
static void	setCustomExceptionHandler(com.phloc.commons.callback.IExceptionHandler<Throwable> aExceptionHandler) Set a custom exception handler that is called in case performing some operation fails.
static void	setDefaultExecutionWarnTime(int nMillis) Set the milli seconds duration on which a warning should be emitted, if a single SQL execution too at least that long.
static void	setExecutionTimeExceededHandler(IExecutionTimeExceededHandler aExecutionTimeExceededHandler)
void	setSyncEntityMgr(boolean bSyncEntityMgr) Set whether the entity manager should be synchronized upon each access
void	setUseTransactionsForSelect(boolean bUseTransactionsForSelect) Use transactions for select statements?

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SYNC_ENTITY_MGR

public static final boolean DEFAULT_SYNC_ENTITY_MGR

By default the entity manager is not locked (changed in 3.0.0)

See Also:

Constant Field Values

DEFAULT_ALLOW_NESTED_TRANSACTIONS

public static final boolean DEFAULT_ALLOW_NESTED_TRANSACTIONS

By default nested transactions are not allowed

See Also:

Constant Field Values

DEFAULT_USE_TRANSACTIONS_FOR_SELECT

public static final boolean DEFAULT_USE_TRANSACTIONS_FOR_SELECT

By default no transaction is used for select statements

See Also:

Constant Field Values

DEFAULT_EXECUTION_WARN_TIME_MS

public static final int DEFAULT_EXECUTION_WARN_TIME_MS

The default execution time after which a warning is emitted

See Also:

Constant Field Values

s_aRWLock

protected static final ReadWriteLock s_aRWLock

Constructor Detail

JPAEnabledManager

public JPAEnabledManager(@Nonnull
                 IEntityManagerProvider aEntityManagerProvider)

Method Detail

isSyncEntityMgr

public final boolean isSyncEntityMgr()

setSyncEntityMgr

public final void setSyncEntityMgr(boolean bSyncEntityMgr)

Set whether the entity manager should be synchronized upon each access

Parameters:

bSyncEntityMgr - true to enable sync, false to disable sync

isAllowNestedTransactions

public final boolean isAllowNestedTransactions()

setAllowNestedTransactions

public final void setAllowNestedTransactions(boolean bAllowNestedTransactions)

Allow nested transaction

Parameters:

bAllowNestedTransactions - true to enable nested transaction

isUseTransactionsForSelect

public final boolean isUseTransactionsForSelect()

Returns:

true if transactions should be used for selecting, false if this can be done without transactions

setUseTransactionsForSelect

public final void setUseTransactionsForSelect(boolean bUseTransactionsForSelect)

Use transactions for select statements?

Parameters:

bUseTransactionsForSelect - true to enable the usage of transactions for select statements.

getEntityManager

@Nonnull
protected final javax.persistence.EntityManager getEntityManager()

Returns:

Get the entity manager to be used. Must not be null.

setCustomExceptionHandler

public static final void setCustomExceptionHandler(@Nullable
                             com.phloc.commons.callback.IExceptionHandler<Throwable> aExceptionHandler)

Set a custom exception handler that is called in case performing some operation fails.

Parameters:

aExceptionHandler - The exception handler to be set. May be null to indicate no custom exception handler.

getCustomExceptionHandler

@Nullable
public static final com.phloc.commons.callback.IExceptionHandler<Throwable> getCustomExceptionHandler()

Get the custom exception handler.

Returns:

null if non is set

getDefaultExecutionWarnTime

@Nonnegative
public static final int getDefaultExecutionWarnTime()

Returns:

The milliseconds after which a warning is emitted, if an SQL statement takes longer to execute.

setDefaultExecutionWarnTime

public static final void setDefaultExecutionWarnTime(int nMillis)

Set the milli seconds duration on which a warning should be emitted, if a single SQL execution too at least that long.

Parameters:

nMillis - The number of milli seconds. Must be ≥ 0.

setExecutionTimeExceededHandler

public static final void setExecutionTimeExceededHandler(@Nullable
                                   IExecutionTimeExceededHandler aExecutionTimeExceededHandler)

getExecutionTimeExceededHandler

@Nullable
public static final IExecutionTimeExceededHandler getExecutionTimeExceededHandler()

Get the custom exception handler.

Returns:

null if non is set

onExecutionTimeExceeded

public static final void onExecutionTimeExceeded(@Nonnull
                           String sMsg,
                           @Nonnegative
                           long nExecutionMillis)

doInTransaction

@Nonnull
public static final JPAExecutionResult<?> doInTransaction(@Nonnull@WillNotClose
                                            javax.persistence.EntityManager aEntityMgr,
                                            boolean bAllowNestedTransactions,
                                            @Nonnull
                                            Runnable aRunnable)

doInTransaction

@Nonnull
public static final JPAExecutionResult<?> doInTransaction(@Nonnull@WillNotClose
                                            javax.persistence.EntityManager aEntityMgr,
                                            boolean bAllowNestedTransactions,
                                            @Nonnull
                                            com.phloc.commons.callback.IThrowingRunnable aRunnable)

doInTransaction

@Nonnull
public final JPAExecutionResult<?> doInTransaction(@Nonnull
                                            com.phloc.commons.callback.IThrowingRunnable aRunnable)

doInTransaction

@Nonnull
public final JPAExecutionResult<?> doInTransaction(@Nonnull
                                            Runnable aRunnable)

doInTransaction

@Nonnull
public static final <T> JPAExecutionResult<T> doInTransaction(@Nonnull@WillNotClose
                                                javax.persistence.EntityManager aEntityMgr,
                                                boolean bAllowNestedTransactions,
                                                @Nonnull
                                                Callable<T> aCallable)

doInTransaction

@Nonnull
public final <T> JPAExecutionResult<T> doInTransaction(@Nonnull
                                                Callable<T> aCallable)

doSelectStatic

@Nonnull
public static final <T> JPAExecutionResult<T> doSelectStatic(@Nonnull
                                               Callable<T> aCallable)

Perform a select, without a transaction

Parameters:

aCallable - The callable

Returns:

The return of the callable or null upon success

doSelect

@Nonnull
public final <T> JPAExecutionResult<T> doSelect(@Nonnull
                                         Callable<T> aCallable)

Run a read-only query. By default no transaction is used, and the entity manager is synchronized.

Parameters:

aCallable - The callable to execute.

Returns:

A non-null result of the select.

getSelectCountResultObj

@Nonnull
public static final Number getSelectCountResultObj(@Nonnull
                                     javax.persistence.Query aQuery)

Helper method to handle the execution of "SELECT COUNT(...) ..." SQL statements. To be invoked inside a doSelect(Callable) or doSelectStatic(Callable) method.

Parameters:

aQuery - The SELECT COUNT query

Returns:

a non-negative row count

getSelectCountResult

@Nonnegative
public static final long getSelectCountResult(@Nonnull
                                    javax.persistence.Query aQuery)

Helper method to handle the execution of "SELECT COUNT(...) ..." SQL statements. To be invoked inside a doSelect(Callable) or doSelectStatic(Callable) method.

Parameters:

aQuery - The SELECT COUNT query

Returns:

a non-negative row count