Package org.apache.openjpa.conf
Class OpenJPAConfigurationImpl
java.lang.Object
org.apache.openjpa.lib.conf.ConfigurationImpl
org.apache.openjpa.conf.OpenJPAConfigurationImpl
- All Implemented Interfaces:
BeanInfo
,Externalizable
,Serializable
,Cloneable
,OpenJPAConfiguration
,Configuration
,ValueListener
,Closeable
- Direct Known Subclasses:
JDBCConfigurationImpl
,XMLConfiguration
Implementation of the
OpenJPAConfiguration
interface.- Author:
- Marc Prud'hommeaux, Abe White
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionorg.apache.openjpa.conf.AutoDetachValue
protected MetaDataRepository
protected RemoteCommitEventManager
Fields inherited from class org.apache.openjpa.lib.conf.ConfigurationImpl
id, logFactoryPlugin
Fields inherited from interface java.beans.BeanInfo
ICON_COLOR_16x16, ICON_COLOR_32x32, ICON_MONO_16x16, ICON_MONO_32x32
Fields inherited from interface org.apache.openjpa.lib.conf.Configuration
ATTRIBUTE_ALLOWED_VALUES, ATTRIBUTE_CATEGORY, ATTRIBUTE_INTERFACE, ATTRIBUTE_ORDER, ATTRIBUTE_TYPE, ATTRIBUTE_XML, INIT_STATE_FREEZING, INIT_STATE_FROZEN, INIT_STATE_LIQUID
Fields inherited from interface org.apache.openjpa.conf.OpenJPAConfiguration
LOG_DATACACHE, LOG_ENHANCE, LOG_METADATA, LOG_QUERY, LOG_RUNTIME, LOG_TOOL, OPTION_DATASTORE_CONNECTION, OPTION_EMBEDDED_COLLECTION_RELATION, OPTION_EMBEDDED_MAP_RELATION, OPTION_EMBEDDED_RELATION, OPTION_ID_APPLICATION, OPTION_ID_DATASTORE, OPTION_INC_FLUSH, OPTION_JDBC_CONNECTION, OPTION_NONTRANS_READ, OPTION_NULL_CONTAINER, OPTION_OPTIMISTIC, OPTION_POSTLOAD_ON_MERGE, OPTION_QUERY_SQL, OPTION_TYPE_ARRAY, OPTION_TYPE_COLLECTION, OPTION_TYPE_MAP, OPTION_USE_TCCL_IN_SELECT_NEW, OPTION_VALUE_AUTOASSIGN, OPTION_VALUE_INCREMENT
-
Constructor Summary
ConstructorDescriptionDefault constructor.OpenJPAConfigurationImpl
(boolean loadGlobals) Constructor.OpenJPAConfigurationImpl
(boolean derivations, boolean loadGlobals) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionReturn the query function listeners.A comma-separted list of the plugin strings of the queryAggregateListener
s to use.Gets the plug-in string ofAuditor
specified in this configuration.Gets the singular instance ofAuditor
associated with this configuration.Whether instances clear their state when entering a transaction.int
Return theAutoClear
constant.A comma-separated list of events which trigger auto-detachment in place of managed states.int
TheAutoDetach
flags.TheBrokerFactory
class to use.Return theBrokerFactoryEventManager
associated with this configuration.The plugin string of theBrokerImpl
extension to create.Gets the plug-in string that described the policy to distribute cached instances across named partitions of L2 data cache.Gets the policy object that determines distribution of cached instances across named partitions of L2 data cache.Return the cache marshaller listeners.A comma-separted list of the plugin strings specifying theCacheMarshaller
s to use.Options for configuring callbacks as a String.Options for configuring callbacks.The plugin string for theClassResolver
to use for custom class loading.TheClassResolver
to use.Backwards compatibility options.If a Compatibility instance is associated with the Specification, we will configure this Compatibility instance instead of instantiating a new one so that the compatibility flags set in compliance with the Specification can be preserved.Returns the logging channelopenjpa.Runtime
by default.Class name of the non-XA connection driver.The password for the non-XA data store connection.These properties provide any additional information needed to establish non-XA connections.The URL for the non-XA data store connection.The user name for the non-XA data store connection.Class name of the connection driver.The connection factory, possibly from JNDI.The non-XA connection factory.The name for the second data store connection factory.Configuration properties for the non-XA connection factory.The mode of the connection factory in use.The name for the data store connection factory.Configuration properties for the connection factory.The password for the data store connection.These properties provide any additional information needed to establish connections.Specifies the behavior of the broker with respect to data store connections.int
Return the connection retain mode as one of the following symbolic constants:ConnectionRetainModes.CONN_RETAIN_ALWAYS
ConnectionRetainModes.CONN_RETAIN_TRANS
ConnectionRetainModes.CONN_RETAIN_DEMAND
The URL for the data store connection.The user name for the data store connection.Optional run a DB action before accessing the database.int
database action from the persistence unit.int
TheDataCache
to use for level-2 data store caching.The data cache manager manages this configuration's cache instances.The data cache manager manages this configuration's cache instances.Return the String constant that matches theDataCacheMode
int
Default data cache timeout.Return the instance specified by the detach state plugin.Similar toOpenJPAConfiguration.getCreateSource()
but for dropping the database schema and content.int
boolean
Return whether to generate dynamic data structures where possible for cache and runtime usage.boolean
Whether OpenJPA will attempt to dynamically load the enhancement agent.Gets theEncryptionProvider
.int
Get the size of the batch that will be pre-selected when accessing elements in a query or relationship.Comma-separated list of fetch group names that will be pre-set for all newFetchConfiguration
s.String[]
List of fetch group names that will be pre-set for all newFetchConfiguration
s.Return the query filter listeners.A comma-separted list of the plugin strings of the queryFilterListener
s to use.Get the string configuration of the finder cache.Get the cache of finder queries.Returns whether or not OpenJPA should automatically flush modifications to the data store before executing queries.int
Returns one ofQueryFlushModes.FLUSH_TRUE
,QueryFlushModes.FLUSH_FALSE
, orQueryFlushModes.FLUSH_WITH_CONNECTION
, as determined by parsing the string returned byOpenJPAConfiguration.getFlushBeforeQueries()
.boolean
Whether changes in the current transaction are taken into account when executing queries and iterating extents.Gets the plug-in string that defines instrumentation providers and what they instrument.Gets an instance of the instrumentation manager.The plugin to use for managing inverse relations.Gets the lifecycle event manager instance classname.Gets the lifecycle event manager instance.Can be used to load a set of initial data into the database.The plugin to use for datastore lock management.int
The time to wait for an object lock in milliseconds, or -1 for no timeout.The plugin string for theManagedRuntime
to use for managed environments.The plugin to use for integrating with a managed runtime.The name mapping to use for this data store.int
The maximum relation depth to traverse when eager fetching.A plugin string describing theMetaDataFactory
to use.A plugin string describing theMetaDataRepository
to use.The metadata repository of managed class information.boolean
Whether brokers or their managed objects will be used by multiple concurrent threads.boolean
Whether persistent state is accessible outside a transaction by default.boolean
Whether persistent state can be modified outside a transaction by default.boolean
Whether to use optimistic transactions by default.boolean
Whether to attempt to optimize id class copy operations during the enhancement process.The action to take when an orphaned key is detected.The action to take when an orphaned key is detected.boolean
Whether to send @PostLoad events on a merge operation.The plugin string for theProxyManager
to use for second class object proxies.TheProxyManager
to use.The plugin to use for level-2 data store query caching.Configuration settings for the query compilation cache to use.Configuration settings for the query compilation cache to use.Gets the configuration of QuerySQLCache.Return PreparedQueryCache used for caching datastore queries.int
The time to wait for a query to execute in milliseconds, or -1 for no timeout.The default read lock level to use during non-optimistic transactions.int
The numeric read lock level.boolean
Gets whether entity state is to be refreshed fromDataCache
.The remote event manager that manages this configuration's remote event listeners.The plugin to use for remote commit notification.Whether to restore initial state on rollback by default.int
Return theRestoreState
constant.boolean
Whether to retain state after a transaction by default.boolean
Whether to warn and defer registration instead of throwing an exception when a registered persistent class cannot be processed.Specifies how OpenJPA handles unenhanced types.int
Return the runtime class optimization setting as one of the following symbolic constants:RuntimeUnenhancedClassesModes.SUPPORTED
RuntimeUnenhancedClassesModes.UNSUPPORTED
RuntimeUnenhancedClassesModes.WARN
The plugin to use for savepoint management.Return the configured savepoint manager instance.Similar toOpenJPAConfiguration.getDatabaseAction()
but write the generated SQL to files.int
Plugin string for the default systemSeq
.The default system sequence.Get the name of the Specification only (not the version or other information) or an empty String if not set.Get the Specification.Return theStoreFacadeTypeRegistry
instance associated with this configuration.Specifies the behavior of the transaction model.Collection<Class<?>>
boolean
Indicates if theThread#contextClassLoader
should be used as fallback if the result class forselect new
is not found by the classloader of the entity.The ValidatorFactory provided by the container or application.Gets the validation groups for pre-persistGets the validation groups for pre-removeGets the validation groups for pre-updateThe bean validation mode to use for managed classes.The Validator provided by the container or created by the runtime.The default write lock level to use during non-optimistic transactions.int
The numeric write lock level.void
Call the instantiating get methods for all values.boolean
Whether connections are automatically enlisted in global transactions.boolean
Affirms if all configured elements are initialized eagerly as opposed to lazily on-demand.boolean
Return whether managed transactions are being used.boolean
Returns true if a metaDataRepository has been created for this configuration.newBrokerInstance
(String user, String pass) Create a new broker instance with the configured plugin data.Return a new inverse manager instance using the configured plugin settings.Return a new lock manager instance using the configured plugin settings.Create a newMetaDataFactory
to use with a repository.Create a new empty metadata repository of the configured type.Create a remote commit provider from the configured plugin.protected void
preClose()
Invoked by final methodConfigurationImpl.close()
after invoking theProductDerivation.beforeConfigurationClose(org.apache.openjpa.lib.conf.Configuration)
callbacks but before performing internal close operations.void
setAggregateListeners
(String aggregateListeners) A comma-separted list of the plugin strings of the queryAggregateListener
s to use.void
setAggregateListeners
(AggregateListener[] listeners) Set the query function listeners.void
setAuditor
(String auditor) Sets the plug-in string ofAuditor
specified in this configuration.void
setAuditorInstance
(Auditor auditor) Sets the singular instance ofAuditor
associated with this configuration.void
setAutoClear
(int clear) Whether instances clear their state when entering a transaction.void
setAutoClear
(String clear) Whether instances clear their state when entering a transaction.void
setAutoDetach
(int autoDetachFlags) TheAutoDetach
flags.void
setAutoDetach
(String autoDetach) A comma-separated list of events which trigger auto-detachment in place of managed states.void
setBrokerFactory
(String factory) TheBrokerFactory
class to use.void
setBrokerImpl
(String broker) The plugin string of theBrokerImpl
extension to create.void
setCacheDistributionPolicy
(String policyPlugin) Sets the plug-in string that describes the policy to distribute cached instances across named partitions of L2 data cache.void
Sets the policy object that determines distribution of cached instances across named partitions of L2 data cache.void
setCacheMarshallers
(String marshallers) A comma-separated list of the plugin strings specifying theCacheMarshaller
s to use.void
setCallbackOptions
(String options) Options for configuring callbacks set as a comma-separated string value pair.void
setClassResolver
(String classResolver) The plugin string for theClassResolver
to use for custom class loading.void
setClassResolver
(ClassResolver classResolver) TheClassResolver
to use.void
setCompatibility
(String compatibility) Backwards compatibility options.void
setConnection2DriverName
(String driverName) Class name of the non-XA connection driver.void
setConnection2Password
(String connection2Password) The password for the non-XA data store connection.void
setConnection2Properties
(String connection2Properties) These properties provide any additional information needed to establish non-XA connections.void
setConnection2URL
(String connection2URL) The URL for the non-XA data store connection.void
setConnection2UserName
(String connection2UserName) The user name for the non-XA data store connection.void
setConnectionDriverName
(String driverName) Class name of the connection driver.void
setConnectionFactory
(Object factory) The connection factory.void
setConnectionFactory2
(Object factory) The non-XA connection factory.void
setConnectionFactory2Name
(String connectionFactory2Name) The name for the second data store connection factory.void
setConnectionFactory2Properties
(String connectionFactory2Properties) Configuration properties for the non-XA connection factory.void
The mode of the connection factory in use.void
setConnectionFactoryModeManaged
(boolean managed) Whether connections are automatically enlisted in global transactions.void
setConnectionFactoryName
(String connectionFactoryName) The name for the data store connection factory.void
setConnectionFactoryProperties
(String connectionFactoryProperties) Configuration properties for the connection factory.void
setConnectionPassword
(String connectionPassword) The password for the data store connection.void
setConnectionProperties
(String connectionProperties) These properties provide any additional information needed to establish connections.void
setConnectionRetainMode
(int connectionRetainMode) Set the connection retain mode as one of the following symbolic constants:ConnectionRetainModes.CONN_RETAIN_ALWAYS
ConnectionRetainModes.CONN_RETAIN_TRANS
ConnectionRetainModes.CONN_RETAIN_DEMAND
void
setConnectionRetainMode
(String connectionRetainMode) Specifies the behavior of the broker with respect to data store connections.void
setConnectionURL
(String connectionURL) The URL for the data store connection.void
setConnectionUserName
(String connectionUserName) The user name for the data store connection.void
setDataCache
(String dataCache) TheDataCache
to use for level-2 data store caching.void
The data cache manager manages this configuration's cache instances.void
The data cache manager manages this configuration's cache instances.void
setDataCacheMode
(String mode) Set theDataCacheMode
void
setDataCacheTimeout
(int dataCacheTimeout) Default data cache timeout.void
setDataCacheTimeout
(Integer dataCacheTimeout) Wrapper for JCA usage ofOpenJPAConfiguration.setDataCacheTimeout(int)
.void
setDetachState
(String detachState) Which field values to include when detaching.void
setDetachState
(DetachOptions detachState) Return the instance specified by the detach state plugin.void
setDynamicDataStructs
(boolean dynamic) Set whether to generate dynamic data structures where possible for cache and runtime usage.void
setDynamicDataStructs
(Boolean dynamic) Wrapper for JCA usage ofOpenJPAConfiguration.setDynamicDataStructs(boolean)
.void
setDynamicEnhancementAgent
(boolean dynamic) Sets whether OpenJPA will attempt to dynamically load the enhancement agent.void
Sets theEncryptionProvider
.void
setFetchBatchSize
(int fetchBatchSize) Set the size of the batch that will be pre-selected when accessing elements in a query or relationship.void
setFetchBatchSize
(Integer fetchBatchSize) Wrapper for JCA usage ofOpenJPAConfiguration.setFetchBatchSize(int)
.void
setFetchGroups
(String fetchGroups) Comma-separated list of fetch group names that will be pre-set for all newFetchConfiguration
s.void
setFetchGroups
(String[] fetchGroups) List of fetch group names that will be pre-set for all newFetchConfiguration
s.void
setFilterListeners
(String filterListeners) A comma-separted list of the plugin strings of the queryFilterListener
s to use.void
setFilterListeners
(FilterListener[] listeners) Set the query filter listeners.void
setFinderCache
(String finderCache) Set the finder cache from a string configuration.void
setFlushBeforeQueries
(int flush) void
setFlushBeforeQueries
(String flush) Sets whether or not OpenJPA should automatically flush modifications to the data store before executing queries.void
setIgnoreChanges
(boolean ignoreChanges) Whether changes in the current transaction are taken into account when executing queries and iterating extents.void
setIgnoreChanges
(Boolean ignoreChanges) Wrapper for JCA usage ofOpenJPAConfiguration.setIgnoreChanges(boolean)
.void
setInitializeEagerly
(boolean retry) Sets whether all configured elements will be initialized eagerly or lazily on-demand.void
setInstrumentation
(String providers) Sets the plug-in string that defines instrumentation providers and what they instrument.void
void
void
setInverseManager
(String inverseManager) The plugin to use for managing inverse relations.void
Sets the lifecycle event manager instance classname.void
setLockManager
(String lockManager) The plugin to use for datastore lock management.void
setLockTimeout
(int timeout) The time to wait for an object lock in milliseconds, or -1 for no timeout.void
setLockTimeout
(Integer timeout) Wrapper for JCA usage ofOpenJPAConfiguration.setLockTimeout(int)
.void
setManagedRuntime
(String managedRuntime) The plugin string for theManagedRuntime
to use for managed environments.void
setManagedRuntime
(ManagedRuntime managedRuntime) The plugin to use for integrating with a managed runtime.void
setMapping
(String mapping) The name mapping to use for this data store.void
setMaxFetchDepth
(int maxFetchDepth) The maximum relation depth to traverse when eager fetching.void
setMaxFetchDepth
(Integer maxFetchDepth) Wrapper for JCA usage ofOpenJPAConfiguration.setMaxFetchDepth(int)
.void
setMetaDataFactory
(String meta) A plugin string describing theMetaDataFactory
to use.void
setMetaDataRepository
(String meta) A plugin string describing theMetaDataRepository
to use.void
The metadata repository of managed class information.void
setMultithreaded
(boolean multithreaded) Whether brokers or their managed objects will be used by multiple concurrent threads.void
setMultithreaded
(Boolean multithreaded) Wrapper for JCA usage ofOpenJPAConfiguration.setMultithreaded(boolean)
.void
setNontransactionalRead
(boolean nontransactionalRead) Whether persistent state is accessible outside a transaction by default.void
setNontransactionalRead
(Boolean nontransactionalRead) Wrapper for JCA usage ofOpenJPAConfiguration.setNontransactionalRead(boolean)
.void
setNontransactionalWrite
(boolean nontransactionalWrite) Whether persistent state can be modified outside a transaction by default.void
setNontransactionalWrite
(Boolean nontransactionalWrite) Wrapper for JCA usage ofOpenJPAConfiguration.setNontransactionalWrite(boolean)
.void
setOptimistic
(boolean optimistic) Whether to use optimistic transactions by default.void
setOptimistic
(Boolean optimistic) Wrapper for JCA usage ofOpenJPAConfiguration.setOptimistic(boolean)
.void
setOptimizeIdCopy
(boolean optimizeId) Whether to attempt to optimize id class copy operations during the enhancement process.void
setOptimizeIdCopy
(Boolean optimizeId) Whether to attempt to optimize id class copy operations during the enhancement process.void
setOrphanedKeyAction
(String action) The action to take when an orphaned key is detected.void
The action to take when an orphaned key is detected.void
setPersistenceEnvironment
(Map<String, Object> peMap) void
setPostLoadOnMerge
(boolean postLoadOnMerge) Whether to send @PostLoad events on a merge operation.void
setPostLoadOnMerge
(Boolean postLoadOnMerge) Whether to send @PostLoad events on a merge operation.void
setProxyManager
(String proxyManager) The plugin string for theProxyManager
to use for second class object proxies.void
setProxyManager
(ProxyManager proxyManager) TheProxyManager
to use.void
setQueryCache
(String queryCache) The plugin to use for level-2 data store query caching.void
setQueryCompilationCache
(String queryCompilationCache) Configuration settings for the query compilation cache to use.void
setQuerySQLCache
(String querySQLCache) Sets QuerySQLCache with the given configuration.void
setQuerySQLCache
(PreparedQueryCache querySQLCache) Sets QuerySQLCache with the given cache.void
setQueryTimeout
(int timeout) The time to wait for a query to execute in milliseconds, or -1 for no timeout.void
setReadLockLevel
(int level) The numeric read lock level.void
setReadLockLevel
(String level) The default read lock level to use during non-optimistic transactions.void
setRefreshFromDataCache
(boolean flag) Sets whether entity state is to be refreshed fromDataCache
.void
Sets whether entity state is to be refreshed fromDataCache
.void
setRemoteCommitEventManager
(RemoteCommitEventManager remoteEventManager) The remote event manager that manages this configuration's remote event listeners.void
setRemoteCommitProvider
(String remoteCommitProvider) The plugin to use for remote commit notification.void
setRestoreState
(int restoreState) Whether to restore initial state on rollback by default.void
setRestoreState
(String restoreState) Whether to restore initial state on rollback by default.void
setRetainState
(boolean retainState) Whether to retain state after a transaction by default.void
setRetainState
(Boolean retainState) Wrapper for JCA usage ofOpenJPAConfiguration.setRetainState(boolean)
.void
setRetryClassRegistration
(boolean retry) Whether to warn and defer registration instead of throwing an exception when a registered persistent class cannot be processed.void
setRetryClassRegistration
(Boolean retry) Wrapper for JCA usage ofOpenJPAConfiguration.setRetryClassRegistration(boolean)
.void
setRuntimeUnenhancedClasses
(int mode) Set the runtime class optimization setting as one of the following symbolic constants:RuntimeUnenhancedClassesModes.SUPPORTED
RuntimeUnenhancedClassesModes.UNSUPPORTED
RuntimeUnenhancedClassesModes.WARN
void
Specifies how OpenJPA handles unenhanced types.void
setSavepointManager
(String savepointManager) The plugin to use for savepoint management.void
setSequence
(String sequence) Plugin string for the default systemSeq
.void
setSequence
(Seq seq) The default system sequence.void
setSpecification
(String spec) Sets Specification from the given String.void
setSpecification
(Specification newSpec) Set the Specification for this configuration.void
setTransactionMode
(String transactionMode) Specifies the behavior of the transaction model.void
setTransactionModeManaged
(boolean managed) Set whether managed transactions are being used.void
setTypesWithoutEnhancement
(Collection<Class<?>> value) void
setUseTCCLinSelectNew
(boolean useTcclForSelectNew) Indicates if theThread#contextClassLoader
should be used as fallback if the result class forselect new
is not found by the classloader of the entity.void
setUseTCCLinSelectNew
(Boolean useTcclForSelectNew) Indicates if theThread#contextClassLoader
should be used as fallback if the result class forselect new
is not found by the classloader of the entity.void
setValidationFactory
(Object factory) Set the container or application provided ValidatorFactory instance.void
setValidationGroupPrePersist
(String vgPrePersist) Sets the validation groups for pre-persistvoid
setValidationGroupPreRemove
(String vgPreRemove) Sets the validation groups for pre-removevoid
setValidationGroupPreUpdate
(String vgPreUpdate) Sets the validation groups for pre-updatevoid
setValidationMode
(String mode) Set the bean validation mode to use for managed classes.void
Set the container or application provided Validator instance.void
setWriteLockLevel
(int level) The numeric write lock level.void
setWriteLockLevel
(String level) The default write lock level to use during non-optimistic transactions.Return the set of option strings supported by this runtime.Methods inherited from class org.apache.openjpa.lib.conf.ConfigurationImpl
addBoolean, addDouble, addFile, addInt, addObject, addPlugin, addPluginList, addPropertyChangeListener, addString, addStringList, addValue, clone, close, equals, fromProperties, getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getIcon, getId, getLog, getLog, getLogFactory, getMethodDescriptors, getProductName, getPropertiesResource, getPropertyDescriptors, getPropertyKeys, getPropertyKeys, getUserClassLoader, getValue, getValues, hashCode, isDeferResourceLoading, isInvalidProperty, isReadOnly, loadGlobals, readExternal, removePropertyChangeListener, removeValue, setDeferResourceLoading, setId, setLog, setLogFactory, setProductName, setProperties, setPropertiesFile, setReadOnly, setUserClassLoader, toProperties, toXMLName, valueChanged, writeExternal
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.beans.BeanInfo
getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getIcon, getMethodDescriptors, getPropertyDescriptors
Methods inherited from interface org.apache.openjpa.lib.conf.Configuration
addPropertyChangeListener, addValue, clone, close, fromProperties, getId, getLog, getLog, getLogFactory, getProductName, getPropertyKeys, getPropertyKeys, getUserClassLoader, getValue, getValues, isReadOnly, removePropertyChangeListener, removeValue, setId, setLog, setLogFactory, setProductName, setReadOnly, setUserClassLoader, toProperties
-
Field Details
-
metaRepository
-
remoteEventManager
-
classResolverPlugin
-
brokerPlugin
-
dataCachePlugin
-
dataCacheManagerPlugin
-
auditorPlugin
-
cacheDistributionPolicyPlugin
-
dataCacheTimeout
-
queryCachePlugin
-
dynamicDataStructs
-
managedRuntimePlugin
-
transactionMode
-
connectionRetainMode
-
fetchBatchSize
-
maxFetchDepth
-
fetchGroups
-
flushBeforeQueries
-
lockTimeout
-
queryTimeout
-
readLockLevel
-
writeLockLevel
-
seqPlugin
-
filterListenerPlugins
-
aggregateListenerPlugins
-
retryClassRegistration
-
proxyManagerPlugin
-
connectionUserName
-
connectionPassword
-
encryptionProvider
-
connectionURL
-
connectionDriverName
-
connectionFactory
-
connectionFactoryName
-
connectionProperties
-
connectionFactoryProperties
-
connectionFactoryMode
-
connection2UserName
-
connection2Password
-
connection2URL
-
connection2DriverName
-
connection2Properties
-
connectionFactory2
-
connectionFactory2Name
-
connectionFactory2Properties
-
optimistic
-
autoClear
-
retainState
-
restoreState
-
detachStatePlugin
-
ignoreChanges
-
nontransactionalRead
-
nontransactionalWrite
-
refreshFromDataCache
-
multithreaded
-
mapping
-
metaFactoryPlugin
-
metaRepositoryPlugin
-
lockManagerPlugin
-
inverseManagerPlugin
-
savepointManagerPlugin
-
orphanedKeyPlugin
-
compatibilityPlugin
-
callbackPlugin
-
queryCompilationCachePlugin
-
runtimeUnenhancedClasses
-
cacheMarshallerPlugins
-
eagerInitialization
-
preparedQueryCachePlugin
-
finderCachePlugin
-
specification
-
validationMode
-
validationFactory
-
validator
-
lifecycleEventManager
-
validationGroupPrePersist
-
validationGroupPreUpdate
-
validationGroupPreRemove
-
dataCacheMode
-
dynamicEnhancementAgent
-
instrumentationManager
-
instrumentationProviders
-
postLoadOnMerge
-
optimizeIdCopy
-
useTcclForSelectNew
-
typesWithoutEnhancement
-
databaseAction
-
scriptsAction
-
createSource
-
dropSource
-
createScriptSource
-
dropScriptSource
-
createScriptTarget
-
dropScriptTarget
-
loadScriptSource
-
brokerFactoryPlugin
-
remoteProviderPlugin
-
autoDetach
public org.apache.openjpa.conf.AutoDetachValue autoDetach
-
-
Constructor Details
-
OpenJPAConfigurationImpl
public OpenJPAConfigurationImpl()Default constructor. Attempts to load global properties. -
OpenJPAConfigurationImpl
public OpenJPAConfigurationImpl(boolean loadGlobals) Constructor.- Parameters:
loadGlobals
- whether to attempt to load the global properties
-
OpenJPAConfigurationImpl
public OpenJPAConfigurationImpl(boolean derivations, boolean loadGlobals) Constructor.- Parameters:
derivations
- whether to apply product derivationsloadGlobals
- whether to attempt to load the global properties
-
-
Method Details
-
supportedOptions
Description copied from interface:OpenJPAConfiguration
Return the set of option strings supported by this runtime. This set is mutable.- Specified by:
supportedOptions
in interfaceOpenJPAConfiguration
-
getSpecification
Get the name of the Specification only (not the version or other information) or an empty String if not set.- Specified by:
getSpecification
in interfaceOpenJPAConfiguration
-
getSpecificationInstance
Description copied from interface:OpenJPAConfiguration
Get the Specification. Specification determines various important default behaviors.- Specified by:
getSpecificationInstance
in interfaceOpenJPAConfiguration
-
setSpecification
Sets Specification from the given String.- Specified by:
setSpecification
in interfaceOpenJPAConfiguration
- Parameters:
spec
- should be encoded in the format specified inSpecification
.- See Also:
-
setSpecification
Description copied from interface:OpenJPAConfiguration
Set the Specification for this configuration. Specification determines various default properties and behavior. For example,compatibility
options during runtime. This change will trigger all registered Product Derivations to mutate other configuration properties.- Specified by:
setSpecification
in interfaceOpenJPAConfiguration
- Parameters:
newSpec
- fullname of the specification that possibly encodes major and minor version information. For encoding format- See Also:
-
setClassResolver
Description copied from interface:OpenJPAConfiguration
The plugin string for theClassResolver
to use for custom class loading.- Specified by:
setClassResolver
in interfaceOpenJPAConfiguration
-
getClassResolver
Description copied from interface:OpenJPAConfiguration
The plugin string for theClassResolver
to use for custom class loading.- Specified by:
getClassResolver
in interfaceOpenJPAConfiguration
-
setClassResolver
Description copied from interface:OpenJPAConfiguration
TheClassResolver
to use.- Specified by:
setClassResolver
in interfaceOpenJPAConfiguration
-
getClassResolverInstance
Description copied from interface:OpenJPAConfiguration
TheClassResolver
to use.- Specified by:
getClassResolverInstance
in interfaceOpenJPAConfiguration
-
setBrokerFactory
Description copied from interface:OpenJPAConfiguration
TheBrokerFactory
class to use.- Specified by:
setBrokerFactory
in interfaceOpenJPAConfiguration
-
getBrokerFactory
Description copied from interface:OpenJPAConfiguration
TheBrokerFactory
class to use.- Specified by:
getBrokerFactory
in interfaceOpenJPAConfiguration
-
setBrokerImpl
Description copied from interface:OpenJPAConfiguration
The plugin string of theBrokerImpl
extension to create.- Specified by:
setBrokerImpl
in interfaceOpenJPAConfiguration
-
getBrokerImpl
Description copied from interface:OpenJPAConfiguration
The plugin string of theBrokerImpl
extension to create.- Specified by:
getBrokerImpl
in interfaceOpenJPAConfiguration
-
newBrokerInstance
Description copied from interface:OpenJPAConfiguration
Create a new broker instance with the configured plugin data.- Specified by:
newBrokerInstance
in interfaceOpenJPAConfiguration
-
setDataCacheManager
Description copied from interface:OpenJPAConfiguration
The data cache manager manages this configuration's cache instances.- Specified by:
setDataCacheManager
in interfaceOpenJPAConfiguration
-
getDataCacheManager
Description copied from interface:OpenJPAConfiguration
The data cache manager manages this configuration's cache instances.- Specified by:
getDataCacheManager
in interfaceOpenJPAConfiguration
-
setDataCacheManager
Description copied from interface:OpenJPAConfiguration
The data cache manager manages this configuration's cache instances.- Specified by:
setDataCacheManager
in interfaceOpenJPAConfiguration
-
getDataCacheManagerInstance
Description copied from interface:OpenJPAConfiguration
The data cache manager manages this configuration's cache instances. The cache manager is created if it has not been set. Once the cache manager has been set/created, all changes to caching configuration must proceed through the cache manager.- Specified by:
getDataCacheManagerInstance
in interfaceOpenJPAConfiguration
-
setDataCache
Description copied from interface:OpenJPAConfiguration
TheDataCache
to use for level-2 data store caching.- Specified by:
setDataCache
in interfaceOpenJPAConfiguration
-
getDataCache
Description copied from interface:OpenJPAConfiguration
TheDataCache
to use for level-2 data store caching.- Specified by:
getDataCache
in interfaceOpenJPAConfiguration
-
setDataCacheTimeout
public void setDataCacheTimeout(int dataCacheTimeout) Description copied from interface:OpenJPAConfiguration
Default data cache timeout.- Specified by:
setDataCacheTimeout
in interfaceOpenJPAConfiguration
-
setDataCacheTimeout
Description copied from interface:OpenJPAConfiguration
Wrapper for JCA usage ofOpenJPAConfiguration.setDataCacheTimeout(int)
.- Specified by:
setDataCacheTimeout
in interfaceOpenJPAConfiguration
-
getDataCacheTimeout
public int getDataCacheTimeout()Description copied from interface:OpenJPAConfiguration
Default data cache timeout.- Specified by:
getDataCacheTimeout
in interfaceOpenJPAConfiguration
-
setQueryCache
Description copied from interface:OpenJPAConfiguration
The plugin to use for level-2 data store query caching.- Specified by:
setQueryCache
in interfaceOpenJPAConfiguration
-
getQueryCache
Description copied from interface:OpenJPAConfiguration
The plugin to use for level-2 data store query caching.- Specified by:
getQueryCache
in interfaceOpenJPAConfiguration
-
getRefreshFromDataCache
public boolean getRefreshFromDataCache()Description copied from interface:OpenJPAConfiguration
Gets whether entity state is to be refreshed fromDataCache
. The entities are never refreshed from DataCache if lock is being applied (e.g. in a pessimistic transaction) and hence this setting only refers to behavior when not locking. This flag can be used to overwrite RetrieveMode.BYPASS. By default, however, this falg is false.- Specified by:
getRefreshFromDataCache
in interfaceOpenJPAConfiguration
-
setRefreshFromDataCache
public void setRefreshFromDataCache(boolean flag) Description copied from interface:OpenJPAConfiguration
Sets whether entity state is to be refreshed fromDataCache
. The entities are never refreshed from DataCache if lock is being applied (e.g. in a pessimistic transaction) and hence this setting only refers to behavior when not locking.- Specified by:
setRefreshFromDataCache
in interfaceOpenJPAConfiguration
-
setRefreshFromDataCache
Description copied from interface:OpenJPAConfiguration
Sets whether entity state is to be refreshed fromDataCache
. The entities are never refreshed from DataCache if lock is being applied (e.g. in a pessimistic transaction) and hence this setting only refers to behavior when not locking.- Specified by:
setRefreshFromDataCache
in interfaceOpenJPAConfiguration
-
getDynamicDataStructs
public boolean getDynamicDataStructs()Description copied from interface:OpenJPAConfiguration
Return whether to generate dynamic data structures where possible for cache and runtime usage.- Specified by:
getDynamicDataStructs
in interfaceOpenJPAConfiguration
-
setDynamicDataStructs
public void setDynamicDataStructs(boolean dynamic) Description copied from interface:OpenJPAConfiguration
Set whether to generate dynamic data structures where possible for cache and runtime usage.- Specified by:
setDynamicDataStructs
in interfaceOpenJPAConfiguration
-
setDynamicDataStructs
Description copied from interface:OpenJPAConfiguration
Wrapper for JCA usage ofOpenJPAConfiguration.setDynamicDataStructs(boolean)
.- Specified by:
setDynamicDataStructs
in interfaceOpenJPAConfiguration
-
setLockManager
Description copied from interface:OpenJPAConfiguration
The plugin to use for datastore lock management.- Specified by:
setLockManager
in interfaceOpenJPAConfiguration
-
getLockManager
Description copied from interface:OpenJPAConfiguration
The plugin to use for datastore lock management.- Specified by:
getLockManager
in interfaceOpenJPAConfiguration
-
newLockManagerInstance
Description copied from interface:OpenJPAConfiguration
Return a new lock manager instance using the configured plugin settings.- Specified by:
newLockManagerInstance
in interfaceOpenJPAConfiguration
-
setInverseManager
Description copied from interface:OpenJPAConfiguration
The plugin to use for managing inverse relations.- Specified by:
setInverseManager
in interfaceOpenJPAConfiguration
-
getInverseManager
Description copied from interface:OpenJPAConfiguration
The plugin to use for managing inverse relations.- Specified by:
getInverseManager
in interfaceOpenJPAConfiguration
-
newInverseManagerInstance
Description copied from interface:OpenJPAConfiguration
Return a new inverse manager instance using the configured plugin settings.- Specified by:
newInverseManagerInstance
in interfaceOpenJPAConfiguration
-
setSavepointManager
Description copied from interface:OpenJPAConfiguration
The plugin to use for savepoint management.- Specified by:
setSavepointManager
in interfaceOpenJPAConfiguration
-
getSavepointManager
Description copied from interface:OpenJPAConfiguration
The plugin to use for savepoint management.- Specified by:
getSavepointManager
in interfaceOpenJPAConfiguration
-
getSavepointManagerInstance
Description copied from interface:OpenJPAConfiguration
Return the configured savepoint manager instance.- Specified by:
getSavepointManagerInstance
in interfaceOpenJPAConfiguration
-
setOrphanedKeyAction
Description copied from interface:OpenJPAConfiguration
The action to take when an orphaned key is detected.- Specified by:
setOrphanedKeyAction
in interfaceOpenJPAConfiguration
-
getOrphanedKeyAction
Description copied from interface:OpenJPAConfiguration
The action to take when an orphaned key is detected.- Specified by:
getOrphanedKeyAction
in interfaceOpenJPAConfiguration
-
getOrphanedKeyActionInstance
Description copied from interface:OpenJPAConfiguration
The action to take when an orphaned key is detected.- Specified by:
getOrphanedKeyActionInstance
in interfaceOpenJPAConfiguration
-
setOrphanedKeyAction
Description copied from interface:OpenJPAConfiguration
The action to take when an orphaned key is detected.- Specified by:
setOrphanedKeyAction
in interfaceOpenJPAConfiguration
-
setRemoteCommitProvider
Description copied from interface:OpenJPAConfiguration
The plugin to use for remote commit notification.- Specified by:
setRemoteCommitProvider
in interfaceOpenJPAConfiguration
-
getRemoteCommitProvider
Description copied from interface:OpenJPAConfiguration
The plugin to use for remote commit notification.- Specified by:
getRemoteCommitProvider
in interfaceOpenJPAConfiguration
-
newRemoteCommitProviderInstance
Description copied from interface:OpenJPAConfiguration
Create a remote commit provider from the configured plugin.- Specified by:
newRemoteCommitProviderInstance
in interfaceOpenJPAConfiguration
-
setRemoteCommitEventManager
Description copied from interface:OpenJPAConfiguration
The remote event manager that manages this configuration's remote event listeners.- Specified by:
setRemoteCommitEventManager
in interfaceOpenJPAConfiguration
-
getRemoteCommitEventManager
Description copied from interface:OpenJPAConfiguration
The remote event manager that manages this configuration's remote event listeners.- Specified by:
getRemoteCommitEventManager
in interfaceOpenJPAConfiguration
-
setTransactionMode
Description copied from interface:OpenJPAConfiguration
Specifies the behavior of the transaction model. Possible values are:local
: Perform transaction operations locally.managed
: Use managed environment's global transactions.
- Specified by:
setTransactionMode
in interfaceOpenJPAConfiguration
-
getTransactionMode
Description copied from interface:OpenJPAConfiguration
Specifies the behavior of the transaction model. Possible values are:local
: Perform transaction operations locally.managed
: Use managed environment's global transactions.
- Specified by:
getTransactionMode
in interfaceOpenJPAConfiguration
-
setTransactionModeManaged
public void setTransactionModeManaged(boolean managed) Description copied from interface:OpenJPAConfiguration
Set whether managed transactions are being used.- Specified by:
setTransactionModeManaged
in interfaceOpenJPAConfiguration
-
isTransactionModeManaged
public boolean isTransactionModeManaged()Description copied from interface:OpenJPAConfiguration
Return whether managed transactions are being used.- Specified by:
isTransactionModeManaged
in interfaceOpenJPAConfiguration
-
setManagedRuntime
Description copied from interface:OpenJPAConfiguration
The plugin string for theManagedRuntime
to use for managed environments.- Specified by:
setManagedRuntime
in interfaceOpenJPAConfiguration
-
getManagedRuntime
Description copied from interface:OpenJPAConfiguration
The plugin string for theManagedRuntime
to use for managed environments.- Specified by:
getManagedRuntime
in interfaceOpenJPAConfiguration
-
setManagedRuntime
Description copied from interface:OpenJPAConfiguration
The plugin to use for integrating with a managed runtime.- Specified by:
setManagedRuntime
in interfaceOpenJPAConfiguration
-
getManagedRuntimeInstance
Description copied from interface:OpenJPAConfiguration
The plugin to use for integrating with a managed runtime.- Specified by:
getManagedRuntimeInstance
in interfaceOpenJPAConfiguration
-
setProxyManager
Description copied from interface:OpenJPAConfiguration
The plugin string for theProxyManager
to use for second class object proxies.- Specified by:
setProxyManager
in interfaceOpenJPAConfiguration
-
getProxyManager
Description copied from interface:OpenJPAConfiguration
The plugin string for theProxyManager
to use for second class object proxies.- Specified by:
getProxyManager
in interfaceOpenJPAConfiguration
-
setProxyManager
Description copied from interface:OpenJPAConfiguration
TheProxyManager
to use.- Specified by:
setProxyManager
in interfaceOpenJPAConfiguration
-
getProxyManagerInstance
Description copied from interface:OpenJPAConfiguration
TheProxyManager
to use.- Specified by:
getProxyManagerInstance
in interfaceOpenJPAConfiguration
-
setMapping
Description copied from interface:OpenJPAConfiguration
The name mapping to use for this data store.- Specified by:
setMapping
in interfaceOpenJPAConfiguration
-
getMapping
Description copied from interface:OpenJPAConfiguration
The name mapping to use for this data store.- Specified by:
getMapping
in interfaceOpenJPAConfiguration
-
setMetaDataFactory
Description copied from interface:OpenJPAConfiguration
A plugin string describing theMetaDataFactory
to use.- Specified by:
setMetaDataFactory
in interfaceOpenJPAConfiguration
-
getMetaDataFactory
Description copied from interface:OpenJPAConfiguration
A plugin string describing theMetaDataFactory
to use.- Specified by:
getMetaDataFactory
in interfaceOpenJPAConfiguration
-
newMetaDataFactoryInstance
Description copied from interface:OpenJPAConfiguration
Create a newMetaDataFactory
to use with a repository.- Specified by:
newMetaDataFactoryInstance
in interfaceOpenJPAConfiguration
-
setMetaDataRepository
Description copied from interface:OpenJPAConfiguration
A plugin string describing theMetaDataRepository
to use.- Specified by:
setMetaDataRepository
in interfaceOpenJPAConfiguration
-
getMetaDataRepository
Description copied from interface:OpenJPAConfiguration
A plugin string describing theMetaDataRepository
to use.- Specified by:
getMetaDataRepository
in interfaceOpenJPAConfiguration
-
setMetaDataRepository
Description copied from interface:OpenJPAConfiguration
The metadata repository of managed class information.- Specified by:
setMetaDataRepository
in interfaceOpenJPAConfiguration
-
getMetaDataRepositoryInstance
Description copied from interface:OpenJPAConfiguration
The metadata repository of managed class information. If no repository has been set, creates one.- Specified by:
getMetaDataRepositoryInstance
in interfaceOpenJPAConfiguration
-
metaDataRepositoryAvailable
public boolean metaDataRepositoryAvailable()Description copied from interface:OpenJPAConfiguration
Returns true if a metaDataRepository has been created for this configuration.- Specified by:
metaDataRepositoryAvailable
in interfaceOpenJPAConfiguration
-
newMetaDataRepositoryInstance
Description copied from interface:OpenJPAConfiguration
Create a new empty metadata repository of the configured type.- Specified by:
newMetaDataRepositoryInstance
in interfaceOpenJPAConfiguration
-
setConnectionUserName
Description copied from interface:OpenJPAConfiguration
The user name for the data store connection.- Specified by:
setConnectionUserName
in interfaceOpenJPAConfiguration
-
getConnectionUserName
Description copied from interface:OpenJPAConfiguration
The user name for the data store connection.- Specified by:
getConnectionUserName
in interfaceOpenJPAConfiguration
-
setConnectionPassword
Description copied from interface:OpenJPAConfiguration
The password for the data store connection.- Specified by:
setConnectionPassword
in interfaceOpenJPAConfiguration
-
getConnectionPassword
Description copied from interface:OpenJPAConfiguration
The password for the data store connection.- Specified by:
getConnectionPassword
in interfaceOpenJPAConfiguration
-
setConnectionURL
Description copied from interface:OpenJPAConfiguration
The URL for the data store connection.- Specified by:
setConnectionURL
in interfaceOpenJPAConfiguration
-
getConnectionURL
Description copied from interface:OpenJPAConfiguration
The URL for the data store connection.- Specified by:
getConnectionURL
in interfaceOpenJPAConfiguration
-
setConnectionDriverName
Description copied from interface:OpenJPAConfiguration
Class name of the connection driver.- Specified by:
setConnectionDriverName
in interfaceOpenJPAConfiguration
-
getConnectionDriverName
Description copied from interface:OpenJPAConfiguration
Class name of the connection driver.- Specified by:
getConnectionDriverName
in interfaceOpenJPAConfiguration
-
setConnectionProperties
Description copied from interface:OpenJPAConfiguration
These properties provide any additional information needed to establish connections.- Specified by:
setConnectionProperties
in interfaceOpenJPAConfiguration
-
getConnectionProperties
Description copied from interface:OpenJPAConfiguration
These properties provide any additional information needed to establish connections.- Specified by:
getConnectionProperties
in interfaceOpenJPAConfiguration
-
setConnectionFactoryProperties
Description copied from interface:OpenJPAConfiguration
Configuration properties for the connection factory.- Specified by:
setConnectionFactoryProperties
in interfaceOpenJPAConfiguration
-
getConnectionFactoryProperties
Description copied from interface:OpenJPAConfiguration
Configuration properties for the connection factory.- Specified by:
getConnectionFactoryProperties
in interfaceOpenJPAConfiguration
-
getConnectionFactoryMode
Description copied from interface:OpenJPAConfiguration
The mode of the connection factory in use. Available options are:- local: OpenJPA controls the connections.
- managed: Connections are automatically enlisted in the current global transaction by an application server.
- Specified by:
getConnectionFactoryMode
in interfaceOpenJPAConfiguration
-
setConnectionFactoryMode
Description copied from interface:OpenJPAConfiguration
The mode of the connection factory in use. Available options are:- local: OpenJPA controls the connections.
- managed: Connections are automatically enlisted in the current global transaction by an application server.
- Specified by:
setConnectionFactoryMode
in interfaceOpenJPAConfiguration
-
isConnectionFactoryModeManaged
public boolean isConnectionFactoryModeManaged()Description copied from interface:OpenJPAConfiguration
Whether connections are automatically enlisted in global transactions.- Specified by:
isConnectionFactoryModeManaged
in interfaceOpenJPAConfiguration
-
setConnectionFactoryModeManaged
public void setConnectionFactoryModeManaged(boolean managed) Description copied from interface:OpenJPAConfiguration
Whether connections are automatically enlisted in global transactions.- Specified by:
setConnectionFactoryModeManaged
in interfaceOpenJPAConfiguration
-
setConnectionFactoryName
Description copied from interface:OpenJPAConfiguration
The name for the data store connection factory.- Specified by:
setConnectionFactoryName
in interfaceOpenJPAConfiguration
-
getConnectionFactoryName
Description copied from interface:OpenJPAConfiguration
The name for the data store connection factory.- Specified by:
getConnectionFactoryName
in interfaceOpenJPAConfiguration
-
setConnectionFactory
Description copied from interface:OpenJPAConfiguration
The connection factory.- Specified by:
setConnectionFactory
in interfaceOpenJPAConfiguration
-
getConnectionFactory
Description copied from interface:OpenJPAConfiguration
The connection factory, possibly from JNDI.- Specified by:
getConnectionFactory
in interfaceOpenJPAConfiguration
-
setConnection2UserName
Description copied from interface:OpenJPAConfiguration
The user name for the non-XA data store connection.- Specified by:
setConnection2UserName
in interfaceOpenJPAConfiguration
-
getConnection2UserName
Description copied from interface:OpenJPAConfiguration
The user name for the non-XA data store connection.- Specified by:
getConnection2UserName
in interfaceOpenJPAConfiguration
-
setConnection2Password
Description copied from interface:OpenJPAConfiguration
The password for the non-XA data store connection.- Specified by:
setConnection2Password
in interfaceOpenJPAConfiguration
-
getConnection2Password
Description copied from interface:OpenJPAConfiguration
The password for the non-XA data store connection.- Specified by:
getConnection2Password
in interfaceOpenJPAConfiguration
-
setConnection2URL
Description copied from interface:OpenJPAConfiguration
The URL for the non-XA data store connection.- Specified by:
setConnection2URL
in interfaceOpenJPAConfiguration
-
getConnection2URL
Description copied from interface:OpenJPAConfiguration
The URL for the non-XA data store connection.- Specified by:
getConnection2URL
in interfaceOpenJPAConfiguration
-
setConnection2DriverName
Description copied from interface:OpenJPAConfiguration
Class name of the non-XA connection driver.- Specified by:
setConnection2DriverName
in interfaceOpenJPAConfiguration
-
getConnection2DriverName
Description copied from interface:OpenJPAConfiguration
Class name of the non-XA connection driver.- Specified by:
getConnection2DriverName
in interfaceOpenJPAConfiguration
-
setConnection2Properties
Description copied from interface:OpenJPAConfiguration
These properties provide any additional information needed to establish non-XA connections.- Specified by:
setConnection2Properties
in interfaceOpenJPAConfiguration
-
getConnection2Properties
Description copied from interface:OpenJPAConfiguration
These properties provide any additional information needed to establish non-XA connections.- Specified by:
getConnection2Properties
in interfaceOpenJPAConfiguration
-
setConnectionFactory2Properties
Description copied from interface:OpenJPAConfiguration
Configuration properties for the non-XA connection factory.- Specified by:
setConnectionFactory2Properties
in interfaceOpenJPAConfiguration
-
getConnectionFactory2Properties
Description copied from interface:OpenJPAConfiguration
Configuration properties for the non-XA connection factory.- Specified by:
getConnectionFactory2Properties
in interfaceOpenJPAConfiguration
-
setConnectionFactory2Name
Description copied from interface:OpenJPAConfiguration
The name for the second data store connection factory.- Specified by:
setConnectionFactory2Name
in interfaceOpenJPAConfiguration
-
getConnectionFactory2Name
Description copied from interface:OpenJPAConfiguration
The name for the second data store connection factory.- Specified by:
getConnectionFactory2Name
in interfaceOpenJPAConfiguration
-
setConnectionFactory2
Description copied from interface:OpenJPAConfiguration
The non-XA connection factory.- Specified by:
setConnectionFactory2
in interfaceOpenJPAConfiguration
-
getConnectionFactory2
Description copied from interface:OpenJPAConfiguration
The non-XA connection factory.- Specified by:
getConnectionFactory2
in interfaceOpenJPAConfiguration
-
setOptimistic
public void setOptimistic(boolean optimistic) Description copied from interface:OpenJPAConfiguration
Whether to use optimistic transactions by default.- Specified by:
setOptimistic
in interfaceOpenJPAConfiguration
-
setOptimistic
Description copied from interface:OpenJPAConfiguration
Wrapper for JCA usage ofOpenJPAConfiguration.setOptimistic(boolean)
.- Specified by:
setOptimistic
in interfaceOpenJPAConfiguration
-
getOptimistic
public boolean getOptimistic()Description copied from interface:OpenJPAConfiguration
Whether to use optimistic transactions by default.- Specified by:
getOptimistic
in interfaceOpenJPAConfiguration
-
setAutoClear
Description copied from interface:OpenJPAConfiguration
Whether instances clear their state when entering a transaction.- Specified by:
setAutoClear
in interfaceOpenJPAConfiguration
-
getAutoClear
Description copied from interface:OpenJPAConfiguration
Whether instances clear their state when entering a transaction.- Specified by:
getAutoClear
in interfaceOpenJPAConfiguration
-
setAutoClear
public void setAutoClear(int clear) Description copied from interface:OpenJPAConfiguration
Whether instances clear their state when entering a transaction.- Specified by:
setAutoClear
in interfaceOpenJPAConfiguration
-
getAutoClearConstant
public int getAutoClearConstant()Description copied from interface:OpenJPAConfiguration
Return theAutoClear
constant.- Specified by:
getAutoClearConstant
in interfaceOpenJPAConfiguration
-
setRetainState
public void setRetainState(boolean retainState) Description copied from interface:OpenJPAConfiguration
Whether to retain state after a transaction by default.- Specified by:
setRetainState
in interfaceOpenJPAConfiguration
-
setRetainState
Description copied from interface:OpenJPAConfiguration
Wrapper for JCA usage ofOpenJPAConfiguration.setRetainState(boolean)
.- Specified by:
setRetainState
in interfaceOpenJPAConfiguration
-
getRetainState
public boolean getRetainState()Description copied from interface:OpenJPAConfiguration
Whether to retain state after a transaction by default.- Specified by:
getRetainState
in interfaceOpenJPAConfiguration
-
setRestoreState
Description copied from interface:OpenJPAConfiguration
Whether to restore initial state on rollback by default.- Specified by:
setRestoreState
in interfaceOpenJPAConfiguration
-
getRestoreState
Description copied from interface:OpenJPAConfiguration
Whether to restore initial state on rollback by default.- Specified by:
getRestoreState
in interfaceOpenJPAConfiguration
-
setRestoreState
public void setRestoreState(int restoreState) Description copied from interface:OpenJPAConfiguration
Whether to restore initial state on rollback by default.- Specified by:
setRestoreState
in interfaceOpenJPAConfiguration
-
getRestoreStateConstant
public int getRestoreStateConstant()Description copied from interface:OpenJPAConfiguration
Return theRestoreState
constant.- Specified by:
getRestoreStateConstant
in interfaceOpenJPAConfiguration
-
setAutoDetach
Description copied from interface:OpenJPAConfiguration
A comma-separated list of events which trigger auto-detachment in place of managed states. Possible values are:commit
: When the current transaction commits.close
: When the broker closes.nontx-read
: When instances are read non-transactionally.
- Specified by:
setAutoDetach
in interfaceOpenJPAConfiguration
-
getAutoDetach
Description copied from interface:OpenJPAConfiguration
A comma-separated list of events which trigger auto-detachment in place of managed states. Possible values are:commit
: When the current transaction commits.close
: When the broker closes.nontx-read
: When instances are read non-transactionally.
- Specified by:
getAutoDetach
in interfaceOpenJPAConfiguration
-
setAutoDetach
public void setAutoDetach(int autoDetachFlags) Description copied from interface:OpenJPAConfiguration
TheAutoDetach
flags.- Specified by:
setAutoDetach
in interfaceOpenJPAConfiguration
-
getAutoDetachConstant
public int getAutoDetachConstant()Description copied from interface:OpenJPAConfiguration
TheAutoDetach
flags.- Specified by:
getAutoDetachConstant
in interfaceOpenJPAConfiguration
-
setDetachState
Description copied from interface:OpenJPAConfiguration
Which field values to include when detaching.- Specified by:
setDetachState
in interfaceOpenJPAConfiguration
-
getDetachState
-
setDetachState
Description copied from interface:OpenJPAConfiguration
Return the instance specified by the detach state plugin.- Specified by:
setDetachState
in interfaceOpenJPAConfiguration
-
getDetachStateInstance
Description copied from interface:OpenJPAConfiguration
Return the instance specified by the detach state plugin.- Specified by:
getDetachStateInstance
in interfaceOpenJPAConfiguration
-
setIgnoreChanges
public void setIgnoreChanges(boolean ignoreChanges) Description copied from interface:OpenJPAConfiguration
Whether changes in the current transaction are taken into account when executing queries and iterating extents.- Specified by:
setIgnoreChanges
in interfaceOpenJPAConfiguration
-
setIgnoreChanges
Description copied from interface:OpenJPAConfiguration
Wrapper for JCA usage ofOpenJPAConfiguration.setIgnoreChanges(boolean)
.- Specified by:
setIgnoreChanges
in interfaceOpenJPAConfiguration
-
getIgnoreChanges
public boolean getIgnoreChanges()Description copied from interface:OpenJPAConfiguration
Whether changes in the current transaction are taken into account when executing queries and iterating extents.- Specified by:
getIgnoreChanges
in interfaceOpenJPAConfiguration
-
setNontransactionalRead
public void setNontransactionalRead(boolean nontransactionalRead) Description copied from interface:OpenJPAConfiguration
Whether persistent state is accessible outside a transaction by default.- Specified by:
setNontransactionalRead
in interfaceOpenJPAConfiguration
-
setNontransactionalRead
Description copied from interface:OpenJPAConfiguration
Wrapper for JCA usage ofOpenJPAConfiguration.setNontransactionalRead(boolean)
.- Specified by:
setNontransactionalRead
in interfaceOpenJPAConfiguration
-
getNontransactionalRead
public boolean getNontransactionalRead()Description copied from interface:OpenJPAConfiguration
Whether persistent state is accessible outside a transaction by default.- Specified by:
getNontransactionalRead
in interfaceOpenJPAConfiguration
-
setNontransactionalWrite
public void setNontransactionalWrite(boolean nontransactionalWrite) Description copied from interface:OpenJPAConfiguration
Whether persistent state can be modified outside a transaction by default.- Specified by:
setNontransactionalWrite
in interfaceOpenJPAConfiguration
-
setNontransactionalWrite
Description copied from interface:OpenJPAConfiguration
Wrapper for JCA usage ofOpenJPAConfiguration.setNontransactionalWrite(boolean)
.- Specified by:
setNontransactionalWrite
in interfaceOpenJPAConfiguration
-
getNontransactionalWrite
public boolean getNontransactionalWrite()Description copied from interface:OpenJPAConfiguration
Whether persistent state can be modified outside a transaction by default.- Specified by:
getNontransactionalWrite
in interfaceOpenJPAConfiguration
-
setMultithreaded
public void setMultithreaded(boolean multithreaded) Description copied from interface:OpenJPAConfiguration
Whether brokers or their managed objects will be used by multiple concurrent threads.- Specified by:
setMultithreaded
in interfaceOpenJPAConfiguration
-
setMultithreaded
Description copied from interface:OpenJPAConfiguration
Wrapper for JCA usage ofOpenJPAConfiguration.setMultithreaded(boolean)
.- Specified by:
setMultithreaded
in interfaceOpenJPAConfiguration
-
getMultithreaded
public boolean getMultithreaded()Description copied from interface:OpenJPAConfiguration
Whether brokers or their managed objects will be used by multiple concurrent threads.- Specified by:
getMultithreaded
in interfaceOpenJPAConfiguration
-
setFetchBatchSize
public void setFetchBatchSize(int fetchBatchSize) Description copied from interface:OpenJPAConfiguration
Set the size of the batch that will be pre-selected when accessing elements in a query or relationship. Use -1 to prefetch all results.- Specified by:
setFetchBatchSize
in interfaceOpenJPAConfiguration
-
setFetchBatchSize
Description copied from interface:OpenJPAConfiguration
Wrapper for JCA usage ofOpenJPAConfiguration.setFetchBatchSize(int)
.- Specified by:
setFetchBatchSize
in interfaceOpenJPAConfiguration
-
getFetchBatchSize
public int getFetchBatchSize()Description copied from interface:OpenJPAConfiguration
Get the size of the batch that will be pre-selected when accessing elements in a query or relationship. Use -1 to prefetch all results.- Specified by:
getFetchBatchSize
in interfaceOpenJPAConfiguration
-
setMaxFetchDepth
public void setMaxFetchDepth(int maxFetchDepth) Description copied from interface:OpenJPAConfiguration
The maximum relation depth to traverse when eager fetching. Use -1 for no limit.- Specified by:
setMaxFetchDepth
in interfaceOpenJPAConfiguration
-
setMaxFetchDepth
Description copied from interface:OpenJPAConfiguration
Wrapper for JCA usage ofOpenJPAConfiguration.setMaxFetchDepth(int)
.- Specified by:
setMaxFetchDepth
in interfaceOpenJPAConfiguration
-
getMaxFetchDepth
public int getMaxFetchDepth()Description copied from interface:OpenJPAConfiguration
The maximum relation depth to traverse when eager fetching. Use -1 for no limit.- Specified by:
getMaxFetchDepth
in interfaceOpenJPAConfiguration
-
setFetchGroups
Description copied from interface:OpenJPAConfiguration
Comma-separated list of fetch group names that will be pre-set for all newFetchConfiguration
s.- Specified by:
setFetchGroups
in interfaceOpenJPAConfiguration
-
getFetchGroups
Description copied from interface:OpenJPAConfiguration
Comma-separated list of fetch group names that will be pre-set for all newFetchConfiguration
s.- Specified by:
getFetchGroups
in interfaceOpenJPAConfiguration
-
getFetchGroupsList
Description copied from interface:OpenJPAConfiguration
List of fetch group names that will be pre-set for all newFetchConfiguration
s.- Specified by:
getFetchGroupsList
in interfaceOpenJPAConfiguration
-
setFetchGroups
Description copied from interface:OpenJPAConfiguration
List of fetch group names that will be pre-set for all newFetchConfiguration
s.- Specified by:
setFetchGroups
in interfaceOpenJPAConfiguration
-
setFlushBeforeQueries
Description copied from interface:OpenJPAConfiguration
Sets whether or not OpenJPA should automatically flush modifications to the data store before executing queries.- Specified by:
setFlushBeforeQueries
in interfaceOpenJPAConfiguration
-
getFlushBeforeQueries
Description copied from interface:OpenJPAConfiguration
Returns whether or not OpenJPA should automatically flush modifications to the data store before executing queries.- Specified by:
getFlushBeforeQueries
in interfaceOpenJPAConfiguration
-
setFlushBeforeQueries
public void setFlushBeforeQueries(int flush) Description copied from interface:OpenJPAConfiguration
Set to one ofQueryFlushModes.FLUSH_TRUE
,QueryFlushModes.FLUSH_FALSE
, orQueryFlushModes.FLUSH_WITH_CONNECTION
.- Specified by:
setFlushBeforeQueries
in interfaceOpenJPAConfiguration
-
getFlushBeforeQueriesConstant
public int getFlushBeforeQueriesConstant()Description copied from interface:OpenJPAConfiguration
Returns one ofQueryFlushModes.FLUSH_TRUE
,QueryFlushModes.FLUSH_FALSE
, orQueryFlushModes.FLUSH_WITH_CONNECTION
, as determined by parsing the string returned byOpenJPAConfiguration.getFlushBeforeQueries()
.- Specified by:
getFlushBeforeQueriesConstant
in interfaceOpenJPAConfiguration
-
setLockTimeout
public void setLockTimeout(int timeout) Description copied from interface:OpenJPAConfiguration
The time to wait for an object lock in milliseconds, or -1 for no timeout.- Specified by:
setLockTimeout
in interfaceOpenJPAConfiguration
-
setLockTimeout
Description copied from interface:OpenJPAConfiguration
Wrapper for JCA usage ofOpenJPAConfiguration.setLockTimeout(int)
.- Specified by:
setLockTimeout
in interfaceOpenJPAConfiguration
-
getLockTimeout
public int getLockTimeout()Description copied from interface:OpenJPAConfiguration
The time to wait for an object lock in milliseconds, or -1 for no timeout.- Specified by:
getLockTimeout
in interfaceOpenJPAConfiguration
-
getQueryTimeout
public int getQueryTimeout()Description copied from interface:OpenJPAConfiguration
The time to wait for a query to execute in milliseconds, or -1 for no timeout.- Specified by:
getQueryTimeout
in interfaceOpenJPAConfiguration
-
setQueryTimeout
public void setQueryTimeout(int timeout) Description copied from interface:OpenJPAConfiguration
The time to wait for a query to execute in milliseconds, or -1 for no timeout.- Specified by:
setQueryTimeout
in interfaceOpenJPAConfiguration
-
setReadLockLevel
Description copied from interface:OpenJPAConfiguration
The default read lock level to use during non-optimistic transactions. Defaults toread
.- Specified by:
setReadLockLevel
in interfaceOpenJPAConfiguration
-
getReadLockLevel
Description copied from interface:OpenJPAConfiguration
The default read lock level to use during non-optimistic transactions. Defaults toread
.- Specified by:
getReadLockLevel
in interfaceOpenJPAConfiguration
-
setReadLockLevel
public void setReadLockLevel(int level) Description copied from interface:OpenJPAConfiguration
The numeric read lock level.- Specified by:
setReadLockLevel
in interfaceOpenJPAConfiguration
-
getReadLockLevelConstant
public int getReadLockLevelConstant()Description copied from interface:OpenJPAConfiguration
The numeric read lock level.- Specified by:
getReadLockLevelConstant
in interfaceOpenJPAConfiguration
-
setWriteLockLevel
Description copied from interface:OpenJPAConfiguration
The default write lock level to use during non-optimistic transactions. Defaults towrite
.- Specified by:
setWriteLockLevel
in interfaceOpenJPAConfiguration
-
getWriteLockLevel
Description copied from interface:OpenJPAConfiguration
The default write lock level to use during non-optimistic transactions. Defaults towrite
.- Specified by:
getWriteLockLevel
in interfaceOpenJPAConfiguration
-
setWriteLockLevel
public void setWriteLockLevel(int level) Description copied from interface:OpenJPAConfiguration
The numeric write lock level.- Specified by:
setWriteLockLevel
in interfaceOpenJPAConfiguration
-
getWriteLockLevelConstant
public int getWriteLockLevelConstant()Description copied from interface:OpenJPAConfiguration
The numeric write lock level.- Specified by:
getWriteLockLevelConstant
in interfaceOpenJPAConfiguration
-
setSequence
Description copied from interface:OpenJPAConfiguration
Plugin string for the default systemSeq
.- Specified by:
setSequence
in interfaceOpenJPAConfiguration
-
getSequence
Description copied from interface:OpenJPAConfiguration
Plugin string for the default systemSeq
.- Specified by:
getSequence
in interfaceOpenJPAConfiguration
-
setSequence
Description copied from interface:OpenJPAConfiguration
The default system sequence.- Specified by:
setSequence
in interfaceOpenJPAConfiguration
-
getSequenceInstance
Description copied from interface:OpenJPAConfiguration
The default system sequence.- Specified by:
getSequenceInstance
in interfaceOpenJPAConfiguration
-
setConnectionRetainMode
Description copied from interface:OpenJPAConfiguration
Specifies the behavior of the broker with respect to data store connections. Possible values are:always
: Each broker obtains a single connection and uses it until the broker is closed.transaction
: A connection is obtained when each transaction begins (optimistic or datastore), and is released when the transaction completes.on-demand
: Connections are obtained only when needed. This is the default mode. It is equivalent to the previous option when datastore transactions are used. For optimistic transactions, though, it means that a connection will be retained only for the duration of the data store commit process.
- Specified by:
setConnectionRetainMode
in interfaceOpenJPAConfiguration
-
getConnectionRetainMode
Description copied from interface:OpenJPAConfiguration
Specifies the behavior of the broker with respect to data store connections. Possible values are:always
: Each broker obtains a single connection and uses it until the broker is closed.transaction
: A connection is obtained when each transaction begins (optimistic or datastore), and is released when the transaction completes.on-demand
: Connections are obtained only when needed. This is the default mode. It is equivalent to the previous option when datastore transactions are used. For optimistic transactions, though, it means that a connection will be retained only for the duration of the data store commit process.
- Specified by:
getConnectionRetainMode
in interfaceOpenJPAConfiguration
-
setConnectionRetainMode
public void setConnectionRetainMode(int connectionRetainMode) Description copied from interface:OpenJPAConfiguration
Set the connection retain mode as one of the following symbolic constants:- Specified by:
setConnectionRetainMode
in interfaceOpenJPAConfiguration
-
getConnectionRetainModeConstant
public int getConnectionRetainModeConstant()Description copied from interface:OpenJPAConfiguration
Return the connection retain mode as one of the following symbolic constants:- Specified by:
getConnectionRetainModeConstant
in interfaceOpenJPAConfiguration
-
setFilterListeners
Description copied from interface:OpenJPAConfiguration
A comma-separted list of the plugin strings of the queryFilterListener
s to use.- Specified by:
setFilterListeners
in interfaceOpenJPAConfiguration
-
getFilterListeners
Description copied from interface:OpenJPAConfiguration
A comma-separted list of the plugin strings of the queryFilterListener
s to use.- Specified by:
getFilterListeners
in interfaceOpenJPAConfiguration
-
setFilterListeners
Description copied from interface:OpenJPAConfiguration
Set the query filter listeners. Overrides the list of listener classes.- Specified by:
setFilterListeners
in interfaceOpenJPAConfiguration
-
getFilterListenerInstances
Description copied from interface:OpenJPAConfiguration
Return the query filter listeners. If none have been set explicitly, this method instantiates the listeners from the set plugin list.- Specified by:
getFilterListenerInstances
in interfaceOpenJPAConfiguration
-
setAggregateListeners
Description copied from interface:OpenJPAConfiguration
A comma-separted list of the plugin strings of the queryAggregateListener
s to use.- Specified by:
setAggregateListeners
in interfaceOpenJPAConfiguration
-
getAggregateListeners
Description copied from interface:OpenJPAConfiguration
A comma-separted list of the plugin strings of the queryAggregateListener
s to use.- Specified by:
getAggregateListeners
in interfaceOpenJPAConfiguration
-
setAggregateListeners
Description copied from interface:OpenJPAConfiguration
Set the query function listeners. Overrides the list of listener classes.- Specified by:
setAggregateListeners
in interfaceOpenJPAConfiguration
-
getAggregateListenerInstances
Description copied from interface:OpenJPAConfiguration
Return the query function listeners. If none have been set explicitly, this method instantiates the listeners from the set plugin list.- Specified by:
getAggregateListenerInstances
in interfaceOpenJPAConfiguration
-
setRetryClassRegistration
public void setRetryClassRegistration(boolean retry) Description copied from interface:OpenJPAConfiguration
Whether to warn and defer registration instead of throwing an exception when a registered persistent class cannot be processed. Should only be set to true in complex classloader topologies. Defaults tofalse
.- Specified by:
setRetryClassRegistration
in interfaceOpenJPAConfiguration
-
setRetryClassRegistration
Description copied from interface:OpenJPAConfiguration
Wrapper for JCA usage ofOpenJPAConfiguration.setRetryClassRegistration(boolean)
.- Specified by:
setRetryClassRegistration
in interfaceOpenJPAConfiguration
-
getRetryClassRegistration
public boolean getRetryClassRegistration()Description copied from interface:OpenJPAConfiguration
Whether to warn and defer registration instead of throwing an exception when a registered persistent class cannot be processed. Should only be set to true in complex classloader topologies. Defaults tofalse
.- Specified by:
getRetryClassRegistration
in interfaceOpenJPAConfiguration
-
getCompatibility
Description copied from interface:OpenJPAConfiguration
Backwards compatibility options.- Specified by:
getCompatibility
in interfaceOpenJPAConfiguration
-
setCompatibility
Description copied from interface:OpenJPAConfiguration
Backwards compatibility options.- Specified by:
setCompatibility
in interfaceOpenJPAConfiguration
-
getCompatibilityInstance
If a Compatibility instance is associated with the Specification, we will configure this Compatibility instance instead of instantiating a new one so that the compatibility flags set in compliance with the Specification can be preserved.- Specified by:
getCompatibilityInstance
in interfaceOpenJPAConfiguration
-
getCallbackOptions
Description copied from interface:OpenJPAConfiguration
Options for configuring callbacks as a String.- Specified by:
getCallbackOptions
in interfaceOpenJPAConfiguration
-
setCallbackOptions
Description copied from interface:OpenJPAConfiguration
Options for configuring callbacks set as a comma-separated string value pair.- Specified by:
setCallbackOptions
in interfaceOpenJPAConfiguration
-
getCallbackOptionsInstance
Description copied from interface:OpenJPAConfiguration
Options for configuring callbacks.- Specified by:
getCallbackOptionsInstance
in interfaceOpenJPAConfiguration
-
getQueryCompilationCache
Description copied from interface:OpenJPAConfiguration
Configuration settings for the query compilation cache to use.- Specified by:
getQueryCompilationCache
in interfaceOpenJPAConfiguration
- See Also:
-
setQueryCompilationCache
Description copied from interface:OpenJPAConfiguration
Configuration settings for the query compilation cache to use.- Specified by:
setQueryCompilationCache
in interfaceOpenJPAConfiguration
- See Also:
-
getQueryCompilationCacheInstance
Description copied from interface:OpenJPAConfiguration
Configuration settings for the query compilation cache to use.- Specified by:
getQueryCompilationCacheInstance
in interfaceOpenJPAConfiguration
- See Also:
-
getStoreFacadeTypeRegistry
Description copied from interface:OpenJPAConfiguration
Return theStoreFacadeTypeRegistry
instance associated with this configuration.- Specified by:
getStoreFacadeTypeRegistry
in interfaceOpenJPAConfiguration
-
getBrokerFactoryEventManager
Description copied from interface:OpenJPAConfiguration
Return theBrokerFactoryEventManager
associated with this configuration.- Specified by:
getBrokerFactoryEventManager
in interfaceOpenJPAConfiguration
-
getRuntimeUnenhancedClasses
Description copied from interface:OpenJPAConfiguration
Specifies how OpenJPA handles unenhanced types. Possible values are:supported
: Runtime optimization of persistent types is available. This is the defaultunsupported
: Runtime optimization of persistent types is not available. An exception will be thrown if the system loads with persistent types that are not enhanced.warn
: Runtime optimization of persistent types is not available, but no exception will be thrown initially. A warning will be logged instead. It is likely that the system will fail at a later point. This might be suitable for environments with complex classloader configurations.
- Specified by:
getRuntimeUnenhancedClasses
in interfaceOpenJPAConfiguration
-
getRuntimeUnenhancedClassesConstant
public int getRuntimeUnenhancedClassesConstant()Description copied from interface:OpenJPAConfiguration
Return the runtime class optimization setting as one of the following symbolic constants:- Specified by:
getRuntimeUnenhancedClassesConstant
in interfaceOpenJPAConfiguration
-
setRuntimeUnenhancedClasses
public void setRuntimeUnenhancedClasses(int mode) Description copied from interface:OpenJPAConfiguration
Set the runtime class optimization setting as one of the following symbolic constants:- Specified by:
setRuntimeUnenhancedClasses
in interfaceOpenJPAConfiguration
-
setRuntimeUnenhancedClasses
Description copied from interface:OpenJPAConfiguration
Specifies how OpenJPA handles unenhanced types.- Specified by:
setRuntimeUnenhancedClasses
in interfaceOpenJPAConfiguration
-
getCacheMarshallers
Description copied from interface:OpenJPAConfiguration
A comma-separted list of the plugin strings specifying theCacheMarshaller
s to use.- Specified by:
getCacheMarshallers
in interfaceOpenJPAConfiguration
-
setCacheMarshallers
Description copied from interface:OpenJPAConfiguration
A comma-separated list of the plugin strings specifying theCacheMarshaller
s to use.- Specified by:
setCacheMarshallers
in interfaceOpenJPAConfiguration
-
getCacheMarshallerInstances
Description copied from interface:OpenJPAConfiguration
Return the cache marshaller listeners.- Specified by:
getCacheMarshallerInstances
in interfaceOpenJPAConfiguration
-
isInitializeEagerly
public boolean isInitializeEagerly()Description copied from interface:OpenJPAConfiguration
Affirms if all configured elements are initialized eagerly as opposed to lazily on-demand.- Specified by:
isInitializeEagerly
in interfaceOpenJPAConfiguration
-
setInitializeEagerly
public void setInitializeEagerly(boolean retry) Description copied from interface:OpenJPAConfiguration
Sets whether all configured elements will be initialized eagerly or lazily on-demand.- Specified by:
setInitializeEagerly
in interfaceOpenJPAConfiguration
-
setValidationMode
Description copied from interface:OpenJPAConfiguration
Set the bean validation mode to use for managed classes. If not set, defaults toAUTO
.- Specified by:
setValidationMode
in interfaceOpenJPAConfiguration
-
getValidationMode
Description copied from interface:OpenJPAConfiguration
The bean validation mode to use for managed classes. Defaults toAUTO
.- Specified by:
getValidationMode
in interfaceOpenJPAConfiguration
-
setValidationGroupPrePersist
Description copied from interface:OpenJPAConfiguration
Sets the validation groups for pre-persist- Specified by:
setValidationGroupPrePersist
in interfaceOpenJPAConfiguration
-
getValidationGroupPrePersist
Description copied from interface:OpenJPAConfiguration
Gets the validation groups for pre-persist- Specified by:
getValidationGroupPrePersist
in interfaceOpenJPAConfiguration
-
setValidationGroupPreUpdate
Description copied from interface:OpenJPAConfiguration
Sets the validation groups for pre-update- Specified by:
setValidationGroupPreUpdate
in interfaceOpenJPAConfiguration
-
getValidationGroupPreUpdate
Description copied from interface:OpenJPAConfiguration
Gets the validation groups for pre-update- Specified by:
getValidationGroupPreUpdate
in interfaceOpenJPAConfiguration
-
setValidationGroupPreRemove
Description copied from interface:OpenJPAConfiguration
Sets the validation groups for pre-remove- Specified by:
setValidationGroupPreRemove
in interfaceOpenJPAConfiguration
-
getValidationGroupPreRemove
Description copied from interface:OpenJPAConfiguration
Gets the validation groups for pre-remove- Specified by:
getValidationGroupPreRemove
in interfaceOpenJPAConfiguration
-
getInstrumentation
Description copied from interface:OpenJPAConfiguration
Gets the plug-in string that defines instrumentation providers and what they instrument.- Specified by:
getInstrumentation
in interfaceOpenJPAConfiguration
- Returns:
- a plug-in string for the instrumentation configuration
-
setInstrumentation
Description copied from interface:OpenJPAConfiguration
Sets the plug-in string that defines instrumentation providers and what they instrument.- Specified by:
setInstrumentation
in interfaceOpenJPAConfiguration
- Parameters:
providers
- a plug-in string for the instrumentation configuration
-
getInstrumentationInstances
-
setInstrumentationManager
-
getInstrumentationManager
-
setInstrumentationManager
-
getInstrumentationManagerInstance
Description copied from interface:OpenJPAConfiguration
Gets an instance of the instrumentation manager. The instrumentation provides access to configured instrumentation providers and can be used to manage them at runtime.- Specified by:
getInstrumentationManagerInstance
in interfaceOpenJPAConfiguration
- Returns:
- an instance of the instrumentation manager
-
instantiateAll
public void instantiateAll()Description copied from interface:Configuration
Call the instantiating get methods for all values. Up-front instantiation allows one to avoid the synchronization necessary with lazy instantiation.- Specified by:
instantiateAll
in interfaceConfiguration
- Overrides:
instantiateAll
in classConfigurationImpl
-
preClose
protected void preClose()Description copied from class:ConfigurationImpl
Invoked by final methodConfigurationImpl.close()
after invoking theProductDerivation.beforeConfigurationClose(org.apache.openjpa.lib.conf.Configuration)
callbacks but before performing internal close operations.- Overrides:
preClose
in classConfigurationImpl
-
getConfigurationLog
Description copied from class:ConfigurationImpl
Returns the logging channelopenjpa.Runtime
by default.- Specified by:
getConfigurationLog
in interfaceConfiguration
- Overrides:
getConfigurationLog
in classConfigurationImpl
-
setQuerySQLCache
Description copied from interface:OpenJPAConfiguration
Sets QuerySQLCache with the given configuration.- Specified by:
setQuerySQLCache
in interfaceOpenJPAConfiguration
-
setQuerySQLCache
Description copied from interface:OpenJPAConfiguration
Sets QuerySQLCache with the given cache.- Specified by:
setQuerySQLCache
in interfaceOpenJPAConfiguration
-
getQuerySQLCache
Description copied from interface:OpenJPAConfiguration
Gets the configuration of QuerySQLCache.- Specified by:
getQuerySQLCache
in interfaceOpenJPAConfiguration
-
getQuerySQLCacheInstance
Description copied from interface:OpenJPAConfiguration
Return PreparedQueryCache used for caching datastore queries.- Specified by:
getQuerySQLCacheInstance
in interfaceOpenJPAConfiguration
-
setFinderCache
Description copied from interface:OpenJPAConfiguration
Set the finder cache from a string configuration.- Specified by:
setFinderCache
in interfaceOpenJPAConfiguration
-
getFinderCache
Description copied from interface:OpenJPAConfiguration
Get the string configuration of the finder cache.- Specified by:
getFinderCache
in interfaceOpenJPAConfiguration
-
getFinderCacheInstance
Description copied from interface:OpenJPAConfiguration
Get the cache of finder queries.- Specified by:
getFinderCacheInstance
in interfaceOpenJPAConfiguration
-
getValidationFactoryInstance
Description copied from interface:OpenJPAConfiguration
The ValidatorFactory provided by the container or application. Defaults tonull
.- Specified by:
getValidationFactoryInstance
in interfaceOpenJPAConfiguration
-
setValidationFactory
Description copied from interface:OpenJPAConfiguration
Set the container or application provided ValidatorFactory instance. If not set, defaults tonull
.- Specified by:
setValidationFactory
in interfaceOpenJPAConfiguration
-
getValidatorInstance
Description copied from interface:OpenJPAConfiguration
The Validator provided by the container or created by the runtime. Defaults tonull
.- Specified by:
getValidatorInstance
in interfaceOpenJPAConfiguration
-
setValidatorInstance
Description copied from interface:OpenJPAConfiguration
Set the container or application provided Validator instance. If not set, defaults tonull
.- Specified by:
setValidatorInstance
in interfaceOpenJPAConfiguration
-
getLifecycleEventManager
Description copied from interface:OpenJPAConfiguration
Gets the lifecycle event manager instance classname.- Specified by:
getLifecycleEventManager
in interfaceOpenJPAConfiguration
-
getLifecycleEventManagerInstance
Description copied from interface:OpenJPAConfiguration
Gets the lifecycle event manager instance.- Specified by:
getLifecycleEventManagerInstance
in interfaceOpenJPAConfiguration
-
setLifecycleEventManager
Description copied from interface:OpenJPAConfiguration
Sets the lifecycle event manager instance classname.- Specified by:
setLifecycleEventManager
in interfaceOpenJPAConfiguration
-
getDynamicEnhancementAgent
public boolean getDynamicEnhancementAgent()Description copied from interface:OpenJPAConfiguration
Whether OpenJPA will attempt to dynamically load the enhancement agent.- Specified by:
getDynamicEnhancementAgent
in interfaceOpenJPAConfiguration
-
setDynamicEnhancementAgent
public void setDynamicEnhancementAgent(boolean dynamic) Description copied from interface:OpenJPAConfiguration
Sets whether OpenJPA will attempt to dynamically load the enhancement agent.- Specified by:
setDynamicEnhancementAgent
in interfaceOpenJPAConfiguration
-
setEncryptionProvider
Description copied from interface:OpenJPAConfiguration
Sets theEncryptionProvider
.- Specified by:
setEncryptionProvider
in interfaceOpenJPAConfiguration
-
getEncryptionProvider
Description copied from interface:OpenJPAConfiguration
Gets theEncryptionProvider
.- Specified by:
getEncryptionProvider
in interfaceOpenJPAConfiguration
- Returns:
- EncryptionProvider
-
setDataCacheMode
Description copied from interface:OpenJPAConfiguration
Set theDataCacheMode
- Specified by:
setDataCacheMode
in interfaceOpenJPAConfiguration
- Parameters:
mode
- One of the Sting constants fromDataCacheMode
-
getDataCacheMode
Description copied from interface:OpenJPAConfiguration
Return the String constant that matches theDataCacheMode
- Specified by:
getDataCacheMode
in interfaceOpenJPAConfiguration
- Returns:
- DataCacheMode
-
getCacheDistributionPolicy
Description copied from interface:OpenJPAConfiguration
Gets the plug-in string that described the policy to distribute cached instances across named partitions of L2 data cache.- Specified by:
getCacheDistributionPolicy
in interfaceOpenJPAConfiguration
- Returns:
- a plug-in string for
CacheDistributionPolicy
.
-
getCacheDistributionPolicyInstance
Description copied from interface:OpenJPAConfiguration
Gets the policy object that determines distribution of cached instances across named partitions of L2 data cache.- Specified by:
getCacheDistributionPolicyInstance
in interfaceOpenJPAConfiguration
- Returns:
- an implementation of
CacheDistributionPolicy
.
-
setCacheDistributionPolicy
Description copied from interface:OpenJPAConfiguration
Sets the plug-in string that describes the policy to distribute cached instances across named partitions of L2 data cache.- Specified by:
setCacheDistributionPolicy
in interfaceOpenJPAConfiguration
-
setCacheDistributionPolicyInstance
Description copied from interface:OpenJPAConfiguration
Sets the policy object that determines distribution of cached instances across named partitions of L2 data cache.- Specified by:
setCacheDistributionPolicyInstance
in interfaceOpenJPAConfiguration
- Parameters:
policy
- a non-null implementation ofCacheDistributionPolicy
.
-
setPersistenceEnvironment
-
getPersistenceEnvironment
-
getAuditorInstance
Description copied from interface:OpenJPAConfiguration
Gets the singular instance ofAuditor
associated with this configuration.- Specified by:
getAuditorInstance
in interfaceOpenJPAConfiguration
-
setAuditorInstance
Description copied from interface:OpenJPAConfiguration
Sets the singular instance ofAuditor
associated with this configuration.- Specified by:
setAuditorInstance
in interfaceOpenJPAConfiguration
-
getAuditor
Description copied from interface:OpenJPAConfiguration
Gets the plug-in string ofAuditor
specified in this configuration.- Specified by:
getAuditor
in interfaceOpenJPAConfiguration
-
setAuditor
Description copied from interface:OpenJPAConfiguration
Sets the plug-in string ofAuditor
specified in this configuration.- Specified by:
setAuditor
in interfaceOpenJPAConfiguration
-
getPostLoadOnMerge
public boolean getPostLoadOnMerge()Description copied from interface:OpenJPAConfiguration
Whether to send @PostLoad events on a merge operation.- Specified by:
getPostLoadOnMerge
in interfaceOpenJPAConfiguration
-
setPostLoadOnMerge
public void setPostLoadOnMerge(boolean postLoadOnMerge) Description copied from interface:OpenJPAConfiguration
Whether to send @PostLoad events on a merge operation.- Specified by:
setPostLoadOnMerge
in interfaceOpenJPAConfiguration
-
setPostLoadOnMerge
Description copied from interface:OpenJPAConfiguration
Whether to send @PostLoad events on a merge operation.- Specified by:
setPostLoadOnMerge
in interfaceOpenJPAConfiguration
-
getOptimizeIdCopy
public boolean getOptimizeIdCopy()Description copied from interface:OpenJPAConfiguration
Whether to attempt to optimize id class copy operations during the enhancement process. Optimization is only applicable for simple id classes that have a constructor with the proper construction parameters and direct assignments to fields within the id class during construction. If the optimization cannot occur, the enhancer will fallback to the noraml behavior.- Specified by:
getOptimizeIdCopy
in interfaceOpenJPAConfiguration
-
setOptimizeIdCopy
public void setOptimizeIdCopy(boolean optimizeId) Description copied from interface:OpenJPAConfiguration
Whether to attempt to optimize id class copy operations during the enhancement process. Optimization is only applicable for simple id classes that have a constructor with the proper construction parameters and direct assignments to fields within the id class during construction. If the optimization cannot occur, the enhancer will fallback to the normal behavior.- Specified by:
setOptimizeIdCopy
in interfaceOpenJPAConfiguration
-
setOptimizeIdCopy
Description copied from interface:OpenJPAConfiguration
Whether to attempt to optimize id class copy operations during the enhancement process. Optimization is only applicable for simple id classes that have a constructor with the proper construction parameters and direct assignments to fields within the id class during construction. If the optimization cannot occur, the enhancer will fallback to the normal behavior.- Specified by:
setOptimizeIdCopy
in interfaceOpenJPAConfiguration
-
getDatabaseAction
Description copied from interface:OpenJPAConfiguration
database action from the persistence unit. See 'jakarta.persistence.schema-generation.database.action'- Specified by:
getDatabaseAction
in interfaceOpenJPAConfiguration
- Returns:
- openjpa internal schemaAction which corresponds to the JPA action.
-
getDatabaseActionConstant
public int getDatabaseActionConstant()- Specified by:
getDatabaseActionConstant
in interfaceOpenJPAConfiguration
- See Also:
-
getScriptsAction
Description copied from interface:OpenJPAConfiguration
Similar toOpenJPAConfiguration.getDatabaseAction()
but write the generated SQL to files.- Specified by:
getScriptsAction
in interfaceOpenJPAConfiguration
- See Also:
-
getScriptsActionConstant
public int getScriptsActionConstant()- Specified by:
getScriptsActionConstant
in interfaceOpenJPAConfiguration
- See Also:
-
getCreateSource
Description copied from interface:OpenJPAConfiguration
Optional run a DB action before accessing the database. The possible values in the persistence unit are:- metadata
- script - see
OpenJPAConfiguration.getCreateScriptSource()
- metadata-then-script
- script-then-metadata
- Specified by:
getCreateSource
in interfaceOpenJPAConfiguration
- See Also:
-
getCreateSourceConstant
public int getCreateSourceConstant()- Specified by:
getCreateSourceConstant
in interfaceOpenJPAConfiguration
- See Also:
-
getDropSource
Description copied from interface:OpenJPAConfiguration
Similar toOpenJPAConfiguration.getCreateSource()
but for dropping the database schema and content.- Specified by:
getDropSource
in interfaceOpenJPAConfiguration
- See Also:
-
getDropSourceConstant
public int getDropSourceConstant()- Specified by:
getDropSourceConstant
in interfaceOpenJPAConfiguration
- See Also:
-
getCreateScriptSource
- Specified by:
getCreateScriptSource
in interfaceOpenJPAConfiguration
- See Also:
-
getDropScriptSource
- Specified by:
getDropScriptSource
in interfaceOpenJPAConfiguration
- See Also:
-
getCreateScriptTarget
- Specified by:
getCreateScriptTarget
in interfaceOpenJPAConfiguration
- See Also:
-
getDropScriptTarget
- Specified by:
getDropScriptTarget
in interfaceOpenJPAConfiguration
- See Also:
-
getLoadScriptSource
Description copied from interface:OpenJPAConfiguration
Can be used to load a set of initial data into the database.- Specified by:
getLoadScriptSource
in interfaceOpenJPAConfiguration
-
getUseTCCLinSelectNew
public boolean getUseTCCLinSelectNew()Description copied from interface:OpenJPAConfiguration
Indicates if theThread#contextClassLoader
should be used as fallback if the result class forselect new
is not found by the classloader of the entity.- Specified by:
getUseTCCLinSelectNew
in interfaceOpenJPAConfiguration
-
setUseTCCLinSelectNew
public void setUseTCCLinSelectNew(boolean useTcclForSelectNew) Description copied from interface:OpenJPAConfiguration
Indicates if theThread#contextClassLoader
should be used as fallback if the result class forselect new
is not found by the classloader of the entity.- Specified by:
setUseTCCLinSelectNew
in interfaceOpenJPAConfiguration
-
setUseTCCLinSelectNew
Description copied from interface:OpenJPAConfiguration
Indicates if theThread#contextClassLoader
should be used as fallback if the result class forselect new
is not found by the classloader of the entity.- Specified by:
setUseTCCLinSelectNew
in interfaceOpenJPAConfiguration
-
getTypesWithoutEnhancement
- Specified by:
getTypesWithoutEnhancement
in interfaceOpenJPAConfiguration
- Returns:
- types which should not get enhanced although they are on the included directories.
-
setTypesWithoutEnhancement
- Specified by:
setTypesWithoutEnhancement
in interfaceOpenJPAConfiguration
- See Also:
-