JDOPersistenceManagerFactory (DataNucleus JDO API plugin 4.0.0-m2 API)

java.lang.Object
- org.datanucleus.api.jdo.JDOPersistenceManagerFactory

All Implemented Interfaces:

Serializable, javax.jdo.PersistenceManagerFactory, Referenceable, ObjectFactory
```
public class JDOPersistenceManagerFactory
extends Object
implements javax.jdo.PersistenceManagerFactory, ObjectFactory, Referenceable, Serializable
```
Implementation of a JDO PersistenceManagerFactory, used to obtain PersistenceManager instances. The factory is configurable up to a point when it is frozen. Thereafter nothing can be changed.
Serialisation When a PMF is serialised its persistence properties are serialised with it, but dynamic state (fetch groups, listeners, L2 cache, etc) are not serialised with it.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<javax.jdo.listener.InstanceLifecycleListener,LifecycleListenerForClass>`	`lifecycleListeners` Lifecycle Listeners.
`protected static org.datanucleus.util.Localiser`	`LOCALISER` Localisation utility for output messages from jdo.
`protected org.datanucleus.PersistenceNucleusContext`	`nucleusContext` The context that this factory uses.

Constructor Summary

Constructors
Constructor and Description
`JDOPersistenceManagerFactory()` Constructs a new JDOPersistenceManagerFactory.
`JDOPersistenceManagerFactory(Map props)` Constructs a new JDOPersistenceManagerFactory for the specified persistence properties.
`JDOPersistenceManagerFactory(org.datanucleus.metadata.PersistenceUnitMetaData pumd, Map overrideProps)` Constructor for a PMF for the specified persistence-unit with optional overriding properties.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addFetchGroups(javax.jdo.FetchGroup... groups)`
`void`	`addInstanceLifecycleListener(javax.jdo.listener.InstanceLifecycleListener listener, Class[] classes)` Method to add lifecycle listeners for particular classes.
`void`	`addSequenceForFactoryClass(String factoryClassName, javax.jdo.datastore.Sequence sequence)` Method to register a sequence for a particular factory class.
`protected void`	`assertConfigurable()` Asserts that a change to a configuration property is allowed.
`protected void`	`assertIsOpen()` Asserts that the PMF is open.
`void`	`close()` Close this PersistenceManagerFactory.
`protected static JDOPersistenceManagerFactory`	`createPersistenceManagerFactory(Map props)` Convenience method to create the PMF, check whether we should hand out a singleton, and if all ok then freeze it for use.
`boolean`	`equals(Object obj)` Equality operator.
`protected void`	`finalize()`
`protected void`	`freezeConfiguration()` Freezes the current configuration.
`String`	`getCatalog()` Accessor for the catalog to use for this persistence factory.
`protected org.datanucleus.Configuration`	`getConfiguration()`
`String`	`getConnectionDriverName()` Get the driver name for the data store connection.
`Object`	`getConnectionFactory()` Get the data store connection factory.
`Object`	`getConnectionFactory2()` Get the second data store connection factory.
`String`	`getConnectionFactory2Name()` Get the name for the second data store connection factory.
`String`	`getConnectionFactoryName()` Get the name for the data store connection factory.
`String`	`getConnectionPassword()` Get the password for the data store connection.
`String`	`getConnectionURL()` Get the URL for the data store connection.
`String`	`getConnectionUserName()` Get the user name for the data store connection.
`boolean`	`getCopyOnAttach()` Accessor for the CopyOnAttach setting.
`javax.jdo.datastore.DataStoreCache`	`getDataStoreCache()` Accessor for the DataStore (level 2) Cache
`Integer`	`getDatastoreReadTimeoutMillis()` Accessor for the datastore read timeout interval.
`Integer`	`getDatastoreWriteTimeoutMillis()` Accessor for the datastore write timeout interval.
`boolean`	`getDetachAllOnCommit()` Accessor for the DetachAllOnCommit setting.
`javax.jdo.FetchGroup`	`getFetchGroup(Class cls, String name)`
`Set<javax.jdo.FetchGroup>`	`getFetchGroups()`
`boolean`	`getIgnoreCache()` Get the default IgnoreCache setting for all `PersistenceManager` instances obtained from this factory.
`List<LifecycleListenerForClass>`	`getLifecycleListenerSpecifications()` Deprecated.
`Collection<Class>`	`getManagedClasses()` Accessor for the classes that are managed (have metadata loaded).
`String`	`getMapping()` Get the name for any mapping, used in retrieving metadata files for ORM/Query data.
`javax.jdo.metadata.TypeMetadata`	`getMetadata(String className)` Method to return the (class) metadata object for the specified class, if there is metadata defined for that class.
`boolean`	`getMultithreaded()` Get the default Multithreaded setting for all `PersistenceManager` instances obtained from this factory.
`String`	`getName()` Accessor for the name of the persistence factory (if any).
`boolean`	`getNontransactionalRead()` Get the default NontransactionalRead setting for all `PersistenceManager` instances obtained from this factory.
`boolean`	`getNontransactionalWrite()` Get the default NontransactionalWrite setting for all `PersistenceManager` instances obtained from this factory.
`org.datanucleus.PersistenceNucleusContext`	`getNucleusContext()`
`Object`	`getObjectInstance(Object obj, Name name, Context ctx, Hashtable env)` Create a PMF using the (JNDI) location or reference information specified.
`boolean`	`getOptimistic()` Get the default Optimistic setting for all `PersistenceManager` instances obtained from this factory.
`javax.jdo.PersistenceManager`	`getPersistenceManager()` Get an instance of `PersistenceManager` from this factory.
`javax.jdo.PersistenceManager`	`getPersistenceManager(String userName, String password)` Get an instance of `PersistenceManager` from this factory.
`static javax.jdo.PersistenceManagerFactory`	`getPersistenceManagerFactory(Map overridingProps)` Return a new PersistenceManagerFactory with options set according to the given Properties.
`static javax.jdo.PersistenceManagerFactory`	`getPersistenceManagerFactory(Map overrides, Map props)` Return a new PersistenceManagerFactory with options set according to the given properties and given overrides.
`static javax.jdo.PersistenceManagerFactory`	`getPersistenceManagerFactory(Properties overridingProps)` Return a new PersistenceManagerFactory with options set according to the given Properties.
`javax.jdo.PersistenceManager`	`getPersistenceManagerProxy()` Accessor for the PersistenceManager proxy object
`Map<String,Object>`	`getPersistenceProperties()` Accessor for the persistence properties.
`String`	`getPersistenceUnitName()` Accessor for the name of the persistence unit
`String`	`getPersistenceXmlFilename()` Accessor for the filename of the persistence.xml file.
`ClassLoader`	`getPrimaryClassLoader()` Accessor for the primary class loader
`Properties`	`getProperties()` Return non-configurable properties of this PersistenceManagerFactory.
`JDOQueryCache`	`getQueryCache()` Accessor for the query results cache.
`org.datanucleus.store.query.cache.QueryDatastoreCompilationCache`	`getQueryDatastoreCompilationCache()` Accessor for the query datastore compilation cache.
`org.datanucleus.query.cache.QueryCompilationCache`	`getQueryGenericCompilationCache()` Accessor for the query generic compilation cache.
`boolean`	`getReadOnly()` Get the default readOnly setting for all `PersistenceManager` instances obtained from this factory.
`Reference`	`getReference()` Retrieves the (JNDI) reference of this PMF object.
`boolean`	`getRestoreValues()` Get the default RestoreValues setting for all `PersistenceManager` instances obtained from this factory.
`boolean`	`getRetainValues()` Get the default RetainValues setting for all `PersistenceManager` instances obtained from this factory.
`String`	`getSchema()` Accessor for the schema to use for this persistence factory.
`javax.jdo.datastore.Sequence`	`getSequenceForFactoryClass(String factoryClassName)` Accessor for the sequence for a factory class.
`String`	`getServerTimeZoneID()` Accessor for the timezone "id" of the datastore server (if any).
`String`	`getTransactionIsolationLevel()` Accessor for the transaction isolation level default.
`String`	`getTransactionType()` Accessor for the transaction type to use with this persistence factory.
`protected void`	`initialiseMetaData(org.datanucleus.metadata.PersistenceUnitMetaData pumd)`
`boolean`	`isClosed()` Utility to return whether the factory is closed or not.
`protected boolean`	`isConfigurable()` Accessor for whether this is still configurable (can set more properties etc).
`javax.jdo.metadata.JDOMetadata`	`newMetadata()` Method to return a new metadata object that can be subsequently modified and registered with the persistence process using the method `registerMetadata(javax.jdo.metadata.JDOMetadata)`.
`protected JDOPersistenceManager`	`newPM(JDOPersistenceManagerFactory jdoPmf, String userName, String password)`
`protected void`	`processLifecycleListenersFromProperties(Map props)` Convenience method to extract lifecycle listeners that are specified by way of persistence properties.
`void`	`registerMetadata(javax.jdo.metadata.JDOMetadata metadata)` Method to register the supplied metadata with the persistence process managed by this `PersistenceManagerFactory`.
`void`	`releasePersistenceManager(JDOPersistenceManager pm)` Remove a PersistenceManager from the cache Only the PersistenceManager is allowed to call this method
`void`	`removeAllFetchGroups()`
`void`	`removeFetchGroups(javax.jdo.FetchGroup... groups)`
`void`	`removeInstanceLifecycleListener(javax.jdo.listener.InstanceLifecycleListener listener)` Method to remove a lifecycle listener.
`void`	`setCatalog(String catalog)` Mutator for the catalog to use for this persistence factory.
`void`	`setConnectionDriverName(String driverName)` Set the driver name for the data store connection.
`void`	`setConnectionFactory(Object connectionFactory)` Set the data store connection factory.
`void`	`setConnectionFactory2(Object connectionFactory)` Set the second data store connection factory.
`void`	`setConnectionFactory2Name(String connectionFactoryName)` Set the name for the second data store connection factory.
`void`	`setConnectionFactoryName(String connectionFactoryName)` Set the name for the data store connection factory.
`void`	`setConnectionPassword(String password)` Set the password for the data store connection.
`void`	`setConnectionURL(String url)` Set the URL for the data store connection.
`void`	`setConnectionUserName(String userName)` Set the user name for the data store connection.
`void`	`setCopyOnAttach(boolean flag)` Mutator for the CopyOnAttach setting.
`void`	`setDatastoreReadTimeoutMillis(Integer timeout)` Mutator for the timeout to use for datastore reads.
`void`	`setDatastoreWriteTimeoutMillis(Integer timeout)` Mutator for the timeout to use for datastore writes.
`void`	`setDetachAllOnCommit(boolean flag)` Mutator for the DetachAllOnCommit setting.
`void`	`setIgnoreCache(boolean flag)` Set the default IgnoreCache setting for all `PersistenceManager` instances obtained from this factory.
`protected void`	`setIsNotConfigurable()` Method to set that this is no longer configurable.
`void`	`setMapping(String mapping)` Set the name for any mapping, used in searching for ORM/Query metadata files.
`void`	`setMultithreaded(boolean flag)` Set the default Multithreaded setting for all `PersistenceManager` instances obtained from this factory.
`void`	`setName(String name)` Mutator for the name of the persistence factory.
`void`	`setNontransactionalRead(boolean flag)` Set the default NontransactionalRead setting for all `PersistenceManager` instances obtained from this factory.
`void`	`setNontransactionalWrite(boolean flag)` Set the default NontransactionalWrite setting for all `PersistenceManager` instances obtained from this factory.
`void`	`setOptimistic(boolean flag)` Set the default Optimistic setting for all `PersistenceManager` instances obtained from this factory.
`void`	`setPersistenceProperties(Map<String,Object> props)` Set the properties for this configuration.
`void`	`setPersistenceUnitName(String name)` Mutator for the name of the persistence unit.
`void`	`setPersistenceXmlFilename(String name)` Mutator for the filename of the persistence.xml file.
`void`	`setPrimaryClassLoader(ClassLoader loader)` Mutator to set the primary class loader.
`void`	`setReadOnly(boolean flag)` Set the readOnly setting for all `PersistenceManager` instances obtained from this factory.
`void`	`setRestoreValues(boolean flag)` Set the default RestoreValues setting for all `PersistenceManager` instances obtained from this factory.
`void`	`setRetainValues(boolean flag)` Set the default RetainValues setting for all `PersistenceManager` instances obtained from this factory.
`void`	`setSchema(String schema)` Mutator for the schema to use for this persistence factory.
`void`	`setServerTimeZoneID(String id)` Mutator for the timezone id of the datastore server.
`void`	`setTransactionIsolationLevel(String level)` Set the default isolation level for transactions.
`void`	`setTransactionType(String type)` Mutator for the transaction type to use for this persistence factory.
`Collection<String>`	`supportedOptions()` The application can determine from the results of this method which optional features, and which query languages are supported by the JDO implementation.
`void`	`unmanageClass(String className)` Method to remove the specified class from the classes that are being managed.

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

- Field Detail
  - LOCALISER
```
protected static final org.datanucleus.util.Localiser LOCALISER
```
    Localisation utility for output messages from jdo.
  - nucleusContext
```
protected transient org.datanucleus.PersistenceNucleusContext nucleusContext
```
    The context that this factory uses. TODO Ought to be serializable, or able to recreate.
  - lifecycleListeners
```
protected transient Map<javax.jdo.listener.InstanceLifecycleListener,LifecycleListenerForClass> lifecycleListeners
```
    Lifecycle Listeners.
- Constructor Detail
  - JDOPersistenceManagerFactory
```
public JDOPersistenceManagerFactory()
```
    Constructs a new JDOPersistenceManagerFactory.
  - JDOPersistenceManagerFactory
```
public JDOPersistenceManagerFactory(org.datanucleus.metadata.PersistenceUnitMetaData pumd,
                            Map overrideProps)
```
    Constructor for a PMF for the specified persistence-unit with optional overriding properties.
    
    Parameters:
    pumd - The persistence unit
    overrideProps - Properties overriding/supplementing those in the persistence-unit
  - JDOPersistenceManagerFactory
```
public JDOPersistenceManagerFactory(Map props)
```
    Constructs a new JDOPersistenceManagerFactory for the specified persistence properties.
    
    Parameters:
    props - Persistence properties
- Method Detail
  - getPersistenceManagerFactory
```
public static javax.jdo.PersistenceManagerFactory getPersistenceManagerFactory(Properties overridingProps)
```
    Return a new PersistenceManagerFactory with options set according to the given Properties. This method exists for JDO1 compliance whereas in JDO2 the method takes a Map.
    
    Parameters:
    overridingProps - The Properties to initialize the PersistenceManagerFactory with.
    
    Returns:
    A PersistenceManagerFactory with options set according to the given Properties.
    See Also:
    JDOHelper.getPersistenceManagerFactory(java.util.Map)
  - getPersistenceManagerFactory
```
public static javax.jdo.PersistenceManagerFactory getPersistenceManagerFactory(Map overridingProps)
```
    Return a new PersistenceManagerFactory with options set according to the given Properties.
    
    Parameters:
    overridingProps - The Map of properties to initialize the PersistenceManagerFactory with.
    
    Returns:
    A PersistenceManagerFactory with options set according to the given Properties.
    See Also:
    JDOHelper.getPersistenceManagerFactory(java.util.Map)
  - getPersistenceManagerFactory
```
public static javax.jdo.PersistenceManagerFactory getPersistenceManagerFactory(Map overrides,
                                                               Map props)
```
    Return a new PersistenceManagerFactory with options set according to the given properties and given overrides.
    
    Parameters:
    overrides - Map of properties to override the supplied props (if any)
    props - Map of properties to initialise the PMF with
    
    Returns:
    A PersistenceManagerFactory with options set according to the given Properties
  - createPersistenceManagerFactory
```
protected static JDOPersistenceManagerFactory createPersistenceManagerFactory(Map props)
```
    Convenience method to create the PMF, check whether we should hand out a singleton, and if all ok then freeze it for use.
    
    Parameters:
    props - The properties
    
    Returns:
    The PMF to use
  - close
```
public void close()
```
    Close this PersistenceManagerFactory. Check for JDOPermission("closePersistenceManagerFactory") and if not authorized, throw SecurityException.
    If the authorization check succeeds, check to see that all PersistenceManager instances obtained from this PersistenceManagerFactory have no active transactions. If any PersistenceManager instances have an active transaction, throw a JDOUserException, with one nested JDOUserException for each PersistenceManager with an active Transaction.
    If there are no active transactions, then close all PersistenceManager instances obtained from this PersistenceManagerFactory, mark this PersistenceManagerFactory as closed, disallow getPersistenceManager methods, and allow all other get methods. If a set method or getPersistenceManager method is called after close, then JDOUserException is thrown.
    
    Specified by:
    
    close in interface javax.jdo.PersistenceManagerFactory
    
    See Also:
    PersistenceManagerFactory.close()
  - isClosed
```
public boolean isClosed()
```
    Utility to return whether the factory is closed or not.
    
    Specified by:
    
    isClosed in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    Whether it is closed.
  - processLifecycleListenersFromProperties
```
protected void processLifecycleListenersFromProperties(Map props)
```
    Convenience method to extract lifecycle listeners that are specified by way of persistence properties.
    
    Parameters:
    props - Persistence props.
  - initialiseMetaData
```
protected void initialiseMetaData(org.datanucleus.metadata.PersistenceUnitMetaData pumd)
```
  - freezeConfiguration
```
protected void freezeConfiguration()
```
    Freezes the current configuration.
    
    Throws:
    
    javax.jdo.JDOException - if the configuration was invalid or inconsistent in some way
  - getPersistenceManager
```
public javax.jdo.PersistenceManager getPersistenceManager()
```
    Get an instance of PersistenceManager from this factory. The instance has default values for options.
    After the first use of getPersistenceManager, no "set" methods will succeed.
    
    Specified by:
    
    getPersistenceManager in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    a PersistenceManager instance with default options.
  - getPersistenceManager
```
public javax.jdo.PersistenceManager getPersistenceManager(String userName,
                                                 String password)
```
    Get an instance of PersistenceManager from this factory. The instance has default values for options. The parameters user-id/password are used when obtaining datastore connections from the connection pool.
    After the first use of getPersistenceManager, no "set" methods will succeed.
    
    Specified by:
    
    getPersistenceManager in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    userName - the user name for the connection
    password - the password for the connection
    
    Returns:
    PersistenceManager instance with default options.
  - newPM
```
protected JDOPersistenceManager newPM(JDOPersistenceManagerFactory jdoPmf,
                          String userName,
                          String password)
```
  - getNucleusContext
```
public org.datanucleus.PersistenceNucleusContext getNucleusContext()
```
  - getConfiguration
```
protected org.datanucleus.Configuration getConfiguration()
```
  - equals
```
public boolean equals(Object obj)
```
    Equality operator.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    obj - Object to compare against
    
    Returns:
    Whether the objects are the same.
  - getObjectInstance
```
public Object getObjectInstance(Object obj,
                       Name name,
                       Context ctx,
                       Hashtable env)
                         throws Exception
```
    Create a PMF using the (JNDI) location or reference information specified.
    
    Specified by:
    
    getObjectInstance in interface ObjectFactory
    
    Parameters:
    obj - The object
    name - Name of the object relative to the context
    ctx - The context
    env - properties used for creating the object
    
    Returns:
    The PMF instance
    
    Throws:
    
    Exception - If an error occurs generating the referenced object
  - getReference
```
public Reference getReference()
```
    Retrieves the (JNDI) reference of this PMF object.
    
    Specified by:
    
    getReference in interface Referenceable
    
    Returns:
    The reference
  - getPersistenceManagerProxy
```
public javax.jdo.PersistenceManager getPersistenceManagerProxy()
```
    Accessor for the PersistenceManager proxy object
    
    Specified by:
    
    getPersistenceManagerProxy in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    The PMF proxy
  - getProperties
```
public Properties getProperties()
```
    Return non-configurable properties of this PersistenceManagerFactory. Properties with keys VendorName and VersionNumber are required. Other keys are optional.
    
    Specified by:
    
    getProperties in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    the non-configurable properties of this PersistenceManagerFactory.
  - supportedOptions
```
public Collection<String> supportedOptions()
```
    The application can determine from the results of this method which optional features, and which query languages are supported by the JDO implementation. See section 11.6 of the JDO 2 specification.
    
    Specified by:
    
    supportedOptions in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    A Collection of String representing the supported options.
  - releasePersistenceManager
```
public void releasePersistenceManager(JDOPersistenceManager pm)
```
    Remove a PersistenceManager from the cache Only the PersistenceManager is allowed to call this method
    
    Parameters:
    pm - the PersistenceManager to be removed from cache
  - assertIsOpen
```
protected void assertIsOpen()
```
    Asserts that the PMF is open.
    
    Throws:
    
    javax.jdo.JDOUserException - if it is already closed
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - getDataStoreCache
```
public javax.jdo.datastore.DataStoreCache getDataStoreCache()
```
    Accessor for the DataStore (level 2) Cache
    
    Specified by:
    
    getDataStoreCache in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    The datastore cache
  - getQueryCache
```
public JDOQueryCache getQueryCache()
```
    Accessor for the query results cache.
    
    Returns:
    Query results cache
  - getQueryGenericCompilationCache
```
public org.datanucleus.query.cache.QueryCompilationCache getQueryGenericCompilationCache()
```
    Accessor for the query generic compilation cache.
    
    Returns:
    Query generic compilation cache
  - getQueryDatastoreCompilationCache
```
public org.datanucleus.store.query.cache.QueryDatastoreCompilationCache getQueryDatastoreCompilationCache()
```
    Accessor for the query datastore compilation cache.
    
    Returns:
    Query datastore compilation cache
  - setConnectionUserName
```
public void setConnectionUserName(String userName)
```
    Set the user name for the data store connection.
    
    Specified by:
    
    setConnectionUserName in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    userName - the user name for the data store connection.
  - setConnectionPassword
```
public void setConnectionPassword(String password)
```
    Set the password for the data store connection.
    
    Specified by:
    
    setConnectionPassword in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    password - the password for the data store connection.
  - setConnectionURL
```
public void setConnectionURL(String url)
```
    Set the URL for the data store connection.
    
    Specified by:
    
    setConnectionURL in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    url - the URL for the data store connection.
  - setConnectionDriverName
```
public void setConnectionDriverName(String driverName)
```
    Set the driver name for the data store connection.
    
    Specified by:
    
    setConnectionDriverName in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    driverName - the driver name for the data store connection.
  - setConnectionFactoryName
```
public void setConnectionFactoryName(String connectionFactoryName)
```
    Set the name for the data store connection factory.
    
    Specified by:
    
    setConnectionFactoryName in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    connectionFactoryName - name of the data store connection factory.
  - setConnectionFactory
```
public void setConnectionFactory(Object connectionFactory)
```
    Set the data store connection factory. JDO implementations will support specific connection factories. The connection factory interfaces are not part of the JDO specification.
    
    Specified by:
    
    setConnectionFactory in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    connectionFactory - the data store connection factory.
  - setConnectionFactory2Name
```
public void setConnectionFactory2Name(String connectionFactoryName)
```
    Set the name for the second data store connection factory. This is needed for managed environments to get nontransactional connections for optimistic transactions.
    
    Specified by:
    
    setConnectionFactory2Name in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    connectionFactoryName - name of the data store connection factory.
  - setConnectionFactory2
```
public void setConnectionFactory2(Object connectionFactory)
```
    Set the second data store connection factory. This is needed for managed environments to get nontransactional connections for optimistic transactions. JDO implementations will support specific connection factories. The connection factory interfaces are not part of the JDO specification.
    
    Specified by:
    
    setConnectionFactory2 in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    connectionFactory - the data store connection factory.
  - setMultithreaded
```
public void setMultithreaded(boolean flag)
```
    Set the default Multithreaded setting for all PersistenceManager instances obtained from this factory.
    
    Specified by:
    
    setMultithreaded in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    flag - the default Multithreaded setting.
  - setOptimistic
```
public void setOptimistic(boolean flag)
```
    Set the default Optimistic setting for all PersistenceManager instances obtained from this factory.
    
    Specified by:
    
    setOptimistic in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    flag - the default Optimistic setting.
  - setRetainValues
```
public void setRetainValues(boolean flag)
```
    Set the default RetainValues setting for all PersistenceManager instances obtained from this factory.
    
    Specified by:
    
    setRetainValues in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    flag - the default RetainValues setting.
  - setRestoreValues
```
public void setRestoreValues(boolean flag)
```
    Set the default RestoreValues setting for all PersistenceManager instances obtained from this factory.
    
    Specified by:
    
    setRestoreValues in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    flag - the default RestoreValues setting.
  - setNontransactionalRead
```
public void setNontransactionalRead(boolean flag)
```
    Set the default NontransactionalRead setting for all PersistenceManager instances obtained from this factory.
    
    Specified by:
    
    setNontransactionalRead in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    flag - the default NontransactionalRead setting.
  - setNontransactionalWrite
```
public void setNontransactionalWrite(boolean flag)
```
    Set the default NontransactionalWrite setting for all PersistenceManager instances obtained from this factory.
    
    Specified by:
    
    setNontransactionalWrite in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    flag - the default NontransactionalWrite setting.
  - setIgnoreCache
```
public void setIgnoreCache(boolean flag)
```
    Set the default IgnoreCache setting for all PersistenceManager instances obtained from this factory.
    
    Specified by:
    
    setIgnoreCache in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    flag - the default IgnoreCache setting.
  - setDetachAllOnCommit
```
public void setDetachAllOnCommit(boolean flag)
```
    Mutator for the DetachAllOnCommit setting.
    
    Specified by:
    
    setDetachAllOnCommit in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    flag - the default DetachAllOnCommit setting.
  - setCopyOnAttach
```
public void setCopyOnAttach(boolean flag)
```
    Mutator for the CopyOnAttach setting.
    
    Specified by:
    
    setCopyOnAttach in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    flag - the default CopyOnAttach setting.
  - setMapping
```
public void setMapping(String mapping)
```
    Set the name for any mapping, used in searching for ORM/Query metadata files.
    
    Specified by:
    
    setMapping in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    mapping - the mapping name
  - setCatalog
```
public void setCatalog(String catalog)
```
    Mutator for the catalog to use for this persistence factory.
    
    Parameters:
    catalog - Name of the catalog
  - setSchema
```
public void setSchema(String schema)
```
    Mutator for the schema to use for this persistence factory.
    
    Parameters:
    schema - Name of the schema
  - setDatastoreReadTimeoutMillis
```
public void setDatastoreReadTimeoutMillis(Integer timeout)
```
    Mutator for the timeout to use for datastore reads.
    
    Specified by:
    
    setDatastoreReadTimeoutMillis in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    timeout - Datastore read interval (millisecs)
  - setDatastoreWriteTimeoutMillis
```
public void setDatastoreWriteTimeoutMillis(Integer timeout)
```
    Mutator for the timeout to use for datastore writes.
    
    Specified by:
    
    setDatastoreWriteTimeoutMillis in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    timeout - Datastore write interval (millisecs)
  - setTransactionType
```
public void setTransactionType(String type)
```
    Mutator for the transaction type to use for this persistence factory.
    
    Specified by:
    
    setTransactionType in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    type - Transaction type
  - setPersistenceUnitName
```
public void setPersistenceUnitName(String name)
```
    Mutator for the name of the persistence unit.
    
    Specified by:
    
    setPersistenceUnitName in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    name - Name of the persistence unit
  - setPersistenceXmlFilename
```
public void setPersistenceXmlFilename(String name)
```
    Mutator for the filename of the persistence.xml file. This is for the case where an application has placed the persistence.xml somewhere else maybe outside the CLASSPATH.
    
    Parameters:
    name - Filename of the persistence unit
  - setName
```
public void setName(String name)
```
    Mutator for the name of the persistence factory.
    
    Specified by:
    
    setName in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    name - Name of the persistence factory (if any)
  - setServerTimeZoneID
```
public void setServerTimeZoneID(String id)
```
    Mutator for the timezone id of the datastore server. If not set assumes that it is running in the same timezone as this JVM.
    
    Specified by:
    
    setServerTimeZoneID in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    id - Timezone Id to use
  - setReadOnly
```
public void setReadOnly(boolean flag)
```
    Set the readOnly setting for all PersistenceManager instances obtained from this factory.
    
    Specified by:
    
    setReadOnly in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    flag - the default readOnly setting.
  - setTransactionIsolationLevel
```
public void setTransactionIsolationLevel(String level)
```
    Set the default isolation level for transactions.
    
    Specified by:
    
    setTransactionIsolationLevel in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    level - Level
  - getConnectionUserName
```
public String getConnectionUserName()
```
    Get the user name for the data store connection.
    
    Specified by:
    
    getConnectionUserName in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    the user name for the data store connection.
  - getConnectionPassword
```
public String getConnectionPassword()
```
    Get the password for the data store connection.
    
    Returns:
    the password for the data store connection.
  - getConnectionURL
```
public String getConnectionURL()
```
    Get the URL for the data store connection.
    
    Specified by:
    
    getConnectionURL in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    the URL for the data store connection.
  - getConnectionDriverName
```
public String getConnectionDriverName()
```
    Get the driver name for the data store connection.
    
    Specified by:
    
    getConnectionDriverName in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    the driver name for the data store connection.
  - getConnectionFactoryName
```
public String getConnectionFactoryName()
```
    Get the name for the data store connection factory.
    
    Specified by:
    
    getConnectionFactoryName in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    the name of the data store connection factory.
  - getConnectionFactory2Name
```
public String getConnectionFactory2Name()
```
    Get the name for the second data store connection factory. This is needed for managed environments to get nontransactional connections for optimistic transactions.
    
    Specified by:
    
    getConnectionFactory2Name in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    the name of the data store connection factory.
  - getConnectionFactory
```
public Object getConnectionFactory()
```
    Get the data store connection factory.
    
    Specified by:
    
    getConnectionFactory in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    the data store connection factory.
  - getConnectionFactory2
```
public Object getConnectionFactory2()
```
    Get the second data store connection factory. This is needed for managed environments to get nontransactional connections for optimistic transactions.
    
    Specified by:
    
    getConnectionFactory2 in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    the data store connection factory.
  - getMultithreaded
```
public boolean getMultithreaded()
```
    Get the default Multithreaded setting for all PersistenceManager instances obtained from this factory.
    
    Specified by:
    
    getMultithreaded in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    the default Multithreaded setting.
  - getOptimistic
```
public boolean getOptimistic()
```
    Get the default Optimistic setting for all PersistenceManager instances obtained from this factory.
    
    Specified by:
    
    getOptimistic in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    the default Optimistic setting.
  - getRetainValues
```
public boolean getRetainValues()
```
    Get the default RetainValues setting for all PersistenceManager instances obtained from this factory.
    
    Specified by:
    
    getRetainValues in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    the default RetainValues setting.
  - getRestoreValues
```
public boolean getRestoreValues()
```
    Get the default RestoreValues setting for all PersistenceManager instances obtained from this factory.
    
    Specified by:
    
    getRestoreValues in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    the default RestoreValues setting.
  - getNontransactionalRead
```
public boolean getNontransactionalRead()
```
    Get the default NontransactionalRead setting for all PersistenceManager instances obtained from this factory.
    
    Specified by:
    
    getNontransactionalRead in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    the default NontransactionalRead setting.
  - getNontransactionalWrite
```
public boolean getNontransactionalWrite()
```
    Get the default NontransactionalWrite setting for all PersistenceManager instances obtained from this factory.
    
    Specified by:
    
    getNontransactionalWrite in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    the default NontransactionalWrite setting.
  - getIgnoreCache
```
public boolean getIgnoreCache()
```
    Get the default IgnoreCache setting for all PersistenceManager instances obtained from this factory.
    
    Specified by:
    
    getIgnoreCache in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    the IgnoreCache setting.
  - getDetachAllOnCommit
```
public boolean getDetachAllOnCommit()
```
    Accessor for the DetachAllOnCommit setting.
    
    Specified by:
    
    getDetachAllOnCommit in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    the DetachAllOnCommit setting.
  - getCopyOnAttach
```
public boolean getCopyOnAttach()
```
    Accessor for the CopyOnAttach setting.
    
    Specified by:
    
    getCopyOnAttach in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    the CopyOnAttach setting.
  - getMapping
```
public String getMapping()
```
    Get the name for any mapping, used in retrieving metadata files for ORM/Query data.
    
    Specified by:
    
    getMapping in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    the name for the mapping.
  - getCatalog
```
public String getCatalog()
```
    Accessor for the catalog to use for this persistence factory.
    
    Returns:
    the name of the catalog
  - getSchema
```
public String getSchema()
```
    Accessor for the schema to use for this persistence factory.
    
    Returns:
    the name of the schema
  - getName
```
public String getName()
```
    Accessor for the name of the persistence factory (if any).
    
    Specified by:
    
    getName in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    the name of the persistence factory
  - getPersistenceUnitName
```
public String getPersistenceUnitName()
```
    Accessor for the name of the persistence unit
    
    Specified by:
    
    getPersistenceUnitName in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    the name of the persistence unit
  - getPersistenceXmlFilename
```
public String getPersistenceXmlFilename()
```
    Accessor for the filename of the persistence.xml file. This is for the case where an application has placed the persistence.xml somewhere else maybe outside the CLASSPATH.
    
    Returns:
    the filename of the persistence unit
  - getDatastoreReadTimeoutMillis
```
public Integer getDatastoreReadTimeoutMillis()
```
    Accessor for the datastore read timeout interval.
    
    Specified by:
    
    getDatastoreReadTimeoutMillis in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    datastore read timeout
  - getDatastoreWriteTimeoutMillis
```
public Integer getDatastoreWriteTimeoutMillis()
```
    Accessor for the datastore write timeout interval.
    
    Specified by:
    
    getDatastoreWriteTimeoutMillis in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    datastore write timeout
  - getServerTimeZoneID
```
public String getServerTimeZoneID()
```
    Accessor for the timezone "id" of the datastore server (if any). If not set assumes the same as the JVM we are running in.
    
    Specified by:
    
    getServerTimeZoneID in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    Server timezone id
  - getReadOnly
```
public boolean getReadOnly()
```
    Get the default readOnly setting for all PersistenceManager instances obtained from this factory.
    
    Specified by:
    
    getReadOnly in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    the default readOnly setting.
  - getTransactionType
```
public String getTransactionType()
```
    Accessor for the transaction type to use with this persistence factory.
    
    Specified by:
    
    getTransactionType in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    transaction type
  - getTransactionIsolationLevel
```
public String getTransactionIsolationLevel()
```
    Accessor for the transaction isolation level default.
    
    Specified by:
    
    getTransactionIsolationLevel in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    Transaction isolation level
  - setPrimaryClassLoader
```
public void setPrimaryClassLoader(ClassLoader loader)
```
    Mutator to set the primary class loader. Setter provided since the input is an object and so cannot go through property input
    
    Parameters:
    loader - Loader
  - getPrimaryClassLoader
```
public ClassLoader getPrimaryClassLoader()
```
    Accessor for the primary class loader
    
    Returns:
    primary class loader
  - setPersistenceProperties
```
public void setPersistenceProperties(Map<String,Object> props)
```
    Set the properties for this configuration. Note : this has this name so it has a getter/setter pair for use by things like Spring.
    
    Parameters:
    props - The persistence properties
  - getPersistenceProperties
```
public Map<String,Object> getPersistenceProperties()
```
    Accessor for the persistence properties. Note : this has this name so it has a getter/setter pair for use by things like Spring.
    
    Returns:
    The persistence properties
  - assertConfigurable
```
protected void assertConfigurable()
```
    Asserts that a change to a configuration property is allowed.
    
    Throws:
    
    javax.jdo.JDOUserException - if not configurable
  - isConfigurable
```
protected boolean isConfigurable()
```
    Accessor for whether this is still configurable (can set more properties etc).
    
    Returns:
    Whether it is configurable
  - setIsNotConfigurable
```
protected void setIsNotConfigurable()
```
    Method to set that this is no longer configurable. Can no longer become configurable.
  - getLifecycleListenerSpecifications
```
public List<LifecycleListenerForClass> getLifecycleListenerSpecifications()
```
    Deprecated.
    
    Returns:
    Returns either null or a List with instances of LifecycleListenerSpecification.
  - addInstanceLifecycleListener
```
public void addInstanceLifecycleListener(javax.jdo.listener.InstanceLifecycleListener listener,
                                Class[] classes)
```
    Method to add lifecycle listeners for particular classes. Adds the listener to all PMs already created.
    
    Specified by:
    
    addInstanceLifecycleListener in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    listener - The listener
    classes - The classes that the listener relates to
  - removeInstanceLifecycleListener
```
public void removeInstanceLifecycleListener(javax.jdo.listener.InstanceLifecycleListener listener)
```
    Method to remove a lifecycle listener. Removes the listener from all PM's as well.
    
    Specified by:
    
    removeInstanceLifecycleListener in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    listener - The Listener
  - addSequenceForFactoryClass
```
public void addSequenceForFactoryClass(String factoryClassName,
                              javax.jdo.datastore.Sequence sequence)
```
    Method to register a sequence for a particular factory class.
    
    Parameters:
    factoryClassName - Name of the factory class
    sequence - The sequence
  - getSequenceForFactoryClass
```
public javax.jdo.datastore.Sequence getSequenceForFactoryClass(String factoryClassName)
```
    Accessor for the sequence for a factory class.
    
    Parameters:
    factoryClassName - The name of the factory class
    
    Returns:
    The sequence
  - getFetchGroups
```
public Set<javax.jdo.FetchGroup> getFetchGroups()
```
    Specified by:
    
    getFetchGroups in interface javax.jdo.PersistenceManagerFactory
  - getFetchGroup
```
public javax.jdo.FetchGroup getFetchGroup(Class cls,
                                 String name)
```
    Specified by:
    
    getFetchGroup in interface javax.jdo.PersistenceManagerFactory
  - addFetchGroups
```
public void addFetchGroups(javax.jdo.FetchGroup... groups)
```
    Specified by:
    
    addFetchGroups in interface javax.jdo.PersistenceManagerFactory
  - removeFetchGroups
```
public void removeFetchGroups(javax.jdo.FetchGroup... groups)
```
    Specified by:
    
    removeFetchGroups in interface javax.jdo.PersistenceManagerFactory
  - removeAllFetchGroups
```
public void removeAllFetchGroups()
```
    Specified by:
    
    removeAllFetchGroups in interface javax.jdo.PersistenceManagerFactory
  - newMetadata
```
public javax.jdo.metadata.JDOMetadata newMetadata()
```
    Method to return a new metadata object that can be subsequently modified and registered with the persistence process using the method registerMetadata(javax.jdo.metadata.JDOMetadata).
    
    Specified by:
    
    newMetadata in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    Metadata object to start from
  - registerMetadata
```
public void registerMetadata(javax.jdo.metadata.JDOMetadata metadata)
```
    Method to register the supplied metadata with the persistence process managed by this PersistenceManagerFactory. Metadata can be created using the method newMetadata().
    
    Specified by:
    
    registerMetadata in interface javax.jdo.PersistenceManagerFactory
    
    Parameters:
    metadata - The Metadata to register.
  - getMetadata
```
public javax.jdo.metadata.TypeMetadata getMetadata(String className)
```
    Method to return the (class) metadata object for the specified class, if there is metadata defined for that class.
    
    Specified by:
    
    getMetadata in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    The metadata
  - getManagedClasses
```
public Collection<Class> getManagedClasses()
```
    Accessor for the classes that are managed (have metadata loaded).
    
    Specified by:
    
    getManagedClasses in interface javax.jdo.PersistenceManagerFactory
    
    Returns:
    Collection of classes
  - unmanageClass
```
public void unmanageClass(String className)
```
    Method to remove the specified class from the classes that are being managed. In practical terms this means remove all knowledge of the class from the metadata service, and also from the StoreManager service. It doesn't mean to remove the datastore representation (i.e table) of this class.
    
    Parameters:
    className - Name of the class

Class JDOPersistenceManagerFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOCALISER

nucleusContext

lifecycleListeners

Constructor Detail

JDOPersistenceManagerFactory

JDOPersistenceManagerFactory

JDOPersistenceManagerFactory

Method Detail

getPersistenceManagerFactory

getPersistenceManagerFactory

getPersistenceManagerFactory

createPersistenceManagerFactory

close

isClosed

processLifecycleListenersFromProperties

initialiseMetaData

freezeConfiguration

getPersistenceManager

getPersistenceManager

newPM

getNucleusContext

getConfiguration

equals

getObjectInstance

getReference

getPersistenceManagerProxy

getProperties

supportedOptions

releasePersistenceManager

assertIsOpen

finalize

getDataStoreCache

getQueryCache

getQueryGenericCompilationCache

getQueryDatastoreCompilationCache

setConnectionUserName

setConnectionPassword

setConnectionURL

setConnectionDriverName

setConnectionFactoryName

setConnectionFactory

setConnectionFactory2Name

setConnectionFactory2

setMultithreaded

setOptimistic

setRetainValues

setRestoreValues

setNontransactionalRead

setNontransactionalWrite

setIgnoreCache

setDetachAllOnCommit

setCopyOnAttach

setMapping

setCatalog

setSchema

setDatastoreReadTimeoutMillis

setDatastoreWriteTimeoutMillis

setTransactionType

setPersistenceUnitName

setPersistenceXmlFilename

setName

setServerTimeZoneID

setReadOnly

setTransactionIsolationLevel

getConnectionUserName

getConnectionPassword

getConnectionURL

getConnectionDriverName

getConnectionFactoryName

getConnectionFactory2Name

getConnectionFactory

getConnectionFactory2

getMultithreaded

getOptimistic