org.opencastproject.util.persistencefn

Class PersistenceUtil

java.lang.Object

org.opencastproject.util.persistencefn.PersistenceUtil

public final class PersistenceUtil
extends Object

Functions supporting persistence.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PersistenceUtil.DatabaseVendor

Field Summary

Fields

Modifier and Type	Field and Description
static com.entwinemedia.fn.Fn<javax.persistence.EntityManager,com.entwinemedia.fn.data.Opt<DatabaseMetaData>>	getDatabaseMetadata getDatabaseMetadata(EntityManager) as a function.
static Map<String,Object>	NO_PERSISTENCE_PROPS

Method Summary

Modifier and Type	Method and Description
static void	closeQuietly(Connection c)
static com.entwinemedia.fn.data.Opt<DatabaseMetaData>	getDatabaseMetadata(javax.persistence.EntityManager em) Try to get the database metadata from an entity manager.
static PersistenceUtil.DatabaseVendor	getVendor(DatabaseMetaData m) Get the database vendor from some metadata.
static com.entwinemedia.fn.data.Opt<javax.persistence.EntityManager>	mkEntityManager(javax.persistence.EntityManagerFactory emf) Create a new entity manager or return none, if the factory has already been closed.
static javax.persistence.EntityManagerFactory	mkEntityManagerFactory(org.osgi.service.component.ComponentContext cc, String emName) Create a new entity manager factory with the persistence unit name emName.
static javax.persistence.EntityManagerFactory	mkEntityManagerFactory(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	mkEntityManagerFactory(String emName, String vendor, String driver, String url, String user, String pwd, Map<String,?> persistenceProps, javax.persistence.spi.PersistenceProvider pp)
static javax.persistence.EntityManagerFactory	mkMySqlTestEntityManagerFactory(String emName, String jdbcUri, String user, String pwd, boolean withSqlLogging, boolean keepDatabase) Create a new entity manager factory using a MySQL database for testing purposes.
static javax.persistence.EntityManagerFactory	mkTestEntityManagerFactory(String emName) Create a new entity manager factory backed by an in-memory H2 database for testing purposes.
static javax.persistence.EntityManagerFactory	mkTestEntityManagerFactory(String emName, boolean withSqlLogging) Create a new entity manager factory backed by an in-memory H2 database for testing purposes.
static javax.persistence.EntityManagerFactory	mkTestEntityManagerFactoryFromSystemProperties(String emName) Create an entity manager for unit tests configured by the following system properties.
static javax.persistence.spi.PersistenceProvider	mkTestPersistenceProvider() Create a new persistence provider for unit tests.
static com.entwinemedia.fn.data.Opt<SQLException>	testConnection(DataSource ds) Test if a connection to the given data source can be established.

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

getDatabaseMetadata

public static final com.entwinemedia.fn.Fn<javax.persistence.EntityManager,com.entwinemedia.fn.data.Opt<DatabaseMetaData>> getDatabaseMetadata

getDatabaseMetadata(EntityManager) as a function.

Method Detail

mkEntityManagerFactory

public static javax.persistence.EntityManagerFactory mkEntityManagerFactory(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

mkEntityManagerFactory

public static javax.persistence.EntityManagerFactory mkEntityManagerFactory(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

mkEntityManagerFactory

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

mkEntityManager

public static com.entwinemedia.fn.data.Opt<javax.persistence.EntityManager> mkEntityManager(javax.persistence.EntityManagerFactory emf)

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

mkTestEntityManagerFactory

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

Create a new entity manager factory backed by an in-memory H2 database for testing purposes. If you want to turn on SQL logging see mkTestEntityManagerFactory(String)

Parameters:

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

mkTestEntityManagerFactory

public static javax.persistence.EntityManagerFactory mkTestEntityManagerFactory(String emName,
                                                                                boolean withSqlLogging)

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)

withSqlLogging - turn on EclipseLink SQL logging

mkTestEntityManagerFactoryFromSystemProperties

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

Create an entity manager for unit tests configured by the following system properties.

• -Dtest-database-url, JDBC URL, defaults to H2 in-memory database
• -Dtest-database-user, defaults to 'matterhorn'
• -Dtest-database-password, defaults to 'matterhorn'
• -Dsql-logging=[true|false], defaults to 'false', turns on SQL logging to the console
• -Dkeep-database=[true|false], defaults to 'false', keep an existing database or recreate at startup. Not used with H2.

Currently only MySQL is recognized.

Parameters:

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

mkMySqlTestEntityManagerFactory

public static javax.persistence.EntityManagerFactory mkMySqlTestEntityManagerFactory(String emName,
                                                                                     String jdbcUri,
                                                                                     String user,
                                                                                     String pwd,
                                                                                     boolean withSqlLogging,
                                                                                     boolean keepDatabase)

Create a new entity manager factory using a MySQL database for testing purposes.

Parameters:

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

jdbcUri - the JDBC URI of the database, e.g. jdbc:mysql://localhost/test_database

user - the database user

pwd - the user's password

withSqlLogging - turn on SQL logging

keepDatabase - recreate or keep the database at startup

mkTestPersistenceProvider

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

Create a new persistence provider for unit tests.

closeQuietly

public static void closeQuietly(Connection c)

testConnection

public static com.entwinemedia.fn.data.Opt<SQLException> testConnection(DataSource ds)

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

Returns:

none, if the connection could be established

getDatabaseMetadata

public static com.entwinemedia.fn.data.Opt<DatabaseMetaData> getDatabaseMetadata(javax.persistence.EntityManager em)

Try to get the database metadata from an entity manager. Return none, if the metadata cannot be retrieved, e.g. because the entity manager does not expose them.

getVendor

public static PersistenceUtil.DatabaseVendor getVendor(DatabaseMetaData m)

Get the database vendor from some metadata.

Returns:

PersistenceUtil.DatabaseVendor.UNKNOWN in case the database is not known or an arbitrary error occurs