com.haulmont.cuba.core

Interface Persistence

All Known Implementing Classes:

PersistenceImpl

public interface Persistence

Central infrastructure interface to provide persistence through RdbmsStore.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
<T> T	callInTransaction(java.lang.String storeName, Transaction.Callable<T> callable) Executes the action specified by the given single method object within a new transaction.
<T> T	callInTransaction(Transaction.Callable<T> callable) Executes the action specified by the given single method object within a new transaction in the main data store.
Transaction	createTransaction() Creates a new transaction in the main data store.
Transaction	createTransaction(java.lang.String storeName) Creates a new transaction. If there is an active transaction, it will be suspended.
Transaction	createTransaction(java.lang.String storeName, TransactionParams params) Creates a new transaction. If there is an active transaction, it will be suspended.
Transaction	createTransaction(TransactionParams params) Creates a new transaction in the main data store.
javax.sql.DataSource	getDataSource()
javax.sql.DataSource	getDataSource(java.lang.String storeName)
DbTypeConverter	getDbTypeConverter() Returns DbTypeConverter for the current DBMS of the main data store.
DbTypeConverter	getDbTypeConverter(java.lang.String storeName) Returns DbTypeConverter for the current DBMS of the specified data store.
EntityManager	getEntityManager() Returns existing or creates a new transaction-bound EntityManager for the main data store, which will be closed on transaction commit/rollback.
EntityManager	getEntityManager(java.lang.String storeName) Returns existing or creates a new transaction-bound EntityManager, which will be closed on transaction commit/rollback.
EntityManagerContext	getEntityManagerContext() Returns context of the current EntityManager in the main data store.
EntityManagerContext	getEntityManagerContext(java.lang.String storeName) Returns context of the current EntityManager. If not exists, a new instance of context created and returned.
PersistenceTools	getTools() Convenient access to PersistenceTools bean.
Transaction	getTransaction() Creates a new transaction in the main data store if there is no one at the moment.
Transaction	getTransaction(java.lang.String storeName) Creates a new transaction if there is no one at the moment.
boolean	isInTransaction() Current transaction status.
boolean	isSoftDeletion() Global soft deletion attribute.
void	runInTransaction(java.lang.String storeName, Transaction.Runnable runnable) Executes the action specified by the given single method object within a new transaction.
void	runInTransaction(Transaction.Runnable runnable) Executes the action specified by the given single method object within a new transaction in the main data store.
void	setSoftDeletion(boolean value) Set the global soft deletion attribute.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getTools

PersistenceTools getTools()

Convenient access to PersistenceTools bean.

Returns:

PersistenceTools instance

getDbTypeConverter

DbTypeConverter getDbTypeConverter()

Returns DbTypeConverter for the current DBMS of the main data store.

Returns:

DbTypeConverter instance

getDbTypeConverter

DbTypeConverter getDbTypeConverter(java.lang.String storeName)

Returns DbTypeConverter for the current DBMS of the specified data store.

Parameters:

storeName - data store name

Returns:

DbTypeConverter instance

callInTransaction

<T> T callInTransaction(Transaction.Callable<T> callable)

Executes the action specified by the given single method object within a new transaction in the main data store.

See Also:

callInTransaction(String, Transaction.Callable), runInTransaction(Transaction.Runnable)

callInTransaction

<T> T callInTransaction(java.lang.String storeName,
                        Transaction.Callable<T> callable)

Executes the action specified by the given single method object within a new transaction.

Returns a result object created within the transaction.

A RuntimeException thrown in the transactional code enforces a rollback.

Type Parameters:

T - result type

Parameters:

storeName - data store name

callable - transactional code in the form of Transaction.Callable

Returns:

result object

See Also:

runInTransaction(Transaction.Runnable)

runInTransaction

void runInTransaction(Transaction.Runnable runnable)

Executes the action specified by the given single method object within a new transaction in the main data store.

See Also:

runInTransaction(String, Transaction.Runnable), callInTransaction(Transaction.Callable)

runInTransaction

void runInTransaction(java.lang.String storeName,
                      Transaction.Runnable runnable)

Executes the action specified by the given single method object within a new transaction.

A RuntimeException thrown in the transactional code enforces a rollback.

Parameters:

storeName - data store name

runnable - transactional code in the form of Transaction.Runnable

See Also:

callInTransaction(Transaction.Callable)

createTransaction

@CheckReturnValue
Transaction createTransaction(TransactionParams params)

Creates a new transaction in the main data store.

See Also:

createTransaction(TransactionParams)

createTransaction

@CheckReturnValue
Transaction createTransaction(java.lang.String storeName,
                                                TransactionParams params)

Creates a new transaction.
If there is an active transaction, it will be suspended.

Parameters:

storeName - data store name

params - new transaction parameters

Returns:

new transaction

createTransaction

@CheckReturnValue
Transaction createTransaction()

Creates a new transaction in the main data store.

See Also:

createTransaction(String)

createTransaction

@CheckReturnValue
Transaction createTransaction(java.lang.String storeName)

Creates a new transaction.
If there is an active transaction, it will be suspended.

Parameters:

storeName - data store name

Returns:

object to control the new transaction

getTransaction

@CheckReturnValue
Transaction getTransaction()

Creates a new transaction in the main data store if there is no one at the moment.

See Also:

getTransaction(String)

getTransaction

@CheckReturnValue
Transaction getTransaction(java.lang.String storeName)

Creates a new transaction if there is no one at the moment.

If a transaction exists, joins the current transaction. In this case:

• Subsequent invocation of Transaction.commit() does not affect current transaction.
• If Transaction.end() is called without previous Transaction.commit(), current transaction is marked as rollback-only, so any attempt to commit the surrounding Transaction will throw an exception.

Parameters:

storeName - data store name

Returns:

object to control the transaction

isInTransaction

boolean isInTransaction()

Current transaction status.

Returns:

true if there is currently at least one open transaction for main or additional data store

getEntityManager

@CheckReturnValue
EntityManager getEntityManager()

Returns existing or creates a new transaction-bound EntityManager for the main data store, which will be closed on transaction commit/rollback.

See Also:

getTransaction(String)

getEntityManager

@CheckReturnValue
EntityManager getEntityManager(java.lang.String storeName)

Returns existing or creates a new transaction-bound EntityManager, which will be closed on transaction commit/rollback.

Must be invoked inside a transaction.

Returns:

EntityManager instance

isSoftDeletion

boolean isSoftDeletion()

Global soft deletion attribute. True by default.

Returns:

true if soft deletion is on

setSoftDeletion

void setSoftDeletion(boolean value)

Set the global soft deletion attribute. The new value affects all EntityManagers created in new transactions.

Parameters:

value - true if soft deletion is on

getDataSource

javax.sql.DataSource getDataSource()

Returns:

main JDBC DataSource

getDataSource

javax.sql.DataSource getDataSource(java.lang.String storeName)

Returns:

JDBC DataSource of the give data store

getEntityManagerContext

EntityManagerContext getEntityManagerContext()

Returns context of the current EntityManager in the main data store.

Returns:

context

See Also:

getEntityManagerContext(String)

getEntityManagerContext

EntityManagerContext getEntityManagerContext(java.lang.String storeName)

Returns context of the current EntityManager.
If not exists, a new instance of context created and returned.

Parameters:

storeName - data store name

Returns:

context