play.db.jpa

Interface JPAApi

All Known Implementing Classes:

DefaultJPAApi

public interface JPAApi

JPA API.

Method Summary

Modifier and Type	Method and Description
javax.persistence.EntityManager	em(java.lang.String name) Get the EntityManager for the specified persistence unit name.
void	shutdown() Close all entity manager factories.
JPAApi	start() Initialise JPA entity manager factories.
void	withTransaction(java.lang.Runnable block) Run a block of code in a JPA transaction.
<T> T	withTransaction(java.lang.String name, boolean readOnly, java.util.function.Supplier<T> block) Run a block of code in a JPA transaction.
<T> T	withTransaction(java.util.function.Supplier<T> block) Run a block of code in a JPA transaction.
<T> F.Promise<T>	withTransactionAsync(java.lang.String name, boolean readOnly, java.util.function.Supplier<F.Promise<T>> block) Deprecated. This may cause deadlocks
<T> F.Promise<T>	withTransactionAsync(java.util.function.Supplier<F.Promise<T>> block) Deprecated. This may cause deadlocks

Method Detail

start

JPAApi start()

Initialise JPA entity manager factories.

Returns:

JPAApi instance

em

javax.persistence.EntityManager em(java.lang.String name)

Get the EntityManager for the specified persistence unit name.

Parameters:

name - The persistence unit name

Returns:

EntityManager for the specified persistence unit name

withTransaction

<T> T withTransaction(java.util.function.Supplier<T> block)

Run a block of code in a JPA transaction.

Type Parameters:

T - type of result

Parameters:

block - Block of code to execute

Returns:

code execution result

withTransactionAsync

@Deprecated
<T> F.Promise<T> withTransactionAsync(java.util.function.Supplier<F.Promise<T>> block)

Deprecated. This may cause deadlocks

Run a block of asynchronous code in a JPA transaction.

Type Parameters:

T - type of result

Parameters:

block - Block of code to execute

Returns:

code execution result

withTransaction

void withTransaction(java.lang.Runnable block)

Run a block of code in a JPA transaction.

Parameters:

block - Block of code to execute

withTransaction

<T> T withTransaction(java.lang.String name,
                      boolean readOnly,
                      java.util.function.Supplier<T> block)

Run a block of code in a JPA transaction.

Type Parameters:

T - type of result

Parameters:

name - The persistence unit name

readOnly - Is the transaction read-only?

block - Block of code to execute

Returns:

code execution result

withTransactionAsync

@Deprecated
<T> F.Promise<T> withTransactionAsync(java.lang.String name,
                                                  boolean readOnly,
                                                  java.util.function.Supplier<F.Promise<T>> block)

Deprecated. This may cause deadlocks

Run a block of asynchronous code in a JPA transaction.

Type Parameters:

T - type of result

Parameters:

name - The persistence unit name

readOnly - Is the transaction read-only?

block - Block of code to execute.

Returns:

code execution result

shutdown

void shutdown()

Close all entity manager factories.