| 
Any JDO-enabled application will require at least one PersistenceManagerFactory which accepts properties
to define its capabilities. Any JPA-enabled application will require at least one EntityManagerFactory which also
accepts properties to define its capabilities. JPOX provides a large number of properties for use with either JDO or JPA.
Use of the following properties gives you more control over the operations of JPOX, but bear in mind that
these properties are only for use with JPOX and will not work with other JDO/JPA implementations.
- General - general properties
- Schema Control - properties controlling the generation of the datastore schema.
- Transactions and Locking - properties controlling how transactions operate
- Caching - properties controlling the behaviour of the cache(s)
- Identity Generation - properties controlling the generation of object identities
- MetaData - metadata properties
- Auto-Start - Auto-Start Mechanism properties
- Query - properties controlling the behaviour of queries
- JPA - properties allowing extra functionality with JPA.
Please note that there are additional persistence properties for each supported datastore.
See RDBMS
and DB4O
|
org.jpox.ConnectionFactory
|
|---|
| Description | Instance of a connection factory. For RDBMS, it must be an instance of javax.sql.DataSource.
See Data Sources.
This is for a transactional DataSource | | Range of Values | |
|
org.jpox.ConnectionFactory2
|
|---|
| Description | Instance of a connection factory. For RDBMS, it must be an instance of javax.sql.DataSource.
See Data Sources.
This is for a non-transactional DataSource | | Range of Values | |
|
org.jpox.ConnectionFactoryName
|
|---|
| Description | The JNDI name for a connection factory. For RBDMS, it must be a JNDI name that points to a
javax.sql.DataSource object. See Data Sources.
This is for a transactional DataSource | | Range of Values | |
|
org.jpox.ConnectionFactory2Name
|
|---|
| Description | The JNDI name for a connection factory. For RBDMS, it must be a JNDI name that points to a
javax.sql.DataSource object. See Data Sources.
This is for a non-transactional DataSource | | Range of Values | |
|
org.jpox.ConnectionDriverName
|
|---|
| Description | The name of the (JDBC) driver to use for the DB | | Range of Values | |
|
org.jpox.ConnectionDriverURL
|
|---|
| Description | URL specifying the datastore to use for persistence | | Range of Values | |
|
org.jpox.ConnectionUserName
|
|---|
| Description | Username to use for connecting to the DB | | Range of Values | |
|
org.jpox.ConnectionPassword
|
|---|
| Description | Password to use for connecting to the DB | | Range of Values | |
|
org.jpox.IgnoreCache
|
|---|
| Description | Whether to ignore the cache for queries | | Range of Values | true | false |
|
org.jpox.Multithreaded
|
|---|
| Description | Whether to run the PersistenceManager multithreaded | | Range of Values | true | false |
|
org.jpox.NontransactionalRead
|
|---|
| Description | Whether to allow nontransactional reads | | Range of Values | true | false |
|
org.jpox.NontransactionalWrite
|
|---|
| Description | Whether to allow nontransactional writes | | Range of Values | true | false |
|
org.jpox.Optimistic
|
|---|
| Description | Whether to use Optimistic transactions | | Range of Values | true | false |
|
org.jpox.RetainValues
|
|---|
| Description | Whether to suppress the clearing of values from persistent instances on transaction
completion | | Range of Values | true | false |
|
org.jpox.RestoreValues
|
|---|
| Description | Whether persistent object have transactional field values restored when transaction rollback
occurs. | | Range of Values | true | false |
|
org.jpox.Catalog
|
|---|
| Description | Name of the catalog to use by default for all classes persisted using this PMF/EMF.
This can be overridden in the MetaData where required, and is optional.
JPOX will prefix all table names with this catalog name if the RDBMS supports specification
of catalog names in DDL.
RDBMS datastores only | | Range of Values | |
|
org.jpox.Schema
|
|---|
| Description | Name of the schema to use by default for all classes persisted using this PMF/EMF.
This can be overridden in the MetaData where required, and is optional.
JPOX will prefix all table names with this schema name if the RDBMS supports specification
of schema names in DDL.
RDBMS datastores only | | Range of Values | |
| org.jpox.DetachAllOnCommit |
|---|
| Description | Allows the user to select that when a transaction is committed all objects enlisted in that
transaction will be automatically detached. | | Range of Values | true | false |
| org.jpox.TransactionType |
|---|
| Description | Type of transaction to use. If running under J2SE the default is RESOURCE_LOCAL, and
if running under J2EE the default is JTA. | | Range of Values | RESOURCE_LOCAL | JTA |
| org.jpox.ServerTimeZoneID |
|---|
| Description | Id of the TimeZone under which the datastore server is running. If this is not specified
or is set to null it is assumed that the datastore server is running in the same timezone
as the JVM under which JPOX is running. From JPOX 1.2.0-beta-2 | | Range of Values | |
| org.jpox.CopyOnAttach |
|---|
| Description | Whether, when attaching a detached object, we create an attached copy or simply
migrate the detached object to attached state | | Range of Values | true | false |
|
org.jpox.storeManagerType
|
|---|
| Description | Type of the StoreManager to use for this PMF/EMF. This has typical values of "rdbms", "db4o".
If it isnt specified then it falls back to trying to find the StoreManager from the
connection URL. The associated JPOX plugin has to be in the CLASSPATH when selecting this.
When using data sources (as usually done in a JavaEE container), JPOX cannot find out the
correct type automatically and this option must be set. | | Range of Values | rdbms | db4o | alternate StoreManager key |
|
org.jpox.managedRuntime
|
|---|
| Description | Whether to allow management of the runtime of JPOX. Allows hooking in JMX.
Please refer to the Management Guide | | Range of Values | true | false |
|
org.jpox.deletionPolicy
|
|---|
| Description | Allows the user to decide the policy when deleting objects. The default is "JDO2" which firstly
checks if the field is dependent and if so deletes dependents, and then for others will null any
foreign keys out. The problem with this option is that it takes no account of whether the user has also
defined <foreign-key> elements, so we provide a "JPOX" mode that does the dependent field part first
and then if a FK element is defined will leave it to the FK in the datastore to perform any actions, and
otherwise does the nulling. | | Range of Values | JDO2 | JPOX |
|
org.jpox.findObjectCheckInheritance
|
|---|
| Description | When retrieving an object by identity JPOX can do a check on the inheritance level of the object.
In many cases this check is not adding anything since the id implies the inheritance level. This allows
the user to turn off the check. | | Range of Values | true | false |
|
org.jpox.attachSameDatastore
|
|---|
| Description | When attaching an object JPOX by default makes no assumption about which datastore the object was
detached from and so makes a check for existence before attaching each object. This option allows
you to turn off that check when you know you are detaching and attaching using the same datastore. | | Range of Values | false | true |
|
org.jpox.detachOnClose
|
|---|
| Description | This allows the user to specify whether, when a PersistenceManager is closed, that all objects
in the L1 cache are automatically detached.
Users are recommended to not use this option, and instead use the JDO2 standard
javax.jdo.option.DetachAllOnCommit.
This option may be removed in a later release. | | Range of Values | false | true |
|
org.jpox.manageRelationships
|
|---|
| Description | This allows the user control over whether JPOX will try to manage bidirectional
relations, correcting the input objects so that all relations are consistent.
This process runs when flush()/commit() is called.
This is introduced after 1.2.0-beta-4. You can set it to false if you
always set both sides of a relation when persisting/updating. | | Range of Values | true | false |
|
org.jpox.manageRelationshipsChecks
|
|---|
| Description | This allows the user control over whether JPOX will make consistency checks on
bidirectional relations. If "org.jpox.managedRelationships" is not selected then
no checks are performed. If a consistency check fails at flush()/commit() then
a JDOUserException is thrown.
This is introduced after 1.2.0-beta-4. You can set it to false if you
want to omit all consistency checks. | | Range of Values | true | false |
|
org.jpox.persistenceByReachabilityAtCommit
|
|---|
| Description | Whether to run the "persistence-by-reachability" algorithm at commit() time.
This means that objects that were reachable at a call to makePersistent()
but that are no longer persistent will be removed from persistence.
For performance improvements, consider turning this off. | | Range of Values | true | false |
|
org.jpox.maxFetchDepth
|
|---|
| Description | Specifies the default maximum fetch depth to use for fetching operations.
The JDO2 specification defines a default of 1, and this is the JPOX default, meaning that
only the first level of related objects will be fetched by default. | | Range of Values | -1 | 1 | positive integer (non-zero) |
|
org.jpox.classLoaderResolverName
|
|---|
| Description | Name of a ClassLoaderResolver to use in class loading. JPOX provides a default that implements
the JDO2 specification for class loading. This property allows the user to override this with
their own class better suited to their own loading requirements. | | Range of Values | jdo | {name of class-loader-resolver plugin} |
|
org.jpox.primaryClassLoader
|
|---|
| Description | Sets a primary classloader for situations where a primary classloader is not accessible. This ClassLoader
is used when the class is not found in the default ClassLoader search path. As example, when the database
driver is loaded by a different ClassLoader not in the ClassLoader search path for JDO or JPA specifications. | | Range of Values | instance of java.lang.ClassLoader |
|
org.jpox.implementationCreatorName
|
|---|
| Description | Symbolic name of an implementation creator for "persistent interfaces" (JDO2).
JPOX provides two creators, one using BCEL and the other using ASM. Please note that you
should have the JPOX Enhancer in the CLASSPATH together with either BCEL or ASM to use
"persistent interfaces". | | Range of Values | asm | bcel |
|
org.jpox.plugin.pluginRegistryClassName
|
|---|
| Description | Name of a class that acts as registry of plug-ins. | | Range of Values | {fully-qualified class name} |
|
org.jpox.plugin.pluginRegistryBundleCheck
|
|---|
| Description | Defines what happens when plugin bundles are found and are duplicated | | Range of Values | EXCEPTION | LOG | NONE |
|
org.jpox.datastoreAdapterClassName
|
|---|
| Description | This property allows you to supply the class name of the adapter to use for your datastore. The default
is not to specify this property and JPOX will autodetect the datastore type and use its own internal
datastore adapter classes. This allows you to override the default behaviour where there maybe
is some issue with the default adapter class. | | Range of Values | (valid class name on the CLASSPATH) |
|
org.jpox.autoCreateSchema
|
|---|
| Description | Whether to automatically generate any tables and constraints that don't exist. Please refer to
the RDBMS Schema Guide for more details. | | Range of Values | true | false |
|
org.jpox.autoCreateTables
|
|---|
| Description | Whether to automatically generate any tables that don't exist. Please refer to
the RDBMS Schema Guide for more details. | | Range of Values | true | false |
|
org.jpox.autoCreateColumns
|
|---|
| Description | Whether to automatically generate any columns that don't exist. Please refer to
the RDBMS Schema Guide for more
details. | | Range of Values | true | false |
|
org.jpox.autoCreateConstraints
|
|---|
| Description | Whether to automatically generate any constraints that don't exist. Please refer to
the RDBMS Schema Guide for more details. | | Range of Values | true | false |
|
org.jpox.autoCreateWarnOnError
|
|---|
| Description | Whether to only log a warning when errors occur during the auto-creation/validation process.
Please use with care since if the schema is incorrect errors will likely come up later and this
will postpone those error checks til later, when it may be too late!! | | Range of Values | true | false |
|
org.jpox.validateTables
|
|---|
| Description | Whether to validate tables against the persistence definition. Please refer to
the RDBMS Schema Guide for more details. | | Range of Values | true | false |
|
org.jpox.validateColumns
|
|---|
| Description | Whether to validate columns against the persistence definition. This refers to the column detail structure
and NOT to whether the column exists or not. Please refer to the RDBMS Schema
Guide for more details. | | Range of Values | true | false |
|
org.jpox.validateConstraints
|
|---|
| Description | Whether to validate table constraints against the persistence definition. Please refer to
the Schema Guide for more details. | | Range of Values | true | false |
|
org.jpox.readOnlyDatastore
|
|---|
| Description | Whether the datastore is read-only or not (fixed in structure and contents). | | Range of Values | true | false |
|
org.jpox.readOnlyDatastoreAction
|
|---|
| Description | What happens when a datastore is read-only and an object is attempted to
be persisted. | | Range of Values | EXCEPTION | IGNORE |
|
org.jpox.fixedDatastore
|
|---|
| Description | Whether the datastore is fixed in structure or not. | | Range of Values | true | false |
|
org.jpox.identifierFactory
|
|---|
| Description | Name of the identifier factory to use when generating table/column names etc.
See also the JDO RDBMS Identifier Guide. | | Range of Values | jpox | jpox2 | jpa | {user-plugin-name} |
|
org.jpox.identifier.case
|
|---|
| Description | Which case to use in generated table and column names.
See also the JDO RDBMS Identifier Guide. | | Range of Values | UpperCase | LowerCase | PreserveCase |
|
org.jpox.identifier.wordSeparator
|
|---|
| Description | Separator character(s) to use between words in generated identifiers. Defaults to "_" (underscore) |
|
org.jpox.identifier.tablePrefix
|
|---|
| Description | Prefix to be prepended to all generated table names (if the identifier factory supports it) |
|
org.jpox.identifier.tableSuffix
|
|---|
| Description | Suffix to be appended to all generated table names (if the identifier factory supports it) |
|
org.jpox.defaultInheritanceStrategy
|
|---|
| Description | How to choose the inheritance strategy default for classes where no strategy has been specified.
With JDO2 this will be "new-table" for base classes and "superclass-table" for subclasses.
With JPOX this will be "new-table" for all classes. | | Range of Values | JDO2 | JPOX |
|
org.jpox.transactionIsolation
|
|---|
| Description | Select the default JDBC transaction isolation level for ALL PersistenceManager factories - case insensitive,
and spaces/underscores are treated the same. Some databases do not support all isolation levels, refer to your
database documentation. Please refer to the
Transactions Guide | | Range of Values | READ_UNCOMMITTED | READ_COMMITTED | REPEATABLE_READ | SERIALIZABLE |
|
org.jpox.jtaLocator
|
|---|
| Description | Selects the locator to use when using JTA transactions so that JPOX can find the JTA TransactionManager.
If this isn't specified and using JTA transactions JPOX will search all available locators which could
have a performance impact.
See JTA Locator extension.
If specifying "custom_jndi" please also specify "org.jpox.jtaJndiLocation" | | Range of Values | jboss | jonas | jotm | oc4j | orion | resin | sap | sun | weblogic | websphere |
custom_jndi | alias of a JTA transaction locator | | Since | 1.2.0-beta-2 |
|
org.jpox.jtaJndiLocation
|
|---|
| Description | Name of a JNDI location to find the JTA transaction manager from (when using
JTA transactions). This is for the case where you know where it is located. If not
used JPOX will try certain well-known locations | | Range of Values | JNDI location | | Since | 1.2.0-beta-4 |
|
org.jpox.datastoreTransactionDelayOperations
|
|---|
| Description | For use when using datastore transactions and has the effect of delaying datastore
operations until flush()/commit() | | Range of values | true | false |
|
org.jpox.datastoreTransactionFlushLimit
|
|---|
| Description | For use when using datastore transactions and is the limit on number of dirty
objects before a flush to the datastore will be performed. | | Range of values | 1 | positive integer |
|
org.jpox.connectionPoolingType
|
|---|
| Description | This property allows you to utilise a 3rd party software package for enabling connection
pooling using a JPOX plugin. Currently JPOX supports use of DBCP, C3P0 or Proxool. You must have the plugin
and the related 3rd party JARs in your CLASSPATH to use this option. Please refer to
the RDBMS Connection Pooling guide for details. | | Range of Values | None | DBCP | C3P0 | Proxool |
|
org.jpox.connectionPoolingConfigurationFile
|
|---|
| Description | Allows specification of configuration properties for controlling the connection pooling
when you have specified the org.jpox.connectionPoolingType above. | | Range of Values | Filename present in the CLASSPATH |
|
org.jpox.connection.resourceType
|
|---|
| Description | Resource Type for connection ??? | | Range of Values | JTA | RESOURCE_LOCAL |
|
org.jpox.connection.resourceType2
|
|---|
| Description | Resource Type for connection 2 | | Range of Values | JTA | RESOURCE_LOCAL |
|
org.jpox.cache.collections
|
|---|
| Description | SCO collections can be used in 2 modes in JPOX. You can allow JPOX to cache the collections contents, or
you can tell JPOX to access the datastore for every access of the SCO collection. The default is to use
the cached collection. | | Range of Values | true | false |
|
org.jpox.cache.collections.lazy
|
|---|
| Description | When using cached collections/maps, the elements/keys/values can be loaded when the object is
initialised, or can be loaded when accessed (lazy loading). The default is to use lazy loading
when the field is not in the current fetch group, and to not use lazy loading when the field
is in the current fetch group. | | Range of Values | true | false |
|
org.jpox.cache.level1.type
|
|---|
| Description | Name of the type of Level 1 cache to use. Defines the backing map. | | Range of Values | weak | soft | hard | {your-plugin-name} |
|
org.jpox.cache.level2
|
|---|
| Description | Whether to use a Level 2 Cache with this Persistence Manager Factory. | | Range of Values | true | false |
|
org.jpox.cache.level2.type
|
|---|
| Description | Name of the type of Level 2 Cache to use. Can be used to interface with external caching products. | | Range of Values | DEFAULT | SOFT | Tangosol | EHCache | EHCacheClassBased | OSCache | SwarmCache | {your-plugin-name} |
|
org.jpox.cache.level2.cacheName
|
|---|
| Description | Name of the cache. This is for use with plugins such as the Tangosol cache plugin for accessing the
particular cache. Please refer to the Cache Guide | | Range of Values | your cache name |
|
org.jpox.cache.level2.configurationFile
|
|---|
| Description | The path to the configuration file. e.g. /cache.xml The file must be in the classpath and will be looked up as a java resource. Please refer to the Cache Guide | | Range of Values | your configuration file |
|
org.jpox.datastoreIdentityClassName
|
|---|
| Description | Which "datastore-identity" class plugin to use to represent datastore identities.
Refer to Datastore Identity extensions for details. | | Range of Values | jpox | {user-supplied plugin} |
|
org.jpox.poid.transactionAttribute
|
|---|
| Description | Whether to use the PM connection or open a new connection. Only used by POID generators that require
a connection to the datastore. | | Range of Values | New | UsePM |
|
org.jpox.poid.transactionIsolation
|
|---|
| Description | Select the default JDBC transaction isolation level for transactions used by identity generation.
Must have org.jpox.poid.transactionAttribute set to New. Case insensitive, and
spaces/underscores are treated the same. Some databases do not support all isolation levels, refer to your
database documentation. Please refer to the
Transactions Guide | | Range of Values | READ_UNCOMMITTED | READ_COMMITTED | REPEATABLE_READ | SERIALIZABLE |
|
org.jpox.metadata.jdoFileExtension
|
|---|
| Description | Suffix for JDO MetaData files. Provides the ability to override the default suffix and also
to have one PMF with one suffix and another with a different suffix, hence allowing
differing persistence of the same classes using different PMF's. | | Range of values | jdo | {file suffix} |
|
org.jpox.metadata.ormFileExtension
|
|---|
| Description | Suffix for ORM MetaData files. Provides the ability to override the default suffix and also
to have one PMF with one suffix and another with a different suffix, hence allowing
differing persistence of the same classes using different PMF's. | | Range of values | orm | {file suffix} |
|
org.jpox.metadata.jdoqueryFileExtension
|
|---|
| Description | Suffix for JDO Query MetaData files. Provides the ability to override the default suffix and also
to have one PMF with one suffix and another with a different suffix, hence allowing
differing persistence of the same classes using different PMF's. | | Range of values | jdoquery | {file suffix} |
|
org.jpox.metadata.validate
|
|---|
| Description | Whether to validate the MetaData file(s) for XML correctness (against the DTD) when parsing | | Range of values | true | false |
|
org.jpox.metadata.annotationsManager
|
|---|
| Description | Class name for the annotations manager | | Range of values | org.jpox.metadata.annotations.AnnotationManagerImpl | {class-name} |
|
org.jpox.autoStartMechanism
|
|---|
| Description | How to initialise JPOX at startup. This allows JPOX to read in from some source the classes
that it was persisting for this data store the previous time. "XML" stores the information
in an XML file for this purpose.
"SchemaTable" stores a table in the RDBMS for this purpose.
"Classes" looks at the property org.jpox.autoStartClassNames for a list of classes.
The other option is "None" (start from scratch each time). Please
refer to the Auto-Start Mechanism Guide for more details.
The default for RDBMS is "SchemaTable". The default for "DB4O" is "None".
| | Range of Values | XML | SchemaTable | Classes | None | SchemaTable2 |
|
org.jpox.autoStartMechanismMode
|
|---|
| Description | The mode of operation of the auto start mode. Currently there are 3 values. "Quiet" means that at startup if any errors are
encountered, they are fixed quietly. "Ignored" means that at startup if any errors are encountered they are just ignored.
"Checked" means that at startup if any errors are encountered they are thrown as exceptions. | | Range of values | Checked | Ignored | Quiet |
|
org.jpox.autoStartMechanismXmlFile
|
|---|
| Description | Filename used for the XML file for AutoStart when using "XML" Auto-Start Mechanism |
|
org.jpox.autoStartClassNames
|
|---|
| Description | This property specifies a list of classes (comma-separated) that are loaded at startup when using
the "Classes" Auto-Start Mechanism. |
|
org.jpox.query.timeout
|
|---|
| Description | The timeout to apply to all queries (seconds). This also will apply to all fetch statements - for
example when retrieving objects using PM.getObjectById(). | | Range of Values | 0 | A positive value (seconds) |
|
org.jpox.query.flushBeforeExecution
|
|---|
| Description | This property can enforce a flush to the datastore of any outstanding changes just
before executing all queries. If using optimistic transactions any updates are typically
held back until flush/commit and so the query would otherwise not take them into account. | | Range of Values | true | false |
|
org.jpox.query.useFetchPlan
|
|---|
| Description | Whether to use the FetchPlan when executing a JDOQL query. The default is to use it which means that
the relevant fields of the object will be retrieved. This allows the option of just retrieving the
identity columns. | | Range of Values | true | false |
|
org.jpox.jpa.oneToManyUniFkRelations
|
|---|
| Description | Strict JPA1 behaviour doesnt permit a 1-N unidirectional FK relation - must have a join table.
Setting this property to true means that JPOX will allow this relation, overriding this
shortsighted JPA specification behaviour | | Range of Values | false | true |
|
