Package net.officefloor.jpa

Class JpaManagedObjectSource

java.lang.Object

net.officefloor.frame.api.managedobject.source.impl.AbstractAsyncManagedObjectSource<O,F>

net.officefloor.frame.api.managedobject.source.impl.AbstractManagedObjectSource<Indexed,None>

net.officefloor.jpa.JpaManagedObjectSource

All Implemented Interfaces:

ManagedObjectSource<Indexed,None>

Direct Known Subclasses:

DataNucleusJpaManagedObjectSource, HibernateJpaManagedObjectSource

public class JpaManagedObjectSource
extends AbstractManagedObjectSource<Indexed,None>

JPA ManagedObjectSource.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	JpaManagedObjectSource.DependencyType	Dependency type.
static interface	JpaManagedObjectSource.EntityManagerWrapper	Wraps the EntityManager.
static interface	JpaManagedObjectSource.EntityManagerWrapperFactory	Factory creating the EntityManager wrapper.
class	JpaManagedObjectSource.JpaManagedObject	JPA ManagedObject.
static interface	JpaManagedObjectSource.PersistenceFactory	FunctionalInterface to create the EntityManagerFactory.

Nested classes/interfaces inherited from class net.officefloor.frame.api.managedobject.source.impl.AbstractAsyncManagedObjectSource

AbstractAsyncManagedObjectSource.DependencyLabeller<K extends Enum<K>>, AbstractAsyncManagedObjectSource.ExecutionLabeller, AbstractAsyncManagedObjectSource.Labeller<K extends Enum<K>>, AbstractAsyncManagedObjectSource.MetaDataContext<O extends Enum<O>,F extends Enum<F>>, AbstractAsyncManagedObjectSource.SpecificationContext

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_DEPENDENCY_TYPE	Property to specify the dependency type for the EntityManager.
static final String	PROPERTY_PERSISTENCE_FACTORY	Property to obtain the Class name for the JpaManagedObjectSource.PersistenceFactory.
static final String	PROPERTY_PERSISTENCE_UNIT	Property for the name of the persistence unit.

Constructor Summary

Constructors

Constructor	Description
JpaManagedObjectSource()

Method Summary

Modifier and Type	Method	Description
static void	beginTransaction(jakarta.persistence.EntityManager entityManager)	Begins the transaction on the EntityManager.
static void	commitTransaction(jakarta.persistence.EntityManager entityManager)	Commits the transaction on the EntityManager.
Connection	getConnection()	Obtains the Connection.
protected ManagedObject	getManagedObject()	Synchronously obtains the ManagedObject.
protected JpaManagedObjectSource.PersistenceFactory	getPersistenceFactory(SourceContext context)	Obtains the JpaManagedObjectSource.PersistenceFactory.
protected boolean	isRunWithinTransaction()	Indicates if required to run within EntityTransaction.
protected void	loadMetaData(AbstractAsyncManagedObjectSource.MetaDataContext<Indexed,None> context)	Overridden to load meta-data.
protected void	loadSpecification(AbstractAsyncManagedObjectSource.SpecificationContext context)	Overridden to load specifications.

Methods inherited from class net.officefloor.frame.api.managedobject.source.impl.AbstractManagedObjectSource

sourceManagedObject

Methods inherited from class net.officefloor.frame.api.managedobject.source.impl.AbstractAsyncManagedObjectSource

getSpecification, init, start, stop

Methods inherited from class java.lang.Object

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

Field Details

PROPERTY_DEPENDENCY_TYPE

public static final String PROPERTY_DEPENDENCY_TYPE

Property to specify the dependency type for the EntityManager.

See Also:

• Constant Field Values

PROPERTY_PERSISTENCE_UNIT

public static final String PROPERTY_PERSISTENCE_UNIT

Property for the name of the persistence unit.

See Also:

• Constant Field Values

PROPERTY_PERSISTENCE_FACTORY

public static final String PROPERTY_PERSISTENCE_FACTORY

Property to obtain the Class name for the JpaManagedObjectSource.PersistenceFactory.

See Also:

• Constant Field Values

Constructor Details

JpaManagedObjectSource

public JpaManagedObjectSource()

Method Details

beginTransaction

public static void beginTransaction(jakarta.persistence.EntityManager entityManager)

Begins the transaction on the EntityManager.

As OfficeFloor may manage the transaction for the EntityManager, it can not be begun. This enables beginning the transaction.

Parameters:

entityManager - EntityManager.

commitTransaction

public static void commitTransaction(jakarta.persistence.EntityManager entityManager)

Commits the transaction on the EntityManager.

As OfficeFloor may manage the transaction for the EntityManager, it can not be committed. This enables committing the transaction.

Parameters:

entityManager - EntityManager.

getConnection

public Connection getConnection()

Obtains the Connection.

Returns:

Connection.

getPersistenceFactory

protected JpaManagedObjectSource.PersistenceFactory getPersistenceFactory(SourceContext context)
                                                                   throws Exception

Obtains the JpaManagedObjectSource.PersistenceFactory.

Specific vendor implementations may override this method to specify the JpaManagedObjectSource.PersistenceFactory.

By default, this method uses the PROPERTY_PERSISTENCE_FACTORY Property to load the JpaManagedObjectSource.PersistenceFactory.

Parameters:

context - SourceContext.

Returns:

JpaManagedObjectSource.PersistenceFactory.

Throws:

Exception - If fails to create the JpaManagedObjectSource.PersistenceFactory.

isRunWithinTransaction

protected boolean isRunWithinTransaction()

Indicates if required to run within EntityTransaction.

Returns:

true if required to run within EntityTransaction.

loadSpecification

protected void loadSpecification(AbstractAsyncManagedObjectSource.SpecificationContext context)

Description copied from class: AbstractAsyncManagedObjectSource

Overridden to load specifications.

Specified by:

loadSpecification in class AbstractAsyncManagedObjectSource<Indexed,None>

Parameters:

context - Specifications.

loadMetaData

protected void loadMetaData(AbstractAsyncManagedObjectSource.MetaDataContext<Indexed,None> context)
                     throws Exception

Description copied from class: AbstractAsyncManagedObjectSource

Overridden to load meta-data.

Specified by:

loadMetaData in class AbstractAsyncManagedObjectSource<Indexed,None>

Parameters:

context - Meta-data.

Throws:

Exception - If fails to load the meta-data.

getManagedObject

protected ManagedObject getManagedObject()
                                  throws Throwable

Description copied from class: AbstractManagedObjectSource

Synchronously obtains the ManagedObject.

Specified by:

getManagedObject in class AbstractManagedObjectSource<Indexed,None>

Returns:

ManagedObject.

Throws:

Throwable - If fails to obtain the ManagedObject.