EntityManagerFactoryDelegate

java.lang.Object
- org.eclipse.persistence.internal.jpa.EntityManagerFactoryDelegate

All Implemented Interfaces:

JpaEntityManagerFactory
```
public class EntityManagerFactoryDelegate
extends java.lang.Object
implements JpaEntityManagerFactory
```
Purpose: Provides the implementation for the EntityManager Factory.
Description: This class will store a reference to the active ServerSession. When a request is made for an EntityManager an new EntityManager is created with the ServerSession and returned. The primary consumer of these EntityManager is assumed to be either the Container. There is one EntityManagerFactory per deployment.

Since:

TopLink Essentials - JPA 1.0

Author:

gyorke

See Also:

javax.persistence.EntityManager, JpaEntityManager, JpaEntityManagerFactory

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`beginEarlyTransaction` Default join existing transaction property, allows reading through write connection.
`protected boolean`	`closeOnCommit` Default property to avoid resuming unit of work if going to be closed on commit anyway.
`protected CommitOrderType`	`commitOrder` Order updates by id to avoid potential deadlocks.
`protected boolean`	`commitWithoutPersistRules`
`protected java.lang.String`	`flushClearCache` Default FlashClearCache mode to be used.
`protected FlushModeType`	`flushMode` Default property, allows flush before query to be avoided.
`protected boolean`	`isOpen` Stores if closed has been called.
`protected Cache`	`myCache` Reference to Cache Interface.
`protected JpaEntityManagerFactory`	`owner` Pointer to the EntityManagerFactoryImpl that created me
`protected boolean`	`persistOnCommit` Default property to avoid discover new objects in unit of work if application always uses persist.
`protected java.util.Map`	`properties` Persistence unit properties from create factory.
`protected ReferenceMode`	`referenceMode` Default property, allows weak unit of work references.
`protected AbstractSession`	`session` Reference to the ServerSession for this deployment.
`protected EntityManagerSetupImpl`	`setupImpl` EntityManagerSetupImpl that deployed this factory.
`protected boolean`	`shouldValidateExistence` Default to determine if does-exist should be performed on persist.
`protected static java.util.Set<java.lang.String>`	`supportedNonServerSessionProperties` INTERNAL: The following properties passed to createEMF cached and processed on the emf directly.

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
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)`
`protected void`	`finalize()`
`AbstractSession`	`getAbstractSession()` INTERNAL: Returns the ServerSession that the Factory will be using and initializes it if it is not available.
`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 potential 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()` INTERNAL: Returns the ServerSession 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.
`Metamodel`	`getMetamodel()` Return an instance of Metamodel interface for access to the metamodel of the persistence unit.
`JpaEntityManagerFactory`	`getOwner()` INTERNAL: Get the EntityManagerFactoryImpl that created this
`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.
`EntityManagerSetupImpl`	`getSetupImpl()` INTERNAL: Return the EntityManagerSetupImpl associated with this factory
`boolean`	`isLoaded(java.lang.Object entity)` Determine the load state of an entity belonging to the persistence unit.
`boolean`	`isLoaded(java.lang.Object entity, java.lang.String attributeName)` Determine the load state of a given persistent attribute of an entity belonging to the persistence unit.
`boolean`	`isOpen()` Indicates whether or not this factory is open.
`protected void`	`processProperties(java.util.Map properties)` Process all EntityManager properties.
`void`	`refreshMetadata(java.util.Map 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 update ordering by primary key, to avoid potential 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, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - myCache
```
protected Cache myCache
```
    Reference to Cache Interface.
  - session
```
protected volatile AbstractSession session
```
    Reference to the ServerSession for this deployment.
  - setupImpl
```
protected EntityManagerSetupImpl setupImpl
```
    EntityManagerSetupImpl that deployed this factory.
  - isOpen
```
protected boolean isOpen
```
    Stores if closed has been called.
  - properties
```
protected java.util.Map properties
```
    Persistence unit properties from create factory.
  - supportedNonServerSessionProperties
```
protected static final java.util.Set<java.lang.String> supportedNonServerSessionProperties
```
    INTERNAL: The following properties passed to createEMF cached and processed on the emf directly. None of these properties processed during predeploy or deploy.
  - beginEarlyTransaction
```
protected boolean beginEarlyTransaction
```
    Default join existing transaction property, allows reading through write connection.
  - flushMode
```
protected FlushModeType flushMode
```
    Default property, allows flush before query to be avoided.
  - referenceMode
```
protected ReferenceMode referenceMode
```
    Default property, allows weak unit of work references.
  - closeOnCommit
```
protected boolean closeOnCommit
```
    Default property to avoid resuming unit of work if going to be closed on commit anyway.
  - persistOnCommit
```
protected boolean persistOnCommit
```
    Default property to avoid discover new objects in unit of work if application always uses persist.
  - flushClearCache
```
protected java.lang.String flushClearCache
```
    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
```
protected boolean shouldValidateExistence
```
    Default to determine if does-exist should be performed on persist.
  - commitOrder
```
protected CommitOrderType commitOrder
```
    Order updates by id to avoid potential deadlocks. Default is true.
  - commitWithoutPersistRules
```
protected boolean commitWithoutPersistRules
```
  - owner
```
protected JpaEntityManagerFactory owner
```
    Pointer to the EntityManagerFactoryImpl that created me
- Constructor Detail
  - EntityManagerFactoryDelegate
```
public EntityManagerFactoryDelegate(AbstractSession databaseSession,
                                    JpaEntityManagerFactory owner)
```
    Will return an instance of the Factory. Should only be called by EclipseLink.
    
    Parameters:
    
    databaseSession -
  - EntityManagerFactoryDelegate
```
public EntityManagerFactoryDelegate(EntityManagerSetupImpl setupImpl,
                                    java.util.Map properties,
                                    JpaEntityManagerFactory owner)
```
  - EntityManagerFactoryDelegate
```
public EntityManagerFactoryDelegate(java.lang.String persistenceUnitName,
                                    java.util.Map<java.lang.String,java.lang.Object> properties,
                                    java.util.List<ClassDescriptor> descriptors,
                                    JpaEntityManagerFactory owner)
```
    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
  - getDatabaseSession
```
public DatabaseSessionImpl getDatabaseSession()
```
    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:
    
    getDatabaseSession in interface JpaEntityManagerFactory
  - getAbstractSession
```
public AbstractSession getAbstractSession()
```
    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
  - getSetupImpl
```
public EntityManagerSetupImpl getSetupImpl()
```
    INTERNAL: Return the EntityManagerSetupImpl associated with this factory
    
    Returns:
  - 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 TODO: should throw IllegalStateException if not ServerSession
    
    Specified by:
    
    getServerSession in interface JpaEntityManagerFactory
  - 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
  - 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,
                                         java.util.Map map)
```
  - createEntityManager
```
public EntityManager createEntityManager(SynchronizationType synchronizationType)
```
  - 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()
```
  - finalize
```
protected void finalize()
                 throws java.lang.Throwable
```
    Overrides:
    
    finalize in class java.lang.Object
    
    Throws:
    
    java.lang.Throwable
  - getProperty
```
public java.lang.Object getProperty(java.lang.String name)
```
    The method return user defined property passed in from EntityManagerFactory.
  - processProperties
```
protected void processProperties(java.util.Map properties)
```
    Process all EntityManager properties. This allows all EntityManager properties specified in the persistence.xml, factory properties, or System properties to be preprocessed. This save the cost of processing these properties each time an EntityManager is created, which can add considerable overhead to both performance and concurrency as System properties are a Hashtable and synchronized. ATTENTION: If you add a new property to be processed in this method please also add the property's name to PersistenceUnitProperties.supportedNonServerSessionProperties
  - refreshMetadata
```
public void refreshMetadata(java.util.Map 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. This call will throw an exception when called on EntityManagerFactoryImplDelegate
    
    Specified by:
    
    refreshMetadata in interface JpaEntityManagerFactory
    
    Parameters:
    
    properties -
  - 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()
  - 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()
  - getOwner
```
public JpaEntityManagerFactory getOwner()
```
    INTERNAL: Get the EntityManagerFactoryImpl that created this
    
    Returns:
  - 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,
                        java.lang.String attributeName)
```
    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 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.IllegalArgumentException - 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 potential database deadlocks.
  - setCommitOrder
```
public void setCommitOrder(CommitOrderType commitOrder)
```
    Set update ordering by primary key, to avoid potential 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)
```

Class EntityManagerFactoryDelegate

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

myCache

session

setupImpl

isOpen

properties

supportedNonServerSessionProperties

beginEarlyTransaction

flushMode

referenceMode

closeOnCommit

persistOnCommit

flushClearCache

shouldValidateExistence

commitOrder

commitWithoutPersistRules

owner

Constructor Detail

EntityManagerFactoryDelegate

EntityManagerFactoryDelegate

EntityManagerFactoryDelegate

Method Detail

getDatabaseSession

getAbstractSession

getSetupImpl

getServerSession

getSessionBroker

close

isOpen

createEntityManager

createEntityManager

createEntityManager

createEntityManager

createEntityManagerImpl

unwrap

verifyOpen

finalize

getProperty

processProperties

refreshMetadata

getBeginEarlyTransaction

setBeginEarlyTransaction

getFlushMode

setFlushMode

getReferenceMode

setReferenceMode

getCloseOnCommit

setCloseOnCommit

getPersistOnCommit

getPersistenceUnitUtil

setPersistOnCommit

getCommitWithoutPersistRules

setCommitWithoutPersistRules

getFlushClearCache

setFlushClearCache

shouldValidateExistence

setShouldValidateExistence

getCache

getProperties

getCriteriaBuilder

getMetamodel

getOwner

setMetamodel

isLoaded

isLoaded

getIdentifier

getCommitOrder

setCommitOrder

addNamedQuery

unwrap

addNamedEntityGraph