org.apache.openjpa.persistence
Class PersistenceProductDerivation

java.lang.Object
  org.apache.openjpa.lib.conf.AbstractProductDerivation
      org.apache.openjpa.persistence.PersistenceProductDerivation

All Implemented Interfaces:

OpenJPAProductDerivation, ProductDerivation

public class PersistenceProductDerivation
extends AbstractProductDerivation
implements OpenJPAProductDerivation

Sets JPA specification defaults and parses JPA specification XML files. For globals, looks in openjpa.properties system property for the location of a file to parse. If no system property is defined, the default resource location of META-INF/openjpa.xml is used. For defaults, looks for META-INF/persistence.xml. Within persistence.xml, look for the named persistence unit, or if no name given, an OpenJPA unit (preferring an unnamed OpenJPA unit to a named one).

Author:

Abe White

Nested Class Summary

static class	PersistenceProductDerivation.ConfigurationParser SAX handler capable of parsing an JPA persistence.xml file.
static class	PersistenceProductDerivation.ConfigurationProviderImpl Custom configuration provider.

Field Summary

protected String	_providerImplName
static Specification	ALIAS_EJB
static String	PREFIX
static String	RSRC_DEFAULT
static String	RSRC_GLOBAL
static Specification	SPEC_JPA
static BigDecimal	VERSION_1_0

Fields inherited from interface org.apache.openjpa.conf.OpenJPAProductDerivation

TYPE_PRODUCT_STORE, TYPE_SPEC, TYPE_SPEC_STORE, TYPE_STORE

Fields inherited from interface org.apache.openjpa.lib.conf.ProductDerivation

TYPE_FEATURE, TYPE_PRODUCT

Constructor Summary

PersistenceProductDerivation()

Method Summary

boolean	afterSpecificationSet(Configuration c)
boolean	beforeConfigurationLoad(Configuration c)
boolean	checkPuNameCollisions(Log logger, String puName) This method checks to see if the provided puName was detected in multiple resources.
List	getAnchorsInFile(File file)
List	getAnchorsInResource(String resource)
String	getConfigurationPrefix()
String	getDefaultResourceLocation()
Set<String>	getSupportedQueryHints()
int	getType()
ConfigurationProvider	load(File file, String anchor)
ConfigurationProvider	load(javax.persistence.spi.PersistenceUnitInfo pinfo, Map m) Load configuration from the given persistence unit with the specified user properties.
ConfigurationProvider	load(String rsrc, String anchor, ClassLoader loader)
ConfigurationProvider	load(String rsrc, String name, Map m) Load configuration from the given resource and unit names, which may be null.
ConfigurationProvider	loadDefaults(ClassLoader loader)
ConfigurationProvider	loadGlobals(ClassLoader loader)
void	putBrokerFactoryAliases(Map m)
void	validate()

Methods inherited from class org.apache.openjpa.lib.conf.AbstractProductDerivation

beforeConfigurationClose, beforeConfigurationConstruct

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.openjpa.lib.conf.ProductDerivation

beforeConfigurationClose, beforeConfigurationConstruct

Field Detail

SPEC_JPA

public static final Specification SPEC_JPA

ALIAS_EJB

public static final Specification ALIAS_EJB

RSRC_GLOBAL

public static final String RSRC_GLOBAL

See Also:

Constant Field Values

RSRC_DEFAULT

public static final String RSRC_DEFAULT

See Also:

Constant Field Values

VERSION_1_0

public static final BigDecimal VERSION_1_0

PREFIX

public static final String PREFIX

See Also:

Constant Field Values

_providerImplName

protected String _providerImplName

Constructor Detail

PersistenceProductDerivation

public PersistenceProductDerivation()

Method Detail

putBrokerFactoryAliases

public void putBrokerFactoryAliases(Map m)

Specified by:

putBrokerFactoryAliases in interface OpenJPAProductDerivation

getType

public int getType()

Specified by:

getType in interface ProductDerivation

getConfigurationPrefix

public String getConfigurationPrefix()

Specified by:

getConfigurationPrefix in interface ProductDerivation

Overrides:

getConfigurationPrefix in class AbstractProductDerivation

getSupportedQueryHints

public Set<String> getSupportedQueryHints()

Specified by:

getSupportedQueryHints in interface ProductDerivation

Overrides:

getSupportedQueryHints in class AbstractProductDerivation

validate

public void validate()
              throws Exception

Specified by:

validate in interface ProductDerivation

Overrides:

validate in class AbstractProductDerivation

Throws:

Exception

beforeConfigurationLoad

public boolean beforeConfigurationLoad(Configuration c)

Specified by:

beforeConfigurationLoad in interface ProductDerivation

Overrides:

beforeConfigurationLoad in class AbstractProductDerivation

afterSpecificationSet

public boolean afterSpecificationSet(Configuration c)

Specified by:

afterSpecificationSet in interface ProductDerivation

Overrides:

afterSpecificationSet in class AbstractProductDerivation

load

public ConfigurationProvider load(javax.persistence.spi.PersistenceUnitInfo pinfo,
                                  Map m)
                           throws IOException

Load configuration from the given persistence unit with the specified user properties.

Throws:

IOException

load

public ConfigurationProvider load(String rsrc,
                                  String name,
                                  Map m)
                           throws IOException

Load configuration from the given resource and unit names, which may be null.

Throws:

IOException

load

public ConfigurationProvider load(String rsrc,
                                  String anchor,
                                  ClassLoader loader)
                           throws IOException

Specified by:

load in interface ProductDerivation

Overrides:

load in class AbstractProductDerivation

Throws:

IOException

load

public ConfigurationProvider load(File file,
                                  String anchor)
                           throws IOException

Specified by:

load in interface ProductDerivation

Overrides:

load in class AbstractProductDerivation

Throws:

IOException

getDefaultResourceLocation

public String getDefaultResourceLocation()

Specified by:

getDefaultResourceLocation in interface ProductDerivation

Overrides:

getDefaultResourceLocation in class AbstractProductDerivation

getAnchorsInFile

public List getAnchorsInFile(File file)
                      throws IOException

Specified by:

getAnchorsInFile in interface ProductDerivation

Overrides:

getAnchorsInFile in class AbstractProductDerivation

Throws:

IOException

getAnchorsInResource

public List getAnchorsInResource(String resource)
                          throws Exception

Specified by:

getAnchorsInResource in interface ProductDerivation

Overrides:

getAnchorsInResource in class AbstractProductDerivation

Throws:

Exception

loadGlobals

public ConfigurationProvider loadGlobals(ClassLoader loader)
                                  throws IOException

Specified by:

loadGlobals in interface ProductDerivation

Overrides:

loadGlobals in class AbstractProductDerivation

Throws:

IOException

loadDefaults

public ConfigurationProvider loadDefaults(ClassLoader loader)
                                   throws IOException

Specified by:

loadDefaults in interface ProductDerivation

Overrides:

loadDefaults in class AbstractProductDerivation

Throws:

IOException

checkPuNameCollisions

public boolean checkPuNameCollisions(Log logger,
                                     String puName)

This method checks to see if the provided puName was detected in multiple resources. If a collision is detected, a warning will be logged and this method will return true.