Package org.jipijapa.plugin.spi
Interface PersistenceProviderAdaptor
- All Known Subinterfaces:
PersistenceProviderAdaptor
public interface PersistenceProviderAdaptor
PersistenceProvider adaptor
- Author:
- Scott Marlow
-
Method Summary
Modifier and TypeMethodDescriptionvoidPersistence provider integration code might need dependencies that must be started for the deployment.voidaddProviderProperties(Map properties, PersistenceUnitMetadata pu) Adds any provider specific propertiesvoidCalled right after persistence provider is invoked to create container entity manager factory.beanManagerLifeCycle(jakarta.enterprise.inject.spi.BeanManager beanManager) Some persistence provider adapters may handle life cycle notification services for when the CDI bean manager can lookup the persistence unit that is using the CDI bean manager (e.g.voidCalled right before persistence provider is invoked to create container entity manager factory.voidCalled when we are done with the persistence unit metadatabooleanfor adapters that support getManagementAdaptor(), does the scoped persistence unit name correctly identify cache entities.Get the management adaptorvoidinjectJtaManager(JtaManager jtaManager) pass the JtaManager in for internal use by PersistenceProviderAdaptor implementervoidinjectPlatform(Platform platform) pass the platform in usevoidmarkPersistenceUnitAvailable(Object wrapperBeanManagerLifeCycle)
-
Method Details
-
injectJtaManager
pass the JtaManager in for internal use by PersistenceProviderAdaptor implementer- Parameters:
jtaManager-
-
injectPlatform
pass the platform in use- Parameters:
platform-
-
addProviderProperties
Adds any provider specific properties- Parameters:
properties-pu-
-
addProviderDependencies
Persistence provider integration code might need dependencies that must be started for the deployment. Note that these dependency classes are expected to be already available to the provider.- Parameters:
pu-
-
beforeCreateContainerEntityManagerFactory
Called right before persistence provider is invoked to create container entity manager factory. afterCreateContainerEntityManagerFactory() will always be called after the container entity manager factory is created.- Parameters:
pu-
-
afterCreateContainerEntityManagerFactory
Called right after persistence provider is invoked to create container entity manager factory. -
getManagementAdaptor
ManagementAdaptor getManagementAdaptor()Get the management adaptor- Returns:
- ManagementAdaptor or null
-
doesScopedPersistenceUnitNameIdentifyCacheRegionName
for adapters that support getManagementAdaptor(), does the scoped persistence unit name correctly identify cache entities. This is intended for Hibernate, other adapters can return true.- Returns:
- the Hibernate adapter will return false if the persistence unit has specified a custom "hibernate.cache.region_prefix" property. True otherwise.
-
cleanup
Called when we are done with the persistence unit metadata -
beanManagerLifeCycle
Some persistence provider adapters may handle life cycle notification services for when the CDI bean manager can lookup the persistence unit that is using the CDI bean manager (e.g. for handling self referencing cycles).persistence provider BeanManager extension.
- Parameters:
beanManager-- Returns:
- wrapper object representing BeanManager lifecycle
-
markPersistenceUnitAvailable
-