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() Get the EntityManager for a particular persistence unit for this thread.
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.
<T> T	withTransaction(java.util.function.Function<javax.persistence.EntityManager,T> block) Run a block of code with a given EntityManager.
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.Function<javax.persistence.EntityManager,T> block) Run a block of code with a given EntityManager.
<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.lang.String name, java.util.function.Function<javax.persistence.EntityManager,T> block) Run a block of code with a given EntityManager.
<T> T	withTransaction(java.util.function.Supplier<T> block) Run a block of code in a JPA transaction.

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

em

javax.persistence.EntityManager em()

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

Returns:

EntityManager for the specified persistence unit name

withTransaction

<T> T withTransaction(java.util.function.Function<javax.persistence.EntityManager,T> block)

Run a block of code with a given EntityManager.

Type Parameters:

T - type of result

Parameters:

block - Block of code to execute

Returns:

code execution result

withTransaction

<T> T withTransaction(java.lang.String name,
                      java.util.function.Function<javax.persistence.EntityManager,T> block)

Run a block of code with a given EntityManager.

Type Parameters:

T - type of result

Parameters:

name - The persistence unit name

block - Block of code to execute

Returns:

code execution result

withTransaction

<T> T withTransaction(java.lang.String name,
                      boolean readOnly,
                      java.util.function.Function<javax.persistence.EntityManager,T> block)

Run a block of code with a given EntityManager.

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

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

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

shutdown

void shutdown()

Close all entity manager factories.