com.phloc.db.jpa

Class AbstractGlobalEntityManagerFactory

java.lang.Object

com.phloc.scopes.AbstractSingleton

com.phloc.scopes.singleton.GlobalSingleton

com.phloc.db.jpa.AbstractGlobalEntityManagerFactory

All Implemented Interfaces:

com.phloc.scopes.IScopeDestructionAware

Direct Known Subclasses:

AbstractGlobalEntityManagerFactoryH2, AbstractGlobalEntityManagerFactoryMySQL

public abstract class AbstractGlobalEntityManagerFactory
extends com.phloc.scopes.singleton.GlobalSingleton

Abstract global singleton to handle a single persistence unit.

Author:

Philip Helger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractGlobalEntityManagerFactory(String sJdbcDriverClass, String sJdbcURL, String sUserName, String sPassword, String sPlatformClass, String sPersistenceUnitName, Map<String,Object> aAdditionalFactoryProperties) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
javax.persistence.EntityManager	createEntityManager() Create a new EntityManager with the default properties - usually this is suitable!
javax.persistence.EntityManager	createEntityManager(Map aMap) Create a new EntityManager with custom properties!
protected javax.persistence.EntityManagerFactory	customizeEntityManagerFactory(javax.persistence.EntityManagerFactory aEMF) This method allows you to customize the created EntityManagerFactory in any way.
Map<String,Object>	getAllFactoryProperties()
javax.persistence.EntityManagerFactory	getEntityManagerFactory()
String	getPersistenceUnitName()
protected void	onAfterInstantiation()
protected void	onDestroy() Called when the global scope is destroyed (e.g. upon servlet context shutdown)

Methods inherited from class com.phloc.scopes.singleton.GlobalSingleton

getAllGlobalSingletons, getGlobalSingleton, getGlobalSingletonIfInstantiated, isGlobalSingletonInstantiated

Methods inherited from class com.phloc.scopes.AbstractSingleton

getAllSingletons, getSingleton, getSingletonIfInstantiated, getSingletonScopeKey, isDestroyed, isInDestruction, isInInstantiation, isInstantiated, isSingletonInstantiated, isUsableObject, onScopeDestruction, readAbstractSingletonFields, setDestroyed, setInDestruction, setInInstantiation, setInstantiated, toString, writeAbstractSingletonFields

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractGlobalEntityManagerFactory

protected AbstractGlobalEntityManagerFactory(@Nonnull@Nonempty
                                  String sJdbcDriverClass,
                                  @Nonnull@Nonempty
                                  String sJdbcURL,
                                  @Nullable
                                  String sUserName,
                                  @Nullable
                                  String sPassword,
                                  @Nonnull@Nonempty
                                  String sPlatformClass,
                                  @Nonnull@Nonempty
                                  String sPersistenceUnitName,
                                  @Nullable
                                  Map<String,Object> aAdditionalFactoryProperties)

Constructor

Parameters:

sJdbcDriverClass - Name of the JDBC driver class. Must be a class implementing java.sql.Driver.

sJdbcURL - JDBC URL

sUserName - User name to access the DB. May be null.

sPassword - Password to access the DB. May be null.

sPlatformClass - The EclipseLink platform name. May either be a fully qualified class-name of a recognized abbreviation.

sPersistenceUnitName - The name of the persistence unit as stated in the persistence.xml

aAdditionalFactoryProperties - An optional Map with properties for EntityManagerFactory. This can even be used to overwrite the settings specified as explicit parameters, so be careful. This map is applied after the special properties are set! May be null.

Method Detail

customizeEntityManagerFactory

@Nonnull
@OverrideOnDemand
protected javax.persistence.EntityManagerFactory customizeEntityManagerFactory(@Nonnull
                                                                                            javax.persistence.EntityManagerFactory aEMF)

This method allows you to customize the created EntityManagerFactory in any way. By default it is returned as created.

Parameters:

aEMF - The original EntityManagerFactory. Never null.

Returns:

The final EntityManagerFactory to use. May not be null.

onAfterInstantiation

@OverridingMethodsMustInvokeSuper
protected void onAfterInstantiation()

Overrides:

onAfterInstantiation in class com.phloc.scopes.AbstractSingleton

onDestroy

@OverridingMethodsMustInvokeSuper
protected void onDestroy()
                  throws Exception

Called when the global scope is destroyed (e.g. upon servlet context shutdown)

Overrides:

onDestroy in class com.phloc.scopes.AbstractSingleton

Throws:

Exception - if closing fails

getPersistenceUnitName

@Nonnull
@Nonempty
public final String getPersistenceUnitName()

Returns:

The persistence unit name. Neither null nor empty.

getAllFactoryProperties

@Nonnull
@ReturnsMutableCopy
public final Map<String,Object> getAllFactoryProperties()

Returns:

The EntityManagerFactory creation properties. Never null.

getEntityManagerFactory

@Nonnull
public final javax.persistence.EntityManagerFactory getEntityManagerFactory()

Returns:

The underlying EntityManagerFactory. Never null.

createEntityManager

@Nonnull
public final javax.persistence.EntityManager createEntityManager()

Create a new EntityManager with the default properties - usually this is suitable!

Returns:

The created EntityManager and never null.

createEntityManager

@Nonnull
public javax.persistence.EntityManager createEntityManager(Map aMap)

Create a new EntityManager with custom properties!

Parameters:

aMap - The custom properties to use. May be null for no properties.

Returns:

The created EntityManager and never null.