play.db.jpa

Class DefaultJPAApi

java.lang.Object

play.db.jpa.DefaultJPAApi

All Implemented Interfaces:

JPAApi

public class DefaultJPAApi
extends java.lang.Object
implements JPAApi

Default implementation of the JPA API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultJPAApi.JPAApiProvider

Constructor Summary

Constructors

Constructor and Description
DefaultJPAApi(JPAConfig jpaConfig)
DefaultJPAApi(JPAConfig jpaConfig, JPAEntityManagerContext entityManagerContext) Deprecated. Deprecated as of 2.7.0. Use DefaultJPAApi(JPAConfig) instead.

Method Summary

Modifier and Type	Method and Description
javax.persistence.EntityManager	em() Deprecated. Deprecated as of 2.7.0. The EntityManager is supplied as lambda parameter instead when using withTransaction(Function)
javax.persistence.EntityManager	em(java.lang.String name) Get a newly created EntityManager for the specified persistence unit name.
void	shutdown() Close all entity manager factories.
JPAApi	start() Initialise JPA entity manager factories.
void	withTransaction(java.util.function.Consumer<javax.persistence.EntityManager> block) Run a block of code with a newly created EntityManager for the default Persistence Unit.
<T> T	withTransaction(java.util.function.Function<javax.persistence.EntityManager,T> block) Run a block of code with a newly created EntityManager for the default Persistence Unit.
void	withTransaction(java.lang.Runnable block) Deprecated. Deprecated as of 2.7.0. Use withTransaction(Consumer) instead.
void	withTransaction(java.lang.String name, boolean readOnly, java.util.function.Consumer<javax.persistence.EntityManager> block) Run a block of code with a newly created EntityManager for the named Persistence Unit.
<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 newly created EntityManager for the named Persistence Unit.
<T> T	withTransaction(java.lang.String name, boolean readOnly, java.util.function.Supplier<T> block) Deprecated. Deprecated as of 2.7.0. Use withTransaction(String, boolean, Function) instead.
void	withTransaction(java.lang.String name, java.util.function.Consumer<javax.persistence.EntityManager> block) Run a block of code with a newly created EntityManager for the named Persistence Unit.
<T> T	withTransaction(java.lang.String name, java.util.function.Function<javax.persistence.EntityManager,T> block) Run a block of code with a newly created EntityManager for the named Persistence Unit.
<T> T	withTransaction(java.util.function.Supplier<T> block) Deprecated. Deprecated as of 2.7.0. Use withTransaction(Function) instead.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultJPAApi

@Deprecated
public DefaultJPAApi(JPAConfig jpaConfig,
                                 JPAEntityManagerContext entityManagerContext)

Deprecated. Deprecated as of 2.7.0. Use DefaultJPAApi(JPAConfig) instead.

DefaultJPAApi

public DefaultJPAApi(JPAConfig jpaConfig)

Method Detail

start

public JPAApi start()

Initialise JPA entity manager factories.

Specified by:

start in interface JPAApi

Returns:

JPAApi instance

em

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

Get a newly created EntityManager for the specified persistence unit name.

Specified by:

em in interface JPAApi

Parameters:

name - The persistence unit name

Returns:

EntityManager for the specified persistence unit name

em

@Deprecated
public javax.persistence.EntityManager em()

Deprecated. Deprecated as of 2.7.0. The EntityManager is supplied as lambda parameter instead when using withTransaction(Function)

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

Specified by:

em in interface JPAApi

Returns:

EntityManager for the specified persistence unit name

withTransaction

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

Run a block of code with a newly created EntityManager for the default Persistence Unit.

Specified by:

withTransaction in interface JPAApi

Type Parameters:

T - type of result

Parameters:

block - Block of code to execute

Returns:

code execution result

withTransaction

public void withTransaction(java.util.function.Consumer<javax.persistence.EntityManager> block)

Run a block of code with a newly created EntityManager for the default Persistence Unit.

Specified by:

withTransaction in interface JPAApi

Parameters:

block - Block of code to execute

withTransaction

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

Run a block of code with a newly created EntityManager for the named Persistence Unit.

Specified by:

withTransaction in interface JPAApi

Type Parameters:

T - type of result

Parameters:

name - The persistence unit name

block - Block of code to execute

Returns:

code execution result

withTransaction

public void withTransaction(java.lang.String name,
                            java.util.function.Consumer<javax.persistence.EntityManager> block)

Run a block of code with a newly created EntityManager for the named Persistence Unit.

Specified by:

withTransaction in interface JPAApi

Parameters:

name - The persistence unit name

block - Block of code to execute

withTransaction

public <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 newly created EntityManager for the named Persistence Unit.

Specified by:

withTransaction in interface JPAApi

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

public void withTransaction(java.lang.String name,
                            boolean readOnly,
                            java.util.function.Consumer<javax.persistence.EntityManager> block)

Run a block of code with a newly created EntityManager for the named Persistence Unit.

Specified by:

withTransaction in interface JPAApi

Parameters:

name - The persistence unit name

readOnly - Is the transaction read-only?

block - Block of code to execute

withTransaction

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

Deprecated. Deprecated as of 2.7.0. Use withTransaction(Function) instead.

Run a block of code in a JPA transaction.

Specified by:

withTransaction in interface JPAApi

Type Parameters:

T - type of result

Parameters:

block - Block of code to execute

Returns:

code execution result

withTransaction

@Deprecated
public void withTransaction(java.lang.Runnable block)

Deprecated. Deprecated as of 2.7.0. Use withTransaction(Consumer) instead.

Run a block of code in a JPA transaction.

Specified by:

withTransaction in interface JPAApi

Parameters:

block - Block of code to execute

withTransaction

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

Deprecated. Deprecated as of 2.7.0. Use withTransaction(String, boolean, Function) instead.

Run a block of code in a JPA transaction.

Specified by:

withTransaction in interface JPAApi

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

public void shutdown()

Close all entity manager factories.

Specified by:

shutdown in interface JPAApi