org.jipijapa.plugin.spi

Interface PersistenceProviderAdaptor

All Known Subinterfaces:

PersistenceProviderAdaptor

public interface PersistenceProviderAdaptor

PersistenceProvider adaptor

Author:

Scott Marlow

Method Summary

Modifier and Type	Method and Description
void	addProviderDependencies(PersistenceUnitMetadata pu) Persistence provider integration code might need dependencies that must be started for the deployment.
void	addProviderProperties(Map properties, PersistenceUnitMetadata pu) Adds any provider specific properties (e.g.
void	afterCreateContainerEntityManagerFactory(PersistenceUnitMetadata pu) Called right after persistence provider is invoked to create container entity manager factory.
Object	beanManagerLifeCycle(javax.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.
void	beforeCreateContainerEntityManagerFactory(PersistenceUnitMetadata pu) Called right before persistence provider is invoked to create container entity manager factory.
void	cleanup(PersistenceUnitMetadata pu) Called when we are done with the persistence unit metadata
boolean	doesScopedPersistenceUnitNameIdentifyCacheRegionName(PersistenceUnitMetadata pu) for adapters that support getManagementAdaptor(), does the scoped persistence unit name correctly identify cache entities.
ManagementAdaptor	getManagementAdaptor() Get the management adaptor
void	injectJtaManager(JtaManager jtaManager) pass the JtaManager in for internal use by PersistenceProviderAdaptor implementer
void	injectPlatform(Platform platform) pass the platform in use
void	markPersistenceUnitAvailable(Object wrapperBeanManagerLifeCycle)

Method Detail

injectJtaManager

void injectJtaManager(JtaManager jtaManager)

pass the JtaManager in for internal use by PersistenceProviderAdaptor implementer

Parameters:

jtaManager -

injectPlatform

void injectPlatform(Platform platform)

pass the platform in use

Parameters:

platform -

addProviderProperties

void addProviderProperties(Map properties,
                           PersistenceUnitMetadata pu)

Adds any provider specific properties (e.g. hibernate.transaction.manager_lookup_class)

Parameters:

properties -

pu -

addProviderDependencies

void addProviderDependencies(PersistenceUnitMetadata pu)

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

void beforeCreateContainerEntityManagerFactory(PersistenceUnitMetadata pu)

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

void afterCreateContainerEntityManagerFactory(PersistenceUnitMetadata pu)

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

boolean doesScopedPersistenceUnitNameIdentifyCacheRegionName(PersistenceUnitMetadata pu)

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

void cleanup(PersistenceUnitMetadata pu)

Called when we are done with the persistence unit metadata

beanManagerLifeCycle

Object beanManagerLifeCycle(javax.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. for handling self referencing cycles).

persistence provider BeanManager extension.

Parameters:

beanManager -

Returns:

wrapper object representing BeanManager lifecycle

markPersistenceUnitAvailable

void markPersistenceUnitAvailable(Object wrapperBeanManagerLifeCycle)