org.apache.aries.jpa.container
Interface ManagedPersistenceUnitInfoFactory

public interface ManagedPersistenceUnitInfoFactory

A Factory for ManagedPersistenceUnitInfo objects. This interface marks a plug-point for implementations that wish to extend the Aries JPA Container by providing customized PersistenceUnitInfo objects. Customized implementations can be provided in two ways:

• By setting a config property of the "container" bean in in the blueprint for this bundle.
• By adding a config property to a properties file added to this bundle using a fragment. The properties file should be named "org.apache.aries.jpa.container.properties" and be available at the root of the classpath. This properties file name is available as a constant ARIES_JPA_CONTAINER_PROPERTIES.

Note that properties provided through the properties file will override properties supplied through the blueprint container. The property key to use is "org.apache.aries.jpa.container.ManagedPersistenceUnitInfoFactory" and is accessible using the DEFAULT_PU_INFO_FACTORY_KEY field. The value associated with this key should be the class name of the ManagedPersistenceUnitInfoFactory implementation that should be used. The provided class name must be loadable by this bundle. Implementations of this interface must have a no-args constructor and be safe for use by multiple concurrent threads. No locks will be held by the JPA container or framework when calling methods on this interface.

Field Summary

static java.lang.String	ARIES_JPA_CONTAINER_PROPERTIES The name of the config properties file that can be used to configure the Aries JPA Container
static java.lang.String	DEFAULT_PU_INFO_FACTORY_KEY The config property key that should be used to provide a customized ManagedPersistenceUnitInfoFactory to the Aries JPA Container

Method Summary

java.util.Collection<? extends ManagedPersistenceUnitInfo>	createManagedPersistenceUnitMetadata(org.osgi.framework.BundleContext containerContext, org.osgi.framework.Bundle persistenceBundle, org.osgi.framework.ServiceReference providerReference, java.util.Collection<ParsedPersistenceUnit> persistenceMetadata) This method will be called by the Aries JPA container when persistence descriptors have been located in a persistence bundle.
void	destroyPersistenceBundle(org.osgi.framework.BundleContext containerContext, org.osgi.framework.Bundle persistenceBundle) This method will be called when the persistence bundle is no longer being managed.
java.lang.String	getDefaultProviderClassName() If no persistence units in a persistence bundle specify a JPA PersistenceProvider implementation class, then the JPA container will call this method to obtain a default provider to use.

Field Detail

DEFAULT_PU_INFO_FACTORY_KEY

static final java.lang.String DEFAULT_PU_INFO_FACTORY_KEY

The config property key that should be used to provide a customized ManagedPersistenceUnitInfoFactory to the Aries JPA Container

See Also:

Constant Field Values

ARIES_JPA_CONTAINER_PROPERTIES

static final java.lang.String ARIES_JPA_CONTAINER_PROPERTIES

The name of the config properties file that can be used to configure the Aries JPA Container

See Also:

Constant Field Values

Method Detail

createManagedPersistenceUnitMetadata

java.util.Collection<? extends ManagedPersistenceUnitInfo> createManagedPersistenceUnitMetadata(org.osgi.framework.BundleContext containerContext,
                                                                                                org.osgi.framework.Bundle persistenceBundle,
                                                                                                org.osgi.framework.ServiceReference providerReference,
                                                                                                java.util.Collection<ParsedPersistenceUnit> persistenceMetadata)

This method will be called by the Aries JPA container when persistence descriptors have been located in a persistence bundle.

Parameters:

containerContext - The BundleContext for the container bundle. This can be used to get services from the service registry when creating PersistenceUnitInfo objects.

persistenceBundle - The Bundle defining the persistence units. This bundle may be in any state, and so may not have a usable BundleContext or be able to load classes.

providerReference - A ServiceReference for the PersistenceProvider service that will be used to create EntityManagerFactory objects from these persistence units.

persistenceMetadata - A Collection of ParsedPersistenceUnit objects containing the metadata from the persistence descriptor.

Returns:

A Collection of ManagedPersistenceUnitInfo objects that can be used to create EntityManagerFactory instances

getDefaultProviderClassName

java.lang.String getDefaultProviderClassName()

If no persistence units in a persistence bundle specify a JPA PersistenceProvider implementation class, then the JPA container will call this method to obtain a default provider to use.

Returns:

A PersistenceProvider implementation class name, or null if no default is specified.

destroyPersistenceBundle

void destroyPersistenceBundle(org.osgi.framework.BundleContext containerContext,
                              org.osgi.framework.Bundle persistenceBundle)

This method will be called when the persistence bundle is no longer being managed. This may be because the bundle is being updated, or because the PersistenceProvider being used is no longer available. When this method is called implementations should clear up any resources associated with persistence units defined by the persistence bundle.

Parameters:

containerContext - The BundleContext for the container bundle.

persistenceBundle - The persistence bundle that is no longer valid.