play.db.jpa

Class JPA

java.lang.Object

play.db.jpa.JPA

public class JPA
extends java.lang.Object

JPA Helpers.

Constructor Summary

Constructors

Constructor and Description
JPA()

Method Summary

Modifier and Type	Method and Description
static void	bindForAsync(javax.persistence.EntityManager em) Bind an EntityManager to the current HTTP context.
static void	bindForSync(javax.persistence.EntityManager em) Bind an EntityManager to the current HTTP context.
static JPAApi	createFor(java.lang.String unitName) Create a default JPAApi with name "default" and the given unit name.
static JPAApi	createFor(java.lang.String name, java.lang.String unitName) Create a default JPAApi with the given persistence unit configuration.
static javax.persistence.EntityManager	em() Get the default EntityManager for this thread.
static javax.persistence.EntityManager	em(java.lang.String key) Get the EntityManager for a particular persistence unit for this thread.
static JPAApi	jpaApi() Get JPA api for the current play application.
static void	withTransaction(java.lang.Runnable block) Run a block of code in a JPA transaction.
static <T> T	withTransaction(java.lang.String name, boolean readOnly, java.util.function.Supplier<T> block) Run a block of code in a JPA transaction.
static <T> T	withTransaction(java.util.function.Supplier<T> block) Run a block of code in a JPA transaction.
static <T> F.Promise<T>	withTransactionAsync(java.lang.String name, boolean readOnly, java.util.function.Supplier<F.Promise<T>> block) Deprecated. This may cause deadlocks
static <T> F.Promise<T>	withTransactionAsync(java.util.function.Supplier<F.Promise<T>> block) Deprecated. This may cause deadlocks

Methods inherited from class java.lang.Object

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

Constructor Detail

JPA

public JPA()

Method Detail

createFor

public static JPAApi createFor(java.lang.String name,
                               java.lang.String unitName)

Create a default JPAApi with the given persistence unit configuration. Automatically initialise the JPA entity manager factories.

Parameters:

name - the EntityManagerFactory's name

unitName - the persistence unit's name

Returns:

the configured JPAApi

createFor

public static JPAApi createFor(java.lang.String unitName)

Create a default JPAApi with name "default" and the given unit name. Automatically initialise the JPA entity manager factories.

Parameters:

unitName - the persistence unit's name

Returns:

the configured JPAApi

jpaApi

public static JPAApi jpaApi()

Get JPA api for the current play application.

Returns:

the JPAApi

em

public static javax.persistence.EntityManager em(java.lang.String key)

Get the EntityManager for a particular persistence unit for this thread.

Parameters:

key - name of the EntityManager to return

Returns:

the EntityManager

em

public static javax.persistence.EntityManager em()

Get the default EntityManager for this thread.

Returns:

the EntityManager

Throws:

java.lang.RuntimeException - if no EntityManager is bound to the current Http.Context or the current Thread.

bindForSync

public static void bindForSync(javax.persistence.EntityManager em)

Bind an EntityManager to the current HTTP context. If no HTTP context is available the EntityManager gets bound to the current thread instead.

Parameters:

em - the EntityManager to bind to this HTTP context.

bindForAsync

public static void bindForAsync(javax.persistence.EntityManager em)

Bind an EntityManager to the current HTTP context.

Parameters:

em - the EntityManager to bind

Throws:

java.lang.RuntimeException - if no HTTP context is present.

withTransaction

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

Run a block of code in a JPA transaction.

Type Parameters:

T - return type of the block

Parameters:

block - Block of code to execute.

Returns:

the result of the block, having already committed the transaction (or rolled it back in case of exception)

withTransactionAsync

@Deprecated
public static <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 - return type of the block

Parameters:

block - Block of code to execute.

Returns:

a future to the result of the block, having already committed the transaction (or rolled it back in case of exception)

withTransaction

public static void withTransaction(java.lang.Runnable block)

Run a block of code in a JPA transaction.

Parameters:

block - Block of code to execute.

withTransaction

public static <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 - return type of the provided block

Parameters:

name - The persistence unit name

readOnly - Is the transaction read-only?

block - Block of code to execute.

Returns:

a future to the result of the block, having already committed the transaction (or rolled it back in case of exception)

withTransactionAsync

@Deprecated
public static <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 - return type of the block

Parameters:

name - The persistence unit name

readOnly - Is the transaction read-only?

block - Block of code to execute.

Returns:

a future to the result of the block, having already committed the transaction (or rolled it back in case of exception)