PersistenceServiceImpl (BroadleafCommerce 5.2.10-SNAPSHOT API)

java.lang.Object
- org.broadleafcommerce.common.service.PersistenceServiceImpl

All Implemented Interfaces:

PersistenceService, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle
```
@Service(value="blPersistenceService")
public class PersistenceServiceImpl
extends Object
implements PersistenceService, org.springframework.context.SmartLifecycle
```
Service to help gather the correct EntityManager, PlatformTransactionManager, or EJB3ConfigurationDao based on a class and TargetModeType. This functionality is especially useful when multiple PersistenceUnits are in use. Note: All "default" items reference blPU, which is used to manage most Broadleaf entities in the Admin.

Author:

Chris Kittrell (ckittrell)

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,Map<String,Object>>`	`defaultTargetModeMap`
`protected static String`	`EJB3_CONFIG_DAO_KEY`
`protected static String`	`ENTITY_MANAGER_KEY`
`protected EntityConfiguration`	`entityConfiguration`
`protected List<javax.persistence.EntityManager>`	`entityManagers`
`protected static org.apache.commons.logging.Log`	`LOG`
`protected List<Map<String,Map<String,Object>>>`	`targetModeMaps`
`protected static String`	`TRANSACTION_MANAGER_KEY`
`protected StreamingTransactionCapableUtil`	`transUtil`

Constructor Summary

Constructors
Constructor and Description

PersistenceServiceImpl()

Constructors
Constructor and Description
`PersistenceServiceImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected String`	`buildEJB3ConfigDaoCacheKey(Class<?> clazz)`
`protected String`	`buildManagerCacheKey(String targetMode, Class<?> clazz)`
`protected String`	`buildManagerCacheKey(String targetMode, String className)`
`Class<?>`	`getCeilingImplClassFromEntityManagers(String className)` Retrieves the topmost implementation for the given className by checking each registered `EntityManager`.
`protected Class<?>`	`getClassForName(String className)`
`EJB3ConfigurationDao`	`getEJB3ConfigurationDao(Map<String,Object> managerMap)` Gathers the `EJB3ConfigurationDao` from the provided managerMap
`javax.persistence.EntityManager`	`getEntityManager(Map<String,Object> managerMap)` Gathers the `EntityManager` from the provided managerMap
`protected String`	`getManagedClassName(String className)`
`int`	`getPhase()`
`org.springframework.transaction.PlatformTransactionManager`	`getTransactionManager(Map<String,Object> managerMap)` Gathers the `PlatformTransactionManager` from the provided managerMap
`EJB3ConfigurationDao`	`identifyDefaultEJB3ConfigurationDao(TargetModeType targetModeType)` Identifies the default `EJB3ConfigurationDao` for the given targetModeType NOTE: This assumes that the `EJB3ConfigurationDao` is based on blPU
`javax.persistence.EntityManager`	`identifyDefaultEntityManager(TargetModeType targetModeType)` Identifies the default `EntityManager` for the given targetModeType NOTE: This assumes that the `EntityManager` is based on blPU
`org.springframework.transaction.PlatformTransactionManager`	`identifyDefaultTransactionManager(TargetModeType targetModeType)` Identifies the default `PlatformTransactionManager` for the given targetModeType NOTE: This assumes that the `PlatformTransactionManager` is based on blPU
`EJB3ConfigurationDao`	`identifyEJB3ConfigurationDao(Class entityClass)` Identifies the `EJB3ConfigurationDao` for the given entityClass
`javax.persistence.EntityManager`	`identifyEntityManager(Class entityClass)` Identifies the `EntityManager` for the given entityClass, using the default targetModeType of `TargetModeType.SANDBOX`
`javax.persistence.EntityManager`	`identifyEntityManager(Class entityClass, TargetModeType targetModeType)` Identifies the `EntityManager` for the given entityClass and targetModeType
`org.springframework.transaction.PlatformTransactionManager`	`identifyTransactionManager(String className, TargetModeType targetModeType)` Identifies the `PlatformTransactionManager` for the given className and targetModeType
`protected void`	`initializeEntityManagerCache()`
`boolean`	`isAutoStartup()`
`boolean`	`isRunning()`
`protected void`	`populateCaches(String targetMode, Map<String,Object> managerMap)`
`void`	`start()`
`void`	`stop()`
`void`	`stop(Runnable callback)`
`boolean`	`validateEntityClassName(String entityClassName)` Determine if a test class name represents a known entity class registered with Hibernate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOG
```
protected static final org.apache.commons.logging.Log LOG
```
  - ENTITY_MANAGER_KEY
```
protected static final String ENTITY_MANAGER_KEY
```
    See Also:
    
    Constant Field Values
  - TRANSACTION_MANAGER_KEY
```
protected static final String TRANSACTION_MANAGER_KEY
```
    See Also:
    
    Constant Field Values
  - EJB3_CONFIG_DAO_KEY
```
protected static final String EJB3_CONFIG_DAO_KEY
```
    See Also:
    
    Constant Field Values
  - entityConfiguration
```
protected EntityConfiguration entityConfiguration
```
  - targetModeMaps
```
protected List<Map<String,Map<String,Object>>> targetModeMaps
```
  - defaultTargetModeMap
```
protected Map<String,Map<String,Object>> defaultTargetModeMap
```
  - transUtil
```
protected StreamingTransactionCapableUtil transUtil
```
  - entityManagers
```
@Autowired
protected List<javax.persistence.EntityManager> entityManagers
```
- Constructor Detail
  - PersistenceServiceImpl
```
public PersistenceServiceImpl()
```
- Method Detail
  - isAutoStartup
```
public boolean isAutoStartup()
```
    Specified by:
    
    isAutoStartup in interface org.springframework.context.SmartLifecycle
  - stop
```
public void stop(Runnable callback)
```
    Specified by:
    
    stop in interface org.springframework.context.SmartLifecycle
  - start
```
public void start()
```
    Specified by:
    
    start in interface org.springframework.context.Lifecycle
  - stop
```
public void stop()
```
    Specified by:
    
    stop in interface org.springframework.context.Lifecycle
  - isRunning
```
public boolean isRunning()
```
    Specified by:
    
    isRunning in interface org.springframework.context.Lifecycle
  - getPhase
```
public int getPhase()
```
    Specified by:
    
    getPhase in interface org.springframework.context.Phased
  - initializeEntityManagerCache
```
protected void initializeEntityManagerCache()
```
  - populateCaches
```
protected void populateCaches(String targetMode,
                              Map<String,Object> managerMap)
```
  - validateEntityClassName
```
public boolean validateEntityClassName(String entityClassName)
```
    Description copied from interface: PersistenceService
    
    Determine if a test class name represents a known entity class registered with Hibernate
    
    Specified by:
    
    validateEntityClassName in interface PersistenceService
    
    Returns:
  - identifyEntityManager
```
public javax.persistence.EntityManager identifyEntityManager(Class entityClass)
```
    Description copied from interface: PersistenceService
    
    Identifies the EntityManager for the given entityClass, using the default targetModeType of TargetModeType.SANDBOX
    
    Specified by:
    
    identifyEntityManager in interface PersistenceService
    
    Returns:
    
    the EntityManager
  - identifyEntityManager
```
public javax.persistence.EntityManager identifyEntityManager(Class entityClass,
                                                             TargetModeType targetModeType)
```
    Description copied from interface: PersistenceService
    
    Identifies the EntityManager for the given entityClass and targetModeType
    
    Specified by:
    
    identifyEntityManager in interface PersistenceService
    
    Returns:
    
    the EntityManager
  - identifyTransactionManager
```
public org.springframework.transaction.PlatformTransactionManager identifyTransactionManager(String className,
                                                                                             TargetModeType targetModeType)
```
    Description copied from interface: PersistenceService
    
    Identifies the PlatformTransactionManager for the given className and targetModeType
    
    Specified by:
    
    identifyTransactionManager in interface PersistenceService
    
    Returns:
    
    the PlatformTransactionManager
  - identifyEJB3ConfigurationDao
```
public EJB3ConfigurationDao identifyEJB3ConfigurationDao(Class entityClass)
```
    Description copied from interface: PersistenceService
    
    Identifies the EJB3ConfigurationDao for the given entityClass
    
    Specified by:
    
    identifyEJB3ConfigurationDao in interface PersistenceService
    
    Returns:
    
    the EJB3ConfigurationDao
  - identifyDefaultEntityManager
```
public javax.persistence.EntityManager identifyDefaultEntityManager(TargetModeType targetModeType)
```
    Description copied from interface: PersistenceService
    
    Identifies the default EntityManager for the given targetModeType NOTE: This assumes that the EntityManager is based on blPU
    
    Specified by:
    
    identifyDefaultEntityManager in interface PersistenceService
    
    Returns:
    
    the EntityManager
  - getEntityManager
```
public javax.persistence.EntityManager getEntityManager(Map<String,Object> managerMap)
```
    Description copied from interface: PersistenceService
    
    Gathers the EntityManager from the provided managerMap
    
    Specified by:
    
    getEntityManager in interface PersistenceService
    
    Returns:
    
    the EntityManager
  - identifyDefaultTransactionManager
```
public org.springframework.transaction.PlatformTransactionManager identifyDefaultTransactionManager(TargetModeType targetModeType)
```
    Description copied from interface: PersistenceService
    
    Identifies the default PlatformTransactionManager for the given targetModeType NOTE: This assumes that the PlatformTransactionManager is based on blPU
    
    Specified by:
    
    identifyDefaultTransactionManager in interface PersistenceService
    
    Returns:
    
    the PlatformTransactionManager
  - getTransactionManager
```
public org.springframework.transaction.PlatformTransactionManager getTransactionManager(Map<String,Object> managerMap)
```
    Description copied from interface: PersistenceService
    
    Gathers the PlatformTransactionManager from the provided managerMap
    
    Specified by:
    
    getTransactionManager in interface PersistenceService
    
    Returns:
    
    the PlatformTransactionManager
  - identifyDefaultEJB3ConfigurationDao
```
public EJB3ConfigurationDao identifyDefaultEJB3ConfigurationDao(TargetModeType targetModeType)
```
    Description copied from interface: PersistenceService
    
    Identifies the default EJB3ConfigurationDao for the given targetModeType NOTE: This assumes that the EJB3ConfigurationDao is based on blPU
    
    Specified by:
    
    identifyDefaultEJB3ConfigurationDao in interface PersistenceService
    
    Returns:
    
    the EJB3ConfigurationDao
  - getEJB3ConfigurationDao
```
public EJB3ConfigurationDao getEJB3ConfigurationDao(Map<String,Object> managerMap)
```
    Description copied from interface: PersistenceService
    
    Gathers the EJB3ConfigurationDao from the provided managerMap
    
    Specified by:
    
    getEJB3ConfigurationDao in interface PersistenceService
    
    Returns:
    
    the EJB3ConfigurationDao
  - getCeilingImplClassFromEntityManagers
```
public Class<?> getCeilingImplClassFromEntityManagers(String className)
```
    Description copied from interface: PersistenceService
    
    Retrieves the topmost implementation for the given className by checking each registered EntityManager. If this is not found in the entity managers, this returns null
    
    Specified by:
    
    getCeilingImplClassFromEntityManagers in interface PersistenceService
  - buildManagerCacheKey
```
protected String buildManagerCacheKey(String targetMode,
                                      Class<?> clazz)
```
  - buildManagerCacheKey
```
protected String buildManagerCacheKey(String targetMode,
                                      String className)
```
  - buildEJB3ConfigDaoCacheKey
```
protected String buildEJB3ConfigDaoCacheKey(Class<?> clazz)
```
  - getManagedClassName
```
protected String getManagedClassName(String className)
```
  - getClassForName
```
protected Class<?> getClassForName(String className)
```

Class PersistenceServiceImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

ENTITY_MANAGER_KEY

TRANSACTION_MANAGER_KEY

EJB3_CONFIG_DAO_KEY

entityConfiguration

targetModeMaps

defaultTargetModeMap

transUtil

entityManagers

Constructor Detail

PersistenceServiceImpl

Method Detail

isAutoStartup

stop

start

stop

isRunning

getPhase

initializeEntityManagerCache

populateCaches

validateEntityClassName

identifyEntityManager

identifyEntityManager

identifyTransactionManager

identifyEJB3ConfigurationDao

identifyDefaultEntityManager

getEntityManager

identifyDefaultTransactionManager

getTransactionManager

identifyDefaultEJB3ConfigurationDao

getEJB3ConfigurationDao

getCeilingImplClassFromEntityManagers

buildManagerCacheKey

buildManagerCacheKey

buildEJB3ConfigDaoCacheKey

getManagedClassName

getClassForName