org.opencastproject.util.persistence

Class PersistenceUtil

java.lang.Object

org.opencastproject.util.persistence.PersistenceUtil

public final class PersistenceUtil
extends Object

Functions supporting persistence.

Field Summary

Fields

Modifier and Type	Field and Description
static Map<String,Object>	NO_PERSISTENCE_PROPS

Method Summary

Modifier and Type	Method and Description
static void	closeQuietly(Connection c)
static Option<javax.persistence.EntityManager>	createEntityManager(javax.persistence.EntityManagerFactory emf) Create a new entity manager or return none, if the factory has already been closed.
static javax.persistence.Query	createNamedQuery(javax.persistence.EntityManager em, String queryName, Tuple<String,?>... params) Deprecated. use Queries.named query(EntityManager, String, Class, Object[])
static <F> PersistenceEnv2<F>	equip2(PersistenceEnv penv, Function<Exception,F> exHandler) Equip a persistence environment with an exception handler.
static <A,B> Option<A>	find(javax.persistence.EntityManager em, Function<B,A> toA, String queryName, Tuple<String,?>... params) Deprecated.
static <A,B> List<A>	findAll(javax.persistence.EntityManager em, Function<B,A> toA, Option<Integer> offset, Option<Integer> limit, String queryName, Tuple<String,?>... params) Deprecated. use Queries.named findAll(EntityManager, String, Option, Option, Object[]) instead
static <A,B> List<A>	findAll(javax.persistence.EntityManager em, Function<B,A> toA, String queryName, Tuple<String,?>... params) Deprecated. use Queries.named findAll(EntityManager, String, Object[]) instead
static <A> List<A>	findAll(javax.persistence.EntityManager em, String queryName, Option<Integer> offset, Option<Integer> limit, Tuple<String,?>... params) Deprecated. use Queries.named findAll(EntityManager, String, Option, Option, Object[])
static <A> List<A>	findAll(javax.persistence.EntityManager em, String queryName, Tuple<String,?>... params) Deprecated. use Queries.named findAll(EntityManager, String, Object[])
static <A> Function<javax.persistence.EntityManager,Option<A>>	findById(Class<A> clazz, Object primaryKey) Deprecated. use Queries.find(Class, Object)
static <A> Function<javax.persistence.EntityManager,A>	merge(A a) Deprecated. use Queries.merge(Object)
static javax.persistence.EntityManagerFactory	newEntityManagerFactory(org.osgi.service.component.ComponentContext cc, String emName) Create a new entity manager factory with the persistence unit name emName.
static javax.persistence.EntityManagerFactory	newEntityManagerFactory(org.osgi.service.component.ComponentContext cc, String emName, Map persistenceProps) Create a new entity manager factory with the persistence unit name emName.
static javax.persistence.EntityManagerFactory	newEntityManagerFactory(String emName, String vendor, String driver, String url, String user, String pwd, Map<String,?> persistenceProps, javax.persistence.spi.PersistenceProvider pp)
static PersistenceEnv	newPersistenceEnvironment(org.osgi.service.component.ComponentContext cc, String emName) Shortcut for newPersistenceEnvironment(newEntityManagerFactory(cc, emName)).
static PersistenceEnv	newPersistenceEnvironment(org.osgi.service.component.ComponentContext cc, String emName, Map persistenceProps) Shortcut for newPersistenceEnvironment(newEntityManagerFactory(cc, emName, persistenceProps)).
static PersistenceEnv	newPersistenceEnvironment(javax.persistence.EntityManagerFactory emf) Deprecated. use PersistenceEnvs.persistenceEnvironment(EntityManagerFactory)
static PersistenceEnv	newPersistenceEnvironment(javax.persistence.spi.PersistenceProvider persistenceProvider, String emName, Map persistenceProps) Create a new persistence environment.
static javax.persistence.EntityManagerFactory	newTestEntityManagerFactory(String emName) Create a new entity manager factory backed by an in-memory H2 database for testing purposes.
static PersistenceEnv	newTestPersistenceEnv(String emName) Deprecated. use PersistenceEnvs.testPersistenceEnv(String)
static <A> Function<javax.persistence.EntityManager,A>	persist(A a) Deprecated. use Queries.persist(Object)
static long	runCountQuery(javax.persistence.EntityManager em, String queryName, Tuple<String,?>... params) Deprecated. use Queries.named count(EntityManager, String, Object[])
static <A> Option<A>	runFirstResultQuery(javax.persistence.EntityManager em, String queryName, Tuple<String,?>... params) Deprecated. use Queries.named findFirst(EntityManager, String, Object[])
static <A> Option<A>	runSingleResultQuery(javax.persistence.EntityManager em, String queryName, Tuple<String,?>... params) Deprecated. use Queries.named #findSingle(EntityManager, String, Object[])
static boolean	runUpdate(javax.persistence.EntityManager em, String queryName, Tuple<String,?>... params) Deprecated. use Queries.named #update(EntityManager, String, Object[])
static Option<SQLException>	testConnection(DataSource ds) Test if a connection to the given data source can be established.
static javax.persistence.spi.PersistenceProvider	testPersistenceProvider() Create a new persistence provider for unit tests.

Methods inherited from class java.lang.Object

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

Field Detail

NO_PERSISTENCE_PROPS

public static final Map<String,Object> NO_PERSISTENCE_PROPS

Method Detail

newEntityManagerFactory

public static javax.persistence.EntityManagerFactory newEntityManagerFactory(org.osgi.service.component.ComponentContext cc,
                                                                             String emName)

Create a new entity manager factory with the persistence unit name emName. A PersistenceProvider named persistence has to be registered as an OSGi service. If you want to configure the factory please also register a map containing all properties under the name persistenceProps. See PersistenceProvider.createEntityManagerFactory(String, java.util.Map) for more information about config maps.

Parameters:

emName - name of the persistence unit

newEntityManagerFactory

public static javax.persistence.EntityManagerFactory newEntityManagerFactory(org.osgi.service.component.ComponentContext cc,
                                                                             String emName,
                                                                             Map persistenceProps)

Create a new entity manager factory with the persistence unit name emName. A PersistenceProvider named persistence has to be registered as an OSGi service. See PersistenceProvider.createEntityManagerFactory(String, java.util.Map) for more information about config maps.

Parameters:

emName - name of the persistence unit

persistenceProps - config map for the creation of an EntityManagerFactory

newPersistenceEnvironment

public static PersistenceEnv newPersistenceEnvironment(javax.persistence.spi.PersistenceProvider persistenceProvider,
                                                       String emName,
                                                       Map persistenceProps)

Create a new persistence environment. This method is the preferred way of creating a persitence environment.

newPersistenceEnvironment

public static PersistenceEnv newPersistenceEnvironment(org.osgi.service.component.ComponentContext cc,
                                                       String emName,
                                                       Map persistenceProps)

Shortcut for newPersistenceEnvironment(newEntityManagerFactory(cc, emName, persistenceProps)).

See Also:

newEntityManagerFactory(org.osgi.service.component.ComponentContext, String, java.util.Map)

newPersistenceEnvironment

public static PersistenceEnv newPersistenceEnvironment(org.osgi.service.component.ComponentContext cc,
                                                       String emName)

Shortcut for newPersistenceEnvironment(newEntityManagerFactory(cc, emName)).

See Also:

newEntityManagerFactory(org.osgi.service.component.ComponentContext, String)

createEntityManager

public static Option<javax.persistence.EntityManager> createEntityManager(javax.persistence.EntityManagerFactory emf)

Create a new entity manager or return none, if the factory has already been closed.

equip2

public static <F> PersistenceEnv2<F> equip2(PersistenceEnv penv,
                                            Function<Exception,F> exHandler)

Equip a persistence environment with an exception handler.

newPersistenceEnvironment

@Deprecated
public static PersistenceEnv newPersistenceEnvironment(javax.persistence.EntityManagerFactory emf)

Deprecated. use PersistenceEnvs.persistenceEnvironment(EntityManagerFactory)

Create a new, concurrently usable persistence environment which uses JPA local transactions.

Transaction propagation is supported on a per thread basis.

closeQuietly

public static void closeQuietly(Connection c)

testConnection

public static Option<SQLException> testConnection(DataSource ds)

Test if a connection to the given data source can be established.

Returns:

none, if the connection could be established

createNamedQuery

@Deprecated
public static javax.persistence.Query createNamedQuery(javax.persistence.EntityManager em,
                                                                   String queryName,
                                                                   Tuple<String,?>... params)

Deprecated. use Queries.named query(EntityManager, String, Class, Object[])

Create a named query with a list of parameters. Values of type Date are recognized and set as a timestamp ( TemporalType.TIMESTAMP.

runUpdate

@Deprecated
public static boolean runUpdate(javax.persistence.EntityManager em,
                                            String queryName,
                                            Tuple<String,?>... params)

Deprecated. use Queries.named #update(EntityManager, String, Object[])

Run an update (UPDATE or DELETE) query and ensure that at least one row got affected.

runSingleResultQuery

@Deprecated
public static <A> Option<A> runSingleResultQuery(javax.persistence.EntityManager em,
                                                             String queryName,
                                                             Tuple<String,?>... params)

Deprecated. use Queries.named #findSingle(EntityManager, String, Object[])

Run a query (SELECT) that should return a single result.

runFirstResultQuery

@Deprecated
public static <A> Option<A> runFirstResultQuery(javax.persistence.EntityManager em,
                                                            String queryName,
                                                            Tuple<String,?>... params)

Deprecated. use Queries.named findFirst(EntityManager, String, Object[])

Run a query that should return the first result of it.

runCountQuery

@Deprecated
public static long runCountQuery(javax.persistence.EntityManager em,
                                             String queryName,
                                             Tuple<String,?>... params)

Deprecated. use Queries.named count(EntityManager, String, Object[])

Execute a COUNT(x) query.

findById

@Deprecated
public static <A> Function<javax.persistence.EntityManager,Option<A>> findById(Class<A> clazz,
                                                                                           Object primaryKey)

Deprecated. use Queries.find(Class, Object)

find

@Deprecated
public static <A,B> Option<A> find(javax.persistence.EntityManager em,
                                               Function<B,A> toA,
                                               String queryName,
                                               Tuple<String,?>... params)

Deprecated.

Find a single object.

Parameters:

params - the query parameters

toA - map to the desired result object

findAll

@Deprecated
public static <A> List<A> findAll(javax.persistence.EntityManager em,
                                              String queryName,
                                              Tuple<String,?>... params)

Deprecated. use Queries.named findAll(EntityManager, String, Object[])

Find multiple objects.

findAll

@Deprecated
public static <A> List<A> findAll(javax.persistence.EntityManager em,
                                              String queryName,
                                              Option<Integer> offset,
                                              Option<Integer> limit,
                                              Tuple<String,?>... params)

Deprecated. use Queries.named findAll(EntityManager, String, Option, Option, Object[])

Find multiple objects with optional pagination.

findAll

@Deprecated
public static <A,B> List<A> findAll(javax.persistence.EntityManager em,
                                                Function<B,A> toA,
                                                String queryName,
                                                Tuple<String,?>... params)

Deprecated. use Queries.named findAll(EntityManager, String, Object[]) instead

Find multiple objects.

Parameters:

params - the query parameters

toA - map to the desired result object

findAll

@Deprecated
public static <A,B> List<A> findAll(javax.persistence.EntityManager em,
                                                Function<B,A> toA,
                                                Option<Integer> offset,
                                                Option<Integer> limit,
                                                String queryName,
                                                Tuple<String,?>... params)

Deprecated. use Queries.named findAll(EntityManager, String, Option, Option, Object[]) instead

Find multiple objects with optional pagination.

Parameters:

params - the query parameters

toA - map to the desired result object

persist

@Deprecated
public static <A> Function<javax.persistence.EntityManager,A> persist(A a)

Deprecated. use Queries.persist(Object)

Create function to persist object a using EntityManager.persist(Object).

merge

@Deprecated
public static <A> Function<javax.persistence.EntityManager,A> merge(A a)

Deprecated. use Queries.merge(Object)

Create function to merge an object a with the persisten context of the given entity manage.

newEntityManagerFactory

public static javax.persistence.EntityManagerFactory newEntityManagerFactory(String emName,
                                                                             String vendor,
                                                                             String driver,
                                                                             String url,
                                                                             String user,
                                                                             String pwd,
                                                                             Map<String,?> persistenceProps,
                                                                             javax.persistence.spi.PersistenceProvider pp)

newTestEntityManagerFactory

public static javax.persistence.EntityManagerFactory newTestEntityManagerFactory(String emName)

Create a new entity manager factory backed by an in-memory H2 database for testing purposes.

Parameters:

emName - name of the persistence unit (see META-INF/persistence.xml)

testPersistenceProvider

public static javax.persistence.spi.PersistenceProvider testPersistenceProvider()

Create a new persistence provider for unit tests.

newTestPersistenceEnv

@Deprecated
public static PersistenceEnv newTestPersistenceEnv(String emName)

Deprecated. use PersistenceEnvs.testPersistenceEnv(String)

Create a new persistence environment based on an entity manager factory backed by an in-memory H2 database for testing purposes.

Parameters:

emName - name of the persistence unit (see META-INF/persistence.xml)