org.eclipse.persistence.internal.jpa

Class EntityManagerFactoryImpl

java.lang.Object

org.eclipse.persistence.internal.jpa.EntityManagerFactoryImpl

All Implemented Interfaces:

JpaEntityManagerFactory

public class EntityManagerFactoryImpl
extends java.lang.Object
implements JpaEntityManagerFactory

Wraps our implementation of EntityManagerFactory Most operations are forwarded to the delegate. This wrapper is used to enable the refreshMetadata functionality which allows you to switch the underlying metadata for an EMF after deploy time.

Author:

tware

Field Summary

Fields

Modifier and Type	Field and Description
protected EntityManagerFactoryDelegate	delegate

Constructor Summary

Constructors

Constructor and Description
EntityManagerFactoryImpl(AbstractSession serverSession) Will return an instance of the Factory.
EntityManagerFactoryImpl(EntityManagerSetupImpl setupImpl, java.util.Map properties)
EntityManagerFactoryImpl(java.lang.String persistenceUnitName, java.util.Map<java.lang.String,java.lang.Object> properties, java.util.List<ClassDescriptor> descriptors) Create a dynamic persistence unit which does not use the persistence.xml.

Method Summary

Modifier and Type	Method and Description
<T> void	addNamedEntityGraph(java.lang.String graphName, <any> entityGraph)
void	addNamedQuery(java.lang.String name, Query query)
void	close() Closes this factory, releasing any resources that might be held by this factory.
EntityManager	createEntityManager() PUBLIC: Returns an EntityManager for this deployment.
EntityManager	createEntityManager(java.util.Map properties) PUBLIC: Returns an EntityManager for this deployment.
EntityManager	createEntityManager(SynchronizationType synchronizationType)
EntityManager	createEntityManager(SynchronizationType synchronizationType, java.util.Map map)
protected EntityManagerImpl	createEntityManagerImpl(java.util.Map properties, SynchronizationType syncType)
boolean	getBeginEarlyTransaction() Return default join existing transaction property, allows reading through write connection.
Cache	getCache() Access the cache that is associated with the entity manager factory (the "second level cache").
boolean	getCloseOnCommit() Return default property to avoid resuming unit of work if going to be closed on commit anyway.
CommitOrderType	getCommitOrder() Return if updates should be ordered by primary key to avoid possible database deadlocks.
boolean	getCommitWithoutPersistRules() Return default property to avoid discover new objects in unit of work if application always uses persist.
CriteriaBuilder	getCriteriaBuilder()
DatabaseSessionImpl	getDatabaseSession() Returns the DatabaseSession that the Factory will be using and initializes it if it is not available.
java.lang.String	getFlushClearCache() Return the default FlashClearCache mode to be used.
FlushModeType	getFlushMode() Return default property, allows flush before query to be avoided.
java.lang.Object	getIdentifier(java.lang.Object entity) Returns the id of the entity.
static java.lang.Object	getIdentifier(java.lang.Object entity, AbstractSession session) Returns the id of the entity.
Metamodel	getMetamodel() Return an instance of Metamodel interface for access to the metamodel of the persistence unit.
PersistenceUnitUtil	getPersistenceUnitUtil() Return interface providing access to utility methods for the persistence unit.
boolean	getPersistOnCommit() Return default property to avoid discover new objects in unit of work if application always uses persist.
java.util.Map<java.lang.String,java.lang.Object>	getProperties()
java.lang.Object	getProperty(java.lang.String name) The method return user defined property passed in from EntityManagerFactory.
ReferenceMode	getReferenceMode() Return default property, allows weak unit of work references.
ServerSession	getServerSession() INTERNAL: Returns the ServerSession that the Factory will be using and initializes it if it is not available.
SessionBroker	getSessionBroker() INTERNAL: Returns the SessionBroker that the Factory will be using and initializes it if it is not available.
boolean	isLoaded(java.lang.Object entity) Determine the load state of an entity belonging to the persistence unit.
static java.lang.Boolean	isLoaded(java.lang.Object entity, AbstractSession session) Determine the load state of an entity belonging to the persistence unit.
static java.lang.Boolean	isLoaded(java.lang.Object entity, java.lang.String attributeName, AbstractSession session) Determine the load state of a given persistent attribute of an entity belonging to the persistence unit.
static boolean	isLoaded(java.lang.Object entity, java.lang.String attributeName, DatabaseMapping mapping) Check whether a named attribute on a given entity with a given mapping has been loaded.
boolean	isOpen() Indicates whether or not this factory is open.
void	refreshMetadata(java.util.Map<java.lang.String,java.lang.Object> properties) ADVANCED: Re-bootstrap this factory.
void	setBeginEarlyTransaction(boolean beginEarlyTransaction) Set default join existing transaction property, allows reading through write connection.
void	setCloseOnCommit(boolean closeOnCommit) Set default property to avoid resuming unit of work if going to be closed on commit anyway.
void	setCommitOrder(CommitOrderType commitOrder) Set updates should be ordered by primary key to avoid possible database deadlocks.
void	setCommitWithoutPersistRules(boolean commitWithoutPersistRules) Set default property to avoid discover new objects in unit of work if application always uses persist.
void	setFlushClearCache(java.lang.String flushClearCache) Set the default FlashClearCache mode to be used.
void	setFlushMode(FlushModeType flushMode) Set default property, allows flush before query to be avoided.
void	setMetamodel(Metamodel aMetamodel) INTERNAL: Convenience function to allow us to reset the Metamodel in the possible case that we want to regenerate it.
void	setPersistOnCommit(boolean persistOnCommit) Set default property to avoid discover new objects in unit of work if application always uses persist.
void	setReferenceMode(ReferenceMode referenceMode) Set default property, allows weak unit of work references.
void	setShouldValidateExistence(boolean shouldValidateExistence) Set the default to determine if does-exist should be performed on persist.
boolean	shouldValidateExistence() Return the default to determine if does-exist should be performed on persist.
EntityManagerFactoryDelegate	unwrap() Gets the underlying implementation of the EntityManagerFactory.
<T> T	unwrap(java.lang.Class<T> cls)
protected void	verifyOpen()

Methods inherited from class java.lang.Object

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

Field Detail

delegate

protected EntityManagerFactoryDelegate delegate

Constructor Detail

EntityManagerFactoryImpl

public EntityManagerFactoryImpl(AbstractSession serverSession)

Will return an instance of the Factory. Should only be called by EclipseLink.

Parameters:

serverSession -

EntityManagerFactoryImpl

public EntityManagerFactoryImpl(EntityManagerSetupImpl setupImpl,
                                java.util.Map properties)

EntityManagerFactoryImpl

public EntityManagerFactoryImpl(java.lang.String persistenceUnitName,
                                java.util.Map<java.lang.String,java.lang.Object> properties,
                                java.util.List<ClassDescriptor> descriptors)

Create a dynamic persistence unit which does not use the persistence.xml. Instead all configuration is driven from the provided persistence unit properties and descriptors.

Method Detail

getIdentifier

public static java.lang.Object getIdentifier(java.lang.Object entity,
                                             AbstractSession session)

Returns the id of the entity. A generated id is not guaranteed to be available until after the database insert has occurred. Returns null if the entity does not yet have an id

Parameters:

entity -

Returns:

id of the entity

Throws:

java.lang.IllegalArgumentException - if the entity is found not to be an entity.

isLoaded

public static java.lang.Boolean isLoaded(java.lang.Object entity,
                                         AbstractSession session)

Determine the load state of an entity belonging to the persistence unit. This method can be used to determine the load state of an entity passed as a reference. An entity is considered loaded if all attributes for which FetchType EAGER has been specified have been loaded. The isLoaded(Object, String) method should be used to determine the load state of an attribute. Not doing so might lead to unintended loading of state.

Parameters:

entity - whose load state is to be determined

Returns:

false if the entity has not been loaded, else true.

isLoaded

public static java.lang.Boolean isLoaded(java.lang.Object entity,
                                         java.lang.String attributeName,
                                         AbstractSession session)

Determine the load state of a given persistent attribute of an entity belonging to the persistence unit.

Parameters:

entity - containing the attribute

attributeName - name of attribute whose load state is to be determined

Returns:

false if entity's state has not been loaded or if the attribute state has not been loaded, otherwise true

isLoaded

public static boolean isLoaded(java.lang.Object entity,
                               java.lang.String attributeName,
                               DatabaseMapping mapping)

Check whether a named attribute on a given entity with a given mapping has been loaded. This method will check the valueholder or indirect collection for LAZY ForeignReferenceMappings to see if has been instantiated and otherwise check the fetch group.

Parameters:

entity -

attributeName -

mapping -

Returns:

refreshMetadata

public void refreshMetadata(java.util.Map<java.lang.String,java.lang.Object> properties)

ADVANCED: Re-bootstrap this factory. This method will rebuild the EntityManagerFactory. It should be used in conjunction with a MetadataSource to allow mappings to be changed in a running system. All existing EntityMangers will continue to function with the old metadata, but new factories will use the new metadata.

Specified by:

refreshMetadata in interface JpaEntityManagerFactory

Parameters:

properties -

getSessionBroker

public SessionBroker getSessionBroker()

INTERNAL: Returns the SessionBroker that the Factory will be using and initializes it if it is not available. This method makes use of the partially constructed session stored in our setupImpl and completes its construction TODO: should throw IllegalStateException if not SessionBroker

Specified by:

getSessionBroker in interface JpaEntityManagerFactory

getServerSession

public ServerSession getServerSession()

INTERNAL: Returns the ServerSession that the Factory will be using and initializes it if it is not available. This method makes use of the partially constructed session stored in our setupImpl and completes its construction

Specified by:

getServerSession in interface JpaEntityManagerFactory

close

public void close()

Closes this factory, releasing any resources that might be held by this factory. After invoking this method, all methods on the instance will throw an IllegalStateException, except for isOpen(), which will return false.

isOpen

public boolean isOpen()

Indicates whether or not this factory is open. Returns true until a call to close() is made.

createEntityManager

public EntityManager createEntityManager()

PUBLIC: Returns an EntityManager for this deployment.

createEntityManager

public EntityManager createEntityManager(java.util.Map properties)

PUBLIC: Returns an EntityManager for this deployment.

createEntityManager

public EntityManager createEntityManager(SynchronizationType synchronizationType)

createEntityManager

public EntityManager createEntityManager(SynchronizationType synchronizationType,
                                         java.util.Map map)

createEntityManagerImpl

protected EntityManagerImpl createEntityManagerImpl(java.util.Map properties,
                                                    SynchronizationType syncType)

unwrap

public EntityManagerFactoryDelegate unwrap()

Gets the underlying implementation of the EntityManagerFactory. This method will return a version of EntityManagerFactory that is based on the available metadata at the time it is called. Future calls to refresh will not affect that metadata on this EntityManagerFactory.

Specified by:

unwrap in interface JpaEntityManagerFactory

Returns:

verifyOpen

protected void verifyOpen()

getProperty

public java.lang.Object getProperty(java.lang.String name)

The method return user defined property passed in from EntityManagerFactory.

getBeginEarlyTransaction

public boolean getBeginEarlyTransaction()

Return default join existing transaction property, allows reading through write connection.

setBeginEarlyTransaction

public void setBeginEarlyTransaction(boolean beginEarlyTransaction)

Set default join existing transaction property, allows reading through write connection.

getFlushMode

public FlushModeType getFlushMode()

Return default property, allows flush before query to be avoided.

setFlushMode

public void setFlushMode(FlushModeType flushMode)

Set default property, allows flush before query to be avoided.

getReferenceMode

public ReferenceMode getReferenceMode()

Return default property, allows weak unit of work references.

setReferenceMode

public void setReferenceMode(ReferenceMode referenceMode)

Set default property, allows weak unit of work references.

getCloseOnCommit

public boolean getCloseOnCommit()

Return default property to avoid resuming unit of work if going to be closed on commit anyway.

setCloseOnCommit

public void setCloseOnCommit(boolean closeOnCommit)

Set default property to avoid resuming unit of work if going to be closed on commit anyway.

getPersistOnCommit

public boolean getPersistOnCommit()

Return default property to avoid discover new objects in unit of work if application always uses persist.

getPersistenceUnitUtil

public PersistenceUnitUtil getPersistenceUnitUtil()

Return interface providing access to utility methods for the persistence unit.

Returns:

PersistenceUnitUtil interface

Throws:

java.lang.IllegalStateException - if the entity manager factory has been closed.

setPersistOnCommit

public void setPersistOnCommit(boolean persistOnCommit)

Set default property to avoid discover new objects in unit of work if application always uses persist.

getCommitWithoutPersistRules

public boolean getCommitWithoutPersistRules()

Return default property to avoid discover new objects in unit of work if application always uses persist.

setCommitWithoutPersistRules

public void setCommitWithoutPersistRules(boolean commitWithoutPersistRules)

Set default property to avoid discover new objects in unit of work if application always uses persist.

getFlushClearCache

public java.lang.String getFlushClearCache()

Return the default FlashClearCache mode to be used. Relevant only in case call to flush method followed by call to clear method.

See Also:

org.eclipse.persistence.config.FlushClearCache

setFlushClearCache

public void setFlushClearCache(java.lang.String flushClearCache)

Set the default FlashClearCache mode to be used. Relevant only in case call to flush method followed by call to clear method.

See Also:

org.eclipse.persistence.config.FlushClearCache

shouldValidateExistence

public boolean shouldValidateExistence()

Return the default to determine if does-exist should be performed on persist.

setShouldValidateExistence

public void setShouldValidateExistence(boolean shouldValidateExistence)

Set the default to determine if does-exist should be performed on persist.

getCache

public Cache getCache()

Access the cache that is associated with the entity manager factory (the "second level cache").

Returns:

instance of the Cache interface

Throws:

java.lang.IllegalStateException - if the entity manager factory has been closed

Since:

Java Persistence 2.0

See Also:

javax.persistence.EntityManagerFactory#getCache()

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

Since:

Java Persistence API 2.0

See Also:

javax.persistence.EntityManagerFactory#getProperties()

getDatabaseSession

public DatabaseSessionImpl getDatabaseSession()

Description copied from interface: JpaEntityManagerFactory

Returns the DatabaseSession that the Factory will be using and initializes it if it is not available.

Specified by:

getDatabaseSession in interface JpaEntityManagerFactory

getCriteriaBuilder

public CriteriaBuilder getCriteriaBuilder()

Since:

Java Persistence 2.0

See Also:

javax.persistence.EntityManagerFactory#getCriteriaBuilder()

getMetamodel

public Metamodel getMetamodel()

Return an instance of Metamodel interface for access to the metamodel of the persistence unit.

Returns:

Metamodel instance

Throws:

java.lang.IllegalStateException - if the entity manager factory has been closed.

Since:

Java Persistence 2.0

See Also:

javax.persistence.EntityManagerFactory#getMetamodel()

setMetamodel

public void setMetamodel(Metamodel aMetamodel)

INTERNAL: Convenience function to allow us to reset the Metamodel in the possible case that we want to regenerate it. This function is outside of the JPA 2.0 specification.

Parameters:

aMetamodel -

Since:

Java Persistence 2.0

isLoaded

public boolean isLoaded(java.lang.Object entity)

Determine the load state of an entity belonging to the persistence unit. This method can be used to determine the load state of an entity passed as a reference. An entity is considered loaded if all attributes for which FetchType EAGER has been specified have been loaded. The isLoaded(Object, String) method should be used to determine the load state of an attribute. Not doing so might lead to unintended loading of state.

Parameters:

entity - whose load state is to be determined

Returns:

false if the entity has not been loaded, else true.

getIdentifier

public java.lang.Object getIdentifier(java.lang.Object entity)

Returns the id of the entity. A generated id is not guaranteed to be available until after the database insert has occurred. Returns null if the entity does not yet have an id

Parameters:

entity -

Returns:

id of the entity

Throws:

java.lang.IllegalStateException - if the entity is found not to be an entity.

getCommitOrder

public CommitOrderType getCommitOrder()

Return if updates should be ordered by primary key to avoid possible database deadlocks.

setCommitOrder

public void setCommitOrder(CommitOrderType commitOrder)

Set updates should be ordered by primary key to avoid possible database deadlocks.

addNamedQuery

public void addNamedQuery(java.lang.String name,
                          Query query)

unwrap

public <T> T unwrap(java.lang.Class<T> cls)

addNamedEntityGraph

public <T> void addNamedEntityGraph(java.lang.String graphName,
                                    <any> entityGraph)