act.db.jpa

Class JPAService

java.lang.Object

act.util.LogSupport

act.util.DestroyableBase

act.app.AppHolderBase<act.db.DbService>

act.db.DbService

act.db.sql.SqlDbService

act.db.jpa.JPAService

All Implemented Interfaces:

act.app.AppHolder<act.db.DbService>, act.Destroyable

public abstract class JPAService
extends act.db.sql.SqlDbService

Nested Class Summary

Nested classes/interfaces inherited from interface act.Destroyable

act.Destroyable.Util

Field Summary

Fields

Modifier and Type	Field and Description
protected act.db.meta.EntityMetaInfoRepo	entityMetaInfoRepo
protected ConcurrentMap<act.db.jpa.JPAService.SQLKey,SQL>	sqlCache

Fields inherited from class act.db.sql.SqlDbService

config, ds, DUMB_STATUS, VERSION

Fields inherited from class act.db.DbService

_logger, logger

Constructor Summary

Constructors

Constructor and Description
JPAService(String dbId, act.app.App app, Map<String,String> config)

Method Summary

Modifier and Type	Method and Description
protected Class<? extends JPADao>	baseDaoClass() Returns the base class of the Dao supported by the JPA service.
protected DataSource	createDataSource()
protected abstract javax.persistence.EntityManagerFactory	createEntityManagerFactory(javax.persistence.spi.PersistenceUnitInfo persistenceUnitInfo) Create an EntityManagerFactory using PersistenceUnitInfo.
protected void	dataSourceProvided(DataSource dataSource, act.db.sql.DataSourceConfig dataSourceConfig)
<DAO extends act.db.Dao> DAO	defaultDao(Class<?> modelType)
Class<? extends Annotation>	entityAnnotationType()
static JPAService	findByModelClass(Class<?> modelClass)
SQL	getSQL(SQL.Type type, Class entityClass, String expression, String... columns)
protected <DAO extends act.db.Dao> boolean	isValidDaoClass(Class<DAO> aClass)
protected javax.persistence.NamedQuery	namedQuery(String name)
protected <ID_TYPE,MODEL_TYPE> JPADao<ID_TYPE,MODEL_TYPE>	newDao(Class<ID_TYPE> idType, Class<MODEL_TYPE> modelType) Create an new Dao for given id type and model type.
<DAO extends act.db.Dao> DAO	newDaoInstance(Class<DAO> aClass)
protected abstract Class<? extends javax.persistence.spi.PersistenceProvider>	persistenceProviderClass() Returns the class of a PersistenceProvider implementation.
protected Properties	processProperties(Properties properties) Sub class shall fill in specific properties that are required to build the PersistenceUnitInfo.
protected void	registerNamedQuery(javax.persistence.NamedQuery nq)
protected boolean	supportDdl()

Methods inherited from class act.db.sql.SqlDbService

configured, dataSource, dataSourceConfig, dataSourceProvider, dataSourceStatus, executeDdl, fieldNameFromPropertyName, initAsynchronously, initialized, releaseResources, tableNameFromClassName, toString

Methods inherited from class act.db.DbService

entityClasses, findModelIdTypeByAnnotation, id

Methods inherited from class act.app.AppHolderBase

app, app, me

Methods inherited from class act.util.DestroyableBase

addSubResource, destroy, isDestroyed, reload, scope

Methods inherited from class act.util.LogSupport

debug, debug, error, error, fatal, fatal, info, info, isDebugEnabled, isTraceEnabled, trace, trace, warn, warn

Methods inherited from class java.lang.Object

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

Methods inherited from interface act.Destroyable

destroy, isDestroyed, scope

Field Detail

entityMetaInfoRepo

protected act.db.meta.EntityMetaInfoRepo entityMetaInfoRepo

sqlCache

protected ConcurrentMap<act.db.jpa.JPAService.SQLKey,SQL> sqlCache

Constructor Detail

JPAService

public JPAService(String dbId,
                  act.app.App app,
                  Map<String,String> config)

Method Detail

dataSourceProvided

protected void dataSourceProvided(DataSource dataSource,
                                  act.db.sql.DataSourceConfig dataSourceConfig)

Overrides:

dataSourceProvided in class act.db.sql.SqlDbService

createDataSource

protected DataSource createDataSource()

Specified by:

createDataSource in class act.db.sql.SqlDbService

supportDdl

protected boolean supportDdl()

Specified by:

supportDdl in class act.db.sql.SqlDbService

defaultDao

public <DAO extends act.db.Dao> DAO defaultDao(Class<?> modelType)

Specified by:

defaultDao in class act.db.DbService

newDaoInstance

public <DAO extends act.db.Dao> DAO newDaoInstance(Class<DAO> aClass)

Specified by:

newDaoInstance in class act.db.DbService

entityAnnotationType

public Class<? extends Annotation> entityAnnotationType()

Specified by:

entityAnnotationType in class act.db.DbService

getSQL

public SQL getSQL(SQL.Type type,
                  Class entityClass,
                  String expression,
                  String... columns)

newDao

protected <ID_TYPE,MODEL_TYPE> JPADao<ID_TYPE,MODEL_TYPE> newDao(Class<ID_TYPE> idType,
                                                                 Class<MODEL_TYPE> modelType)

Create an new Dao for given id type and model type.

Type Parameters:

ID_TYPE - the generic type of the ID class

MODEL_TYPE - the generic type of the model class

Parameters:

idType - the type of the ID field

modelType - the type of the model

Returns:

an new Dao instance

baseDaoClass

protected Class<? extends JPADao> baseDaoClass()

Returns the base class of the Dao supported by the JPA service.

Returns:

the Dao base class

persistenceProviderClass

protected abstract Class<? extends javax.persistence.spi.PersistenceProvider> persistenceProviderClass()

Returns the class of a PersistenceProvider implementation.

For example a HibernateService shall return HibernatePersistenceProvider.

Returns:

the persistence provider class

createEntityManagerFactory

protected abstract javax.persistence.EntityManagerFactory createEntityManagerFactory(javax.persistence.spi.PersistenceUnitInfo persistenceUnitInfo)

Create an EntityManagerFactory using PersistenceUnitInfo.

Parameters:

persistenceUnitInfo - the PersistenceUnitInfo

Returns:

an EntityManagerFactory instance.

isValidDaoClass

protected <DAO extends act.db.Dao> boolean isValidDaoClass(Class<DAO> aClass)

processProperties

protected Properties processProperties(Properties properties)

Sub class shall fill in specific properties that are required to build the PersistenceUnitInfo.

For example, a hibernate service might have the following code:

properties.put("javax.persistence.provider", "org.hibernate.ejb.HibernatePersistence");
properties.put(org.hibernate.jpa.AvailableSettings.LOADED_CLASSES, managedClasses);
properties.put("hibernate.dialect", getDefaultDialect(dbConfig, dbConfig.get("db.driver")));
...
return properties;

Parameters:

properties - the properties contains common JPA configuration

Returns:

the properties with specific service configurations added in.

registerNamedQuery

protected void registerNamedQuery(javax.persistence.NamedQuery nq)

namedQuery

protected javax.persistence.NamedQuery namedQuery(String name)

findByModelClass

public static JPAService findByModelClass(Class<?> modelClass)