Package org.apache.openjpa.conf
Class OpenJPAConfigurationImpl
- java.lang.Object
-
- org.apache.openjpa.lib.conf.ConfigurationImpl
-
- org.apache.openjpa.conf.OpenJPAConfigurationImpl
-
- All Implemented Interfaces:
java.beans.BeanInfo
,java.io.Externalizable
,java.io.Serializable
,java.lang.Cloneable
,OpenJPAConfiguration
,Configuration
,ValueListener
,Closeable
- Direct Known Subclasses:
JDBCConfigurationImpl
,XMLConfiguration
public class OpenJPAConfigurationImpl extends ConfigurationImpl implements OpenJPAConfiguration
Implementation of theOpenJPAConfiguration
interface.- Author:
- Marc Prud'hommeaux, Abe White
- See Also:
ConfigurationImpl
, Serialized Form
-
-
Field Summary
-
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
Constructors Constructor Description OpenJPAConfigurationImpl()
Default constructor.OpenJPAConfigurationImpl(boolean loadGlobals)
Constructor.OpenJPAConfigurationImpl(boolean derivations, boolean loadGlobals)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AggregateListener[]
getAggregateListenerInstances()
Return the query function listeners.java.lang.String
getAggregateListeners()
A comma-separted list of the plugin strings of the queryAggregateListener
s to use.java.lang.String
getAuditor()
Gets the plug-in string ofAuditor
specified in this configuration.Auditor
getAuditorInstance()
Gets the singular instance ofAuditor
associated with this configuration.java.lang.String
getAutoClear()
Whether instances clear their state when entering a transaction.int
getAutoClearConstant()
Return theAutoClear
constant.java.lang.String
getAutoDetach()
A comma-separated list of events which trigger auto-detachment in place of managed states.int
getAutoDetachConstant()
TheAutoDetach
flags.java.lang.String
getBrokerFactory()
TheBrokerFactory
class to use.BrokerFactoryEventManager
getBrokerFactoryEventManager()
Return theBrokerFactoryEventManager
associated with this configuration.java.lang.String
getBrokerImpl()
The plugin string of theBrokerImpl
extension to create.java.lang.String
getCacheDistributionPolicy()
Gets the plug-in string that described the policy to distribute cached instances across named partitions of L2 data cache.CacheDistributionPolicy
getCacheDistributionPolicyInstance()
Gets the policy object that determines distribution of cached instances across named partitions of L2 data cache.java.util.Map
getCacheMarshallerInstances()
Return the cache marshaller listeners.java.lang.String
getCacheMarshallers()
A comma-separted list of the plugin strings specifying theCacheMarshaller
s to use.java.lang.String
getCallbackOptions()
Options for configuring callbacks as a String.CallbackOptions
getCallbackOptionsInstance()
Options for configuring callbacks.java.lang.String
getClassResolver()
The plugin string for theClassResolver
to use for custom class loading.ClassResolver
getClassResolverInstance()
TheClassResolver
to use.java.lang.String
getCompatibility()
Backwards compatibility options.Compatibility
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.Log
getConfigurationLog()
Returns the logging channelopenjpa.Runtime
by default.java.lang.String
getConnection2DriverName()
Class name of the non-XA connection driver.java.lang.String
getConnection2Password()
The password for the non-XA data store connection.java.lang.String
getConnection2Properties()
These properties provide any additional information needed to establish non-XA connections.java.lang.String
getConnection2URL()
The URL for the non-XA data store connection.java.lang.String
getConnection2UserName()
The user name for the non-XA data store connection.java.lang.String
getConnectionDriverName()
Class name of the connection driver.java.lang.Object
getConnectionFactory()
The connection factory, possibly from JNDI.java.lang.Object
getConnectionFactory2()
The non-XA connection factory.java.lang.String
getConnectionFactory2Name()
The name for the second data store connection factory.java.lang.String
getConnectionFactory2Properties()
Configuration properties for the non-XA connection factory.java.lang.String
getConnectionFactoryMode()
The mode of the connection factory in use.java.lang.String
getConnectionFactoryName()
The name for the data store connection factory.java.lang.String
getConnectionFactoryProperties()
Configuration properties for the connection factory.java.lang.String
getConnectionPassword()
The password for the data store connection.java.lang.String
getConnectionProperties()
These properties provide any additional information needed to establish connections.java.lang.String
getConnectionRetainMode()
Specifies the behavior of the broker with respect to data store connections.int
getConnectionRetainModeConstant()
Return the connection retain mode as one of the following symbolic constants:ConnectionRetainModes.CONN_RETAIN_ALWAYS
ConnectionRetainModes.CONN_RETAIN_TRANS
ConnectionRetainModes.CONN_RETAIN_DEMAND
java.lang.String
getConnectionURL()
The URL for the data store connection.java.lang.String
getConnectionUserName()
The user name for the data store connection.java.lang.String
getCreateScriptSource()
java.lang.String
getCreateScriptTarget()
java.lang.String
getCreateSource()
Optional run a DB action before accessing the database.int
getCreateSourceConstant()
java.lang.String
getDatabaseAction()
database action from the persistence unit.int
getDatabaseActionConstant()
java.lang.String
getDataCache()
TheDataCache
to use for level-2 data store caching.java.lang.String
getDataCacheManager()
The data cache manager manages this configuration's cache instances.DataCacheManager
getDataCacheManagerInstance()
The data cache manager manages this configuration's cache instances.java.lang.String
getDataCacheMode()
Return the String constant that matches theDataCacheMode
int
getDataCacheTimeout()
Default data cache timeout.java.lang.String
getDetachState()
DetachOptions
getDetachStateInstance()
Return the instance specified by the detach state plugin.java.lang.String
getDropScriptSource()
java.lang.String
getDropScriptTarget()
java.lang.String
getDropSource()
Similar toOpenJPAConfiguration.getCreateSource()
but for dropping the database schema and content.int
getDropSourceConstant()
boolean
getDynamicDataStructs()
Return whether to generate dynamic data structures where possible for cache and runtime usage.boolean
getDynamicEnhancementAgent()
Whether OpenJPA will attempt to dynamically load the enhancement agent.EncryptionProvider
getEncryptionProvider()
Gets theEncryptionProvider
.int
getFetchBatchSize()
Get the size of the batch that will be pre-selected when accessing elements in a query or relationship.java.lang.String
getFetchGroups()
Comma-separated list of fetch group names that will be pre-set for all newFetchConfiguration
s.java.lang.String[]
getFetchGroupsList()
List of fetch group names that will be pre-set for all newFetchConfiguration
s.FilterListener[]
getFilterListenerInstances()
Return the query filter listeners.java.lang.String
getFilterListeners()
A comma-separted list of the plugin strings of the queryFilterListener
s to use.java.lang.String
getFinderCache()
Get the string configuration of the finder cache.FinderCache
getFinderCacheInstance()
Get the cache of finder queries.java.lang.String
getFlushBeforeQueries()
Returns whether or not OpenJPA should automatically flush modifications to the data store before executing queries.int
getFlushBeforeQueriesConstant()
Returns one ofQueryFlushModes.FLUSH_TRUE
,QueryFlushModes.FLUSH_FALSE
, orQueryFlushModes.FLUSH_WITH_CONNECTION
, as determined by parsing the string returned byOpenJPAConfiguration.getFlushBeforeQueries()
.boolean
getIgnoreChanges()
Whether changes in the current transaction are taken into account when executing queries and iterating extents.java.lang.String
getInstrumentation()
Gets the plug-in string that defines instrumentation providers and what they instrument.InstrumentationProvider[]
getInstrumentationInstances()
java.lang.String
getInstrumentationManager()
InstrumentationManager
getInstrumentationManagerInstance()
Gets an instance of the instrumentation manager.java.lang.String
getInverseManager()
The plugin to use for managing inverse relations.java.lang.String
getLifecycleEventManager()
Gets the lifecycle event manager instance classname.LifecycleEventManager
getLifecycleEventManagerInstance()
Gets the lifecycle event manager instance.java.lang.String
getLoadScriptSource()
Can be used to load a set of initial data into the database.java.lang.String
getLockManager()
The plugin to use for datastore lock management.int
getLockTimeout()
The time to wait for an object lock in milliseconds, or -1 for no timeout.java.lang.String
getManagedRuntime()
The plugin string for theManagedRuntime
to use for managed environments.ManagedRuntime
getManagedRuntimeInstance()
The plugin to use for integrating with a managed runtime.java.lang.String
getMapping()
The name mapping to use for this data store.int
getMaxFetchDepth()
The maximum relation depth to traverse when eager fetching.java.lang.String
getMetaDataFactory()
A plugin string describing theMetaDataFactory
to use.java.lang.String
getMetaDataRepository()
A plugin string describing theMetaDataRepository
to use.MetaDataRepository
getMetaDataRepositoryInstance()
The metadata repository of managed class information.boolean
getMultithreaded()
Whether brokers or their managed objects will be used by multiple concurrent threads.boolean
getNontransactionalRead()
Whether persistent state is accessible outside a transaction by default.boolean
getNontransactionalWrite()
Whether persistent state can be modified outside a transaction by default.boolean
getOptimistic()
Whether to use optimistic transactions by default.boolean
getOptimizeIdCopy()
Whether to attempt to optimize id class copy operations during the enhancement process.java.lang.String
getOrphanedKeyAction()
The action to take when an orphaned key is detected.OrphanedKeyAction
getOrphanedKeyActionInstance()
The action to take when an orphaned key is detected.java.util.Map<java.lang.String,java.lang.Object>
getPersistenceEnvironment()
boolean
getPostLoadOnMerge()
Whether to send @PostLoad events on a merge operation.java.lang.String
getProxyManager()
The plugin string for theProxyManager
to use for second class object proxies.ProxyManager
getProxyManagerInstance()
TheProxyManager
to use.java.lang.String
getQueryCache()
The plugin to use for level-2 data store query caching.java.lang.String
getQueryCompilationCache()
Configuration settings for the query compilation cache to use.java.util.Map
getQueryCompilationCacheInstance()
Configuration settings for the query compilation cache to use.java.lang.String
getQuerySQLCache()
Gets the configuration of QuerySQLCache.PreparedQueryCache
getQuerySQLCacheInstance()
Return PreparedQueryCache used for caching datastore queries.int
getQueryTimeout()
The time to wait for a query to execute in milliseconds, or -1 for no timeout.java.lang.String
getReadLockLevel()
The default read lock level to use during non-optimistic transactions.int
getReadLockLevelConstant()
The numeric read lock level.boolean
getRefreshFromDataCache()
Gets whether entity state is to be refreshed fromDataCache
.RemoteCommitEventManager
getRemoteCommitEventManager()
The remote event manager that manages this configuration's remote event listeners.java.lang.String
getRemoteCommitProvider()
The plugin to use for remote commit notification.java.lang.String
getRestoreState()
Whether to restore initial state on rollback by default.int
getRestoreStateConstant()
Return theRestoreState
constant.boolean
getRetainState()
Whether to retain state after a transaction by default.boolean
getRetryClassRegistration()
Whether to warn and defer registration instead of throwing an exception when a registered persistent class cannot be processed.java.lang.String
getRuntimeUnenhancedClasses()
Specifies how OpenJPA handles unenhanced types.int
getRuntimeUnenhancedClassesConstant()
Return the runtime class optimization setting as one of the following symbolic constants:RuntimeUnenhancedClassesModes.SUPPORTED
RuntimeUnenhancedClassesModes.UNSUPPORTED
RuntimeUnenhancedClassesModes.WARN
java.lang.String
getSavepointManager()
The plugin to use for savepoint management.SavepointManager
getSavepointManagerInstance()
Return the configured savepoint manager instance.java.lang.String
getScriptsAction()
Similar toOpenJPAConfiguration.getDatabaseAction()
but write the generated SQL to files.int
getScriptsActionConstant()
java.lang.String
getSequence()
Plugin string for the default systemSeq
.Seq
getSequenceInstance()
The default system sequence.java.lang.String
getSpecification()
Get the name of the Specification only (not the version or other information) or an empty String if not set.Specification
getSpecificationInstance()
Get the Specification.StoreFacadeTypeRegistry
getStoreFacadeTypeRegistry()
Return theStoreFacadeTypeRegistry
instance associated with this configuration.java.lang.String
getTransactionMode()
Specifies the behavior of the transaction model.java.util.Collection<java.lang.Class<?>>
getTypesWithoutEnhancement()
boolean
getUseTCCLinSelectNew()
Indicates if theThread.contextClassLoader
should be used as fallback if the result class forselect new
is not found by the classloader of the entity.java.lang.Object
getValidationFactoryInstance()
The ValidatorFactory provided by the container or application.java.lang.String
getValidationGroupPrePersist()
Gets the validation groups for pre-persistjava.lang.String
getValidationGroupPreRemove()
Gets the validation groups for pre-removejava.lang.String
getValidationGroupPreUpdate()
Gets the validation groups for pre-updatejava.lang.String
getValidationMode()
The bean validation mode to use for managed classes.java.lang.Object
getValidatorInstance()
The Validator provided by the container or created by the runtime.java.lang.String
getWriteLockLevel()
The default write lock level to use during non-optimistic transactions.int
getWriteLockLevelConstant()
The numeric write lock level.void
instantiateAll()
Call the instantiating get methods for all values.boolean
isConnectionFactoryModeManaged()
Whether connections are automatically enlisted in global transactions.boolean
isInitializeEagerly()
Affirms if all configured elements are initialized eagerly as opposed to lazily on-demand.boolean
isTransactionModeManaged()
Return whether managed transactions are being used.boolean
metaDataRepositoryAvailable()
Returns true if a metaDataRepository has been created for this configuration.BrokerImpl
newBrokerInstance(java.lang.String user, java.lang.String pass)
Create a new broker instance with the configured plugin data.InverseManager
newInverseManagerInstance()
Return a new inverse manager instance using the configured plugin settings.LockManager
newLockManagerInstance()
Return a new lock manager instance using the configured plugin settings.MetaDataFactory
newMetaDataFactoryInstance()
Create a newMetaDataFactory
to use with a repository.MetaDataRepository
newMetaDataRepositoryInstance()
Create a new empty metadata repository of the configured type.RemoteCommitProvider
newRemoteCommitProviderInstance()
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(java.lang.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(java.lang.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(java.lang.String clear)
Whether instances clear their state when entering a transaction.void
setAutoDetach(int autoDetachFlags)
TheAutoDetach
flags.void
setAutoDetach(java.lang.String autoDetach)
A comma-separated list of events which trigger auto-detachment in place of managed states.void
setBrokerFactory(java.lang.String factory)
TheBrokerFactory
class to use.void
setBrokerImpl(java.lang.String broker)
The plugin string of theBrokerImpl
extension to create.void
setCacheDistributionPolicy(java.lang.String policyPlugin)
Sets the plug-in string that describes the policy to distribute cached instances across named partitions of L2 data cache.void
setCacheDistributionPolicyInstance(CacheDistributionPolicy policy)
Sets the policy object that determines distribution of cached instances across named partitions of L2 data cache.void
setCacheMarshallers(java.lang.String marshallers)
A comma-separated list of the plugin strings specifying theCacheMarshaller
s to use.void
setCallbackOptions(java.lang.String options)
Options for configuring callbacks set as a comma-separated string value pair.void
setClassResolver(java.lang.String classResolver)
The plugin string for theClassResolver
to use for custom class loading.void
setClassResolver(ClassResolver classResolver)
TheClassResolver
to use.void
setCompatibility(java.lang.String compatibility)
Backwards compatibility options.void
setConnection2DriverName(java.lang.String driverName)
Class name of the non-XA connection driver.void
setConnection2Password(java.lang.String connection2Password)
The password for the non-XA data store connection.void
setConnection2Properties(java.lang.String connection2Properties)
These properties provide any additional information needed to establish non-XA connections.void
setConnection2URL(java.lang.String connection2URL)
The URL for the non-XA data store connection.void
setConnection2UserName(java.lang.String connection2UserName)
The user name for the non-XA data store connection.void
setConnectionDriverName(java.lang.String driverName)
Class name of the connection driver.void
setConnectionFactory(java.lang.Object factory)
The connection factory.void
setConnectionFactory2(java.lang.Object factory)
The non-XA connection factory.void
setConnectionFactory2Name(java.lang.String connectionFactory2Name)
The name for the second data store connection factory.void
setConnectionFactory2Properties(java.lang.String connectionFactory2Properties)
Configuration properties for the non-XA connection factory.void
setConnectionFactoryMode(java.lang.String mode)
The mode of the connection factory in use.void
setConnectionFactoryModeManaged(boolean managed)
Whether connections are automatically enlisted in global transactions.void
setConnectionFactoryName(java.lang.String connectionFactoryName)
The name for the data store connection factory.void
setConnectionFactoryProperties(java.lang.String connectionFactoryProperties)
Configuration properties for the connection factory.void
setConnectionPassword(java.lang.String connectionPassword)
The password for the data store connection.void
setConnectionProperties(java.lang.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(java.lang.String connectionRetainMode)
Specifies the behavior of the broker with respect to data store connections.void
setConnectionURL(java.lang.String connectionURL)
The URL for the data store connection.void
setConnectionUserName(java.lang.String connectionUserName)
The user name for the data store connection.void
setDataCache(java.lang.String dataCache)
TheDataCache
to use for level-2 data store caching.void
setDataCacheManager(java.lang.String mgr)
The data cache manager manages this configuration's cache instances.void
setDataCacheManager(DataCacheManager dcm)
The data cache manager manages this configuration's cache instances.void
setDataCacheMode(java.lang.String mode)
Set theDataCacheMode
void
setDataCacheTimeout(int dataCacheTimeout)
Default data cache timeout.void
setDataCacheTimeout(java.lang.Integer dataCacheTimeout)
Wrapper for JCA usage ofOpenJPAConfiguration.setDataCacheTimeout(int)
.void
setDetachState(java.lang.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(java.lang.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
setEncryptionProvider(java.lang.String p)
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(java.lang.Integer fetchBatchSize)
Wrapper for JCA usage ofOpenJPAConfiguration.setFetchBatchSize(int)
.void
setFetchGroups(java.lang.String fetchGroups)
Comma-separated list of fetch group names that will be pre-set for all newFetchConfiguration
s.void
setFetchGroups(java.lang.String[] fetchGroups)
List of fetch group names that will be pre-set for all newFetchConfiguration
s.void
setFilterListeners(java.lang.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(java.lang.String finderCache)
Set the finder cache from a string configuration.void
setFlushBeforeQueries(int flush)
void
setFlushBeforeQueries(java.lang.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(java.lang.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(java.lang.String providers)
Sets the plug-in string that defines instrumentation providers and what they instrument.void
setInstrumentationManager(java.lang.String mgr)
void
setInstrumentationManager(InstrumentationManager im)
void
setInverseManager(java.lang.String inverseManager)
The plugin to use for managing inverse relations.void
setLifecycleEventManager(java.lang.String lem)
Sets the lifecycle event manager instance classname.void
setLockManager(java.lang.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(java.lang.Integer timeout)
Wrapper for JCA usage ofOpenJPAConfiguration.setLockTimeout(int)
.void
setManagedRuntime(java.lang.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(java.lang.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(java.lang.Integer maxFetchDepth)
Wrapper for JCA usage ofOpenJPAConfiguration.setMaxFetchDepth(int)
.void
setMetaDataFactory(java.lang.String meta)
A plugin string describing theMetaDataFactory
to use.void
setMetaDataRepository(java.lang.String meta)
A plugin string describing theMetaDataRepository
to use.void
setMetaDataRepository(MetaDataRepository meta)
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(java.lang.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(java.lang.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(java.lang.Boolean nontransactionalWrite)
Wrapper for JCA usage ofOpenJPAConfiguration.setNontransactionalWrite(boolean)
.void
setOptimistic(boolean optimistic)
Whether to use optimistic transactions by default.void
setOptimistic(java.lang.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(java.lang.Boolean optimizeId)
Whether to attempt to optimize id class copy operations during the enhancement process.void
setOrphanedKeyAction(java.lang.String action)
The action to take when an orphaned key is detected.void
setOrphanedKeyAction(OrphanedKeyAction action)
The action to take when an orphaned key is detected.void
setPersistenceEnvironment(java.util.Map<java.lang.String,java.lang.Object> peMap)
void
setPostLoadOnMerge(boolean postLoadOnMerge)
Whether to send @PostLoad events on a merge operation.void
setPostLoadOnMerge(java.lang.Boolean postLoadOnMerge)
Whether to send @PostLoad events on a merge operation.void
setProxyManager(java.lang.String proxyManager)
The plugin string for theProxyManager
to use for second class object proxies.void
setProxyManager(ProxyManager proxyManager)
TheProxyManager
to use.void
setQueryCache(java.lang.String queryCache)
The plugin to use for level-2 data store query caching.void
setQueryCompilationCache(java.lang.String queryCompilationCache)
Configuration settings for the query compilation cache to use.void
setQuerySQLCache(java.lang.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(java.lang.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
setRefreshFromDataCache(java.lang.Boolean flag)
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(java.lang.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(java.lang.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(java.lang.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(java.lang.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
setRuntimeUnenhancedClasses(java.lang.String mode)
Specifies how OpenJPA handles unenhanced types.void
setSavepointManager(java.lang.String savepointManager)
The plugin to use for savepoint management.void
setSequence(java.lang.String sequence)
Plugin string for the default systemSeq
.void
setSequence(Seq seq)
The default system sequence.void
setSpecification(java.lang.String spec)
Sets Specification from the given String.void
setSpecification(Specification newSpec)
Set the Specification for this configuration.void
setTransactionMode(java.lang.String transactionMode)
Specifies the behavior of the transaction model.void
setTransactionModeManaged(boolean managed)
Set whether managed transactions are being used.void
setTypesWithoutEnhancement(java.util.Collection<java.lang.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(java.lang.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(java.lang.Object factory)
Set the container or application provided ValidatorFactory instance.void
setValidationGroupPrePersist(java.lang.String vgPrePersist)
Sets the validation groups for pre-persistvoid
setValidationGroupPreRemove(java.lang.String vgPreRemove)
Sets the validation groups for pre-removevoid
setValidationGroupPreUpdate(java.lang.String vgPreUpdate)
Sets the validation groups for pre-updatevoid
setValidationMode(java.lang.String mode)
Set the bean validation mode to use for managed classes.void
setValidatorInstance(java.lang.Object val)
Set the container or application provided Validator instance.void
setWriteLockLevel(int level)
The numeric write lock level.void
setWriteLockLevel(java.lang.String level)
The default write lock level to use during non-optimistic transactions.java.util.Collection<java.lang.String>
supportedOptions()
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 Detail
-
metaRepository
protected MetaDataRepository metaRepository
-
remoteEventManager
protected RemoteCommitEventManager remoteEventManager
-
classResolverPlugin
public ObjectValue classResolverPlugin
-
brokerPlugin
public BrokerValue brokerPlugin
-
dataCachePlugin
public ObjectValue dataCachePlugin
-
dataCacheManagerPlugin
public ObjectValue dataCacheManagerPlugin
-
auditorPlugin
public ObjectValue auditorPlugin
-
cacheDistributionPolicyPlugin
public ObjectValue cacheDistributionPolicyPlugin
-
dataCacheTimeout
public IntValue dataCacheTimeout
-
queryCachePlugin
public ObjectValue queryCachePlugin
-
dynamicDataStructs
public BooleanValue dynamicDataStructs
-
managedRuntimePlugin
public ObjectValue managedRuntimePlugin
-
transactionMode
public BooleanValue transactionMode
-
connectionRetainMode
public IntValue connectionRetainMode
-
fetchBatchSize
public IntValue fetchBatchSize
-
maxFetchDepth
public IntValue maxFetchDepth
-
fetchGroups
public StringListValue fetchGroups
-
flushBeforeQueries
public IntValue flushBeforeQueries
-
lockTimeout
public IntValue lockTimeout
-
queryTimeout
public IntValue queryTimeout
-
readLockLevel
public IntValue readLockLevel
-
writeLockLevel
public IntValue writeLockLevel
-
seqPlugin
public ObjectValue seqPlugin
-
filterListenerPlugins
public PluginListValue filterListenerPlugins
-
aggregateListenerPlugins
public PluginListValue aggregateListenerPlugins
-
retryClassRegistration
public BooleanValue retryClassRegistration
-
proxyManagerPlugin
public ObjectValue proxyManagerPlugin
-
connectionUserName
public StringValue connectionUserName
-
connectionPassword
public StringValue connectionPassword
-
encryptionProvider
public PluginValue encryptionProvider
-
connectionURL
public StringValue connectionURL
-
connectionDriverName
public StringValue connectionDriverName
-
connectionFactory
public ObjectValue connectionFactory
-
connectionFactoryName
public StringValue connectionFactoryName
-
connectionProperties
public StringValue connectionProperties
-
connectionFactoryProperties
public StringValue connectionFactoryProperties
-
connectionFactoryMode
public BooleanValue connectionFactoryMode
-
connection2UserName
public StringValue connection2UserName
-
connection2Password
public StringValue connection2Password
-
connection2URL
public StringValue connection2URL
-
connection2DriverName
public StringValue connection2DriverName
-
connection2Properties
public StringValue connection2Properties
-
connectionFactory2
public ObjectValue connectionFactory2
-
connectionFactory2Name
public StringValue connectionFactory2Name
-
connectionFactory2Properties
public StringValue connectionFactory2Properties
-
optimistic
public BooleanValue optimistic
-
autoClear
public IntValue autoClear
-
retainState
public BooleanValue retainState
-
restoreState
public IntValue restoreState
-
detachStatePlugin
public ObjectValue detachStatePlugin
-
ignoreChanges
public BooleanValue ignoreChanges
-
nontransactionalRead
public BooleanValue nontransactionalRead
-
nontransactionalWrite
public BooleanValue nontransactionalWrite
-
refreshFromDataCache
public BooleanValue refreshFromDataCache
-
multithreaded
public BooleanValue multithreaded
-
mapping
public StringValue mapping
-
metaFactoryPlugin
public PluginValue metaFactoryPlugin
-
metaRepositoryPlugin
public MetaDataRepositoryValue metaRepositoryPlugin
-
lockManagerPlugin
public ObjectValue lockManagerPlugin
-
inverseManagerPlugin
public ObjectValue inverseManagerPlugin
-
savepointManagerPlugin
public ObjectValue savepointManagerPlugin
-
orphanedKeyPlugin
public ObjectValue orphanedKeyPlugin
-
compatibilityPlugin
public ObjectValue compatibilityPlugin
-
callbackPlugin
public ObjectValue callbackPlugin
-
queryCompilationCachePlugin
public QueryCompilationCacheValue queryCompilationCachePlugin
-
runtimeUnenhancedClasses
public IntValue runtimeUnenhancedClasses
-
cacheMarshallerPlugins
public CacheMarshallersValue cacheMarshallerPlugins
-
eagerInitialization
public BooleanValue eagerInitialization
-
preparedQueryCachePlugin
public PluginValue preparedQueryCachePlugin
-
finderCachePlugin
public PluginValue finderCachePlugin
-
specification
public ObjectValue specification
-
validationMode
public StringValue validationMode
-
validationFactory
public ObjectValue validationFactory
-
validator
public ObjectValue validator
-
lifecycleEventManager
public ObjectValue lifecycleEventManager
-
validationGroupPrePersist
public StringValue validationGroupPrePersist
-
validationGroupPreUpdate
public StringValue validationGroupPreUpdate
-
validationGroupPreRemove
public StringValue validationGroupPreRemove
-
dataCacheMode
public StringValue dataCacheMode
-
dynamicEnhancementAgent
public BooleanValue dynamicEnhancementAgent
-
instrumentationManager
public ObjectValue instrumentationManager
-
instrumentationProviders
public PluginListValue instrumentationProviders
-
postLoadOnMerge
public BooleanValue postLoadOnMerge
-
optimizeIdCopy
public BooleanValue optimizeIdCopy
-
useTcclForSelectNew
public BooleanValue useTcclForSelectNew
-
typesWithoutEnhancement
public ClassListValue typesWithoutEnhancement
-
databaseAction
public IntValue databaseAction
-
scriptsAction
public IntValue scriptsAction
-
createSource
public IntValue createSource
-
dropSource
public IntValue dropSource
-
createScriptSource
public StringValue createScriptSource
-
dropScriptSource
public StringValue dropScriptSource
-
createScriptTarget
public StringValue createScriptTarget
-
dropScriptTarget
public StringValue dropScriptTarget
-
loadScriptSource
public StringValue loadScriptSource
-
brokerFactoryPlugin
public BrokerFactoryValue brokerFactoryPlugin
-
remoteProviderPlugin
public RemoteCommitProviderValue remoteProviderPlugin
-
autoDetach
public org.apache.openjpa.conf.AutoDetachValue autoDetach
-
-
Constructor Detail
-
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 Detail
-
supportedOptions
public java.util.Collection<java.lang.String> 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
public java.lang.String 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
public Specification getSpecificationInstance()
Description copied from interface:OpenJPAConfiguration
Get the Specification. Specification determines various important default behaviors.- Specified by:
getSpecificationInstance
in interfaceOpenJPAConfiguration
-
setSpecification
public void setSpecification(java.lang.String spec)
Sets Specification from the given String.- Specified by:
setSpecification
in interfaceOpenJPAConfiguration
- Parameters:
spec
- should be encoded in the format specified inSpecification
.- See Also:
Specification
-
setSpecification
public void setSpecification(Specification newSpec)
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:
Specification
-
setClassResolver
public void setClassResolver(java.lang.String classResolver)
Description copied from interface:OpenJPAConfiguration
The plugin string for theClassResolver
to use for custom class loading.- Specified by:
setClassResolver
in interfaceOpenJPAConfiguration
-
getClassResolver
public java.lang.String getClassResolver()
Description copied from interface:OpenJPAConfiguration
The plugin string for theClassResolver
to use for custom class loading.- Specified by:
getClassResolver
in interfaceOpenJPAConfiguration
-
setClassResolver
public void setClassResolver(ClassResolver classResolver)
Description copied from interface:OpenJPAConfiguration
TheClassResolver
to use.- Specified by:
setClassResolver
in interfaceOpenJPAConfiguration
-
getClassResolverInstance
public ClassResolver getClassResolverInstance()
Description copied from interface:OpenJPAConfiguration
TheClassResolver
to use.- Specified by:
getClassResolverInstance
in interfaceOpenJPAConfiguration
-
setBrokerFactory
public void setBrokerFactory(java.lang.String factory)
Description copied from interface:OpenJPAConfiguration
TheBrokerFactory
class to use.- Specified by:
setBrokerFactory
in interfaceOpenJPAConfiguration
-
getBrokerFactory
public java.lang.String getBrokerFactory()
Description copied from interface:OpenJPAConfiguration
TheBrokerFactory
class to use.- Specified by:
getBrokerFactory
in interfaceOpenJPAConfiguration
-
setBrokerImpl
public void setBrokerImpl(java.lang.String broker)
Description copied from interface:OpenJPAConfiguration
The plugin string of theBrokerImpl
extension to create.- Specified by:
setBrokerImpl
in interfaceOpenJPAConfiguration
-
getBrokerImpl
public java.lang.String getBrokerImpl()
Description copied from interface:OpenJPAConfiguration
The plugin string of theBrokerImpl
extension to create.- Specified by:
getBrokerImpl
in interfaceOpenJPAConfiguration
-
newBrokerInstance
public BrokerImpl newBrokerInstance(java.lang.String user, java.lang.String pass)
Description copied from interface:OpenJPAConfiguration
Create a new broker instance with the configured plugin data.- Specified by:
newBrokerInstance
in interfaceOpenJPAConfiguration
-
setDataCacheManager
public void setDataCacheManager(java.lang.String mgr)
Description copied from interface:OpenJPAConfiguration
The data cache manager manages this configuration's cache instances.- Specified by:
setDataCacheManager
in interfaceOpenJPAConfiguration
-
getDataCacheManager
public java.lang.String getDataCacheManager()
Description copied from interface:OpenJPAConfiguration
The data cache manager manages this configuration's cache instances.- Specified by:
getDataCacheManager
in interfaceOpenJPAConfiguration
-
setDataCacheManager
public void setDataCacheManager(DataCacheManager dcm)
Description copied from interface:OpenJPAConfiguration
The data cache manager manages this configuration's cache instances.- Specified by:
setDataCacheManager
in interfaceOpenJPAConfiguration
-
getDataCacheManagerInstance
public DataCacheManager 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
public void setDataCache(java.lang.String dataCache)
Description copied from interface:OpenJPAConfiguration
TheDataCache
to use for level-2 data store caching.- Specified by:
setDataCache
in interfaceOpenJPAConfiguration
-
getDataCache
public java.lang.String 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
public void setDataCacheTimeout(java.lang.Integer dataCacheTimeout)
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
public void setQueryCache(java.lang.String queryCache)
Description copied from interface:OpenJPAConfiguration
The plugin to use for level-2 data store query caching.- Specified by:
setQueryCache
in interfaceOpenJPAConfiguration
-
getQueryCache
public java.lang.String 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
public void setRefreshFromDataCache(java.lang.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
-
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
public void setDynamicDataStructs(java.lang.Boolean dynamic)
Description copied from interface:OpenJPAConfiguration
Wrapper for JCA usage ofOpenJPAConfiguration.setDynamicDataStructs(boolean)
.- Specified by:
setDynamicDataStructs
in interfaceOpenJPAConfiguration
-
setLockManager
public void setLockManager(java.lang.String lockManager)
Description copied from interface:OpenJPAConfiguration
The plugin to use for datastore lock management.- Specified by:
setLockManager
in interfaceOpenJPAConfiguration
-
getLockManager
public java.lang.String getLockManager()
Description copied from interface:OpenJPAConfiguration
The plugin to use for datastore lock management.- Specified by:
getLockManager
in interfaceOpenJPAConfiguration
-
newLockManagerInstance
public LockManager newLockManagerInstance()
Description copied from interface:OpenJPAConfiguration
Return a new lock manager instance using the configured plugin settings.- Specified by:
newLockManagerInstance
in interfaceOpenJPAConfiguration
-
setInverseManager
public void setInverseManager(java.lang.String inverseManager)
Description copied from interface:OpenJPAConfiguration
The plugin to use for managing inverse relations.- Specified by:
setInverseManager
in interfaceOpenJPAConfiguration
-
getInverseManager
public java.lang.String getInverseManager()
Description copied from interface:OpenJPAConfiguration
The plugin to use for managing inverse relations.- Specified by:
getInverseManager
in interfaceOpenJPAConfiguration
-
newInverseManagerInstance
public InverseManager newInverseManagerInstance()
Description copied from interface:OpenJPAConfiguration
Return a new inverse manager instance using the configured plugin settings.- Specified by:
newInverseManagerInstance
in interfaceOpenJPAConfiguration
-
setSavepointManager
public void setSavepointManager(java.lang.String savepointManager)
Description copied from interface:OpenJPAConfiguration
The plugin to use for savepoint management.- Specified by:
setSavepointManager
in interfaceOpenJPAConfiguration
-
getSavepointManager
public java.lang.String getSavepointManager()
Description copied from interface:OpenJPAConfiguration
The plugin to use for savepoint management.- Specified by:
getSavepointManager
in interfaceOpenJPAConfiguration
-
getSavepointManagerInstance
public SavepointManager getSavepointManagerInstance()
Description copied from interface:OpenJPAConfiguration
Return the configured savepoint manager instance.- Specified by:
getSavepointManagerInstance
in interfaceOpenJPAConfiguration
-
setOrphanedKeyAction
public void setOrphanedKeyAction(java.lang.String action)
Description copied from interface:OpenJPAConfiguration
The action to take when an orphaned key is detected.- Specified by:
setOrphanedKeyAction
in interfaceOpenJPAConfiguration
-
getOrphanedKeyAction
public java.lang.String getOrphanedKeyAction()
Description copied from interface:OpenJPAConfiguration
The action to take when an orphaned key is detected.- Specified by:
getOrphanedKeyAction
in interfaceOpenJPAConfiguration
-
getOrphanedKeyActionInstance
public OrphanedKeyAction getOrphanedKeyActionInstance()
Description copied from interface:OpenJPAConfiguration
The action to take when an orphaned key is detected.- Specified by:
getOrphanedKeyActionInstance
in interfaceOpenJPAConfiguration
-
setOrphanedKeyAction
public void setOrphanedKeyAction(OrphanedKeyAction action)
Description copied from interface:OpenJPAConfiguration
The action to take when an orphaned key is detected.- Specified by:
setOrphanedKeyAction
in interfaceOpenJPAConfiguration
-
setRemoteCommitProvider
public void setRemoteCommitProvider(java.lang.String remoteCommitProvider)
Description copied from interface:OpenJPAConfiguration
The plugin to use for remote commit notification.- Specified by:
setRemoteCommitProvider
in interfaceOpenJPAConfiguration
-
getRemoteCommitProvider
public java.lang.String getRemoteCommitProvider()
Description copied from interface:OpenJPAConfiguration
The plugin to use for remote commit notification.- Specified by:
getRemoteCommitProvider
in interfaceOpenJPAConfiguration
-
newRemoteCommitProviderInstance
public RemoteCommitProvider newRemoteCommitProviderInstance()
Description copied from interface:OpenJPAConfiguration
Create a remote commit provider from the configured plugin.- Specified by:
newRemoteCommitProviderInstance
in interfaceOpenJPAConfiguration
-
setRemoteCommitEventManager
public void setRemoteCommitEventManager(RemoteCommitEventManager remoteEventManager)
Description copied from interface:OpenJPAConfiguration
The remote event manager that manages this configuration's remote event listeners.- Specified by:
setRemoteCommitEventManager
in interfaceOpenJPAConfiguration
-
getRemoteCommitEventManager
public RemoteCommitEventManager getRemoteCommitEventManager()
Description copied from interface:OpenJPAConfiguration
The remote event manager that manages this configuration's remote event listeners.- Specified by:
getRemoteCommitEventManager
in interfaceOpenJPAConfiguration
-
setTransactionMode
public void setTransactionMode(java.lang.String transactionMode)
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
public java.lang.String 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
public void setManagedRuntime(java.lang.String managedRuntime)
Description copied from interface:OpenJPAConfiguration
The plugin string for theManagedRuntime
to use for managed environments.- Specified by:
setManagedRuntime
in interfaceOpenJPAConfiguration
-
getManagedRuntime
public java.lang.String getManagedRuntime()
Description copied from interface:OpenJPAConfiguration
The plugin string for theManagedRuntime
to use for managed environments.- Specified by:
getManagedRuntime
in interfaceOpenJPAConfiguration
-
setManagedRuntime
public void setManagedRuntime(ManagedRuntime managedRuntime)
Description copied from interface:OpenJPAConfiguration
The plugin to use for integrating with a managed runtime.- Specified by:
setManagedRuntime
in interfaceOpenJPAConfiguration
-
getManagedRuntimeInstance
public ManagedRuntime getManagedRuntimeInstance()
Description copied from interface:OpenJPAConfiguration
The plugin to use for integrating with a managed runtime.- Specified by:
getManagedRuntimeInstance
in interfaceOpenJPAConfiguration
-
setProxyManager
public void setProxyManager(java.lang.String proxyManager)
Description copied from interface:OpenJPAConfiguration
The plugin string for theProxyManager
to use for second class object proxies.- Specified by:
setProxyManager
in interfaceOpenJPAConfiguration
-
getProxyManager
public java.lang.String getProxyManager()
Description copied from interface:OpenJPAConfiguration
The plugin string for theProxyManager
to use for second class object proxies.- Specified by:
getProxyManager
in interfaceOpenJPAConfiguration
-
setProxyManager
public void setProxyManager(ProxyManager proxyManager)
Description copied from interface:OpenJPAConfiguration
TheProxyManager
to use.- Specified by:
setProxyManager
in interfaceOpenJPAConfiguration
-
getProxyManagerInstance
public ProxyManager getProxyManagerInstance()
Description copied from interface:OpenJPAConfiguration
TheProxyManager
to use.- Specified by:
getProxyManagerInstance
in interfaceOpenJPAConfiguration
-
setMapping
public void setMapping(java.lang.String mapping)
Description copied from interface:OpenJPAConfiguration
The name mapping to use for this data store.- Specified by:
setMapping
in interfaceOpenJPAConfiguration
-
getMapping
public java.lang.String getMapping()
Description copied from interface:OpenJPAConfiguration
The name mapping to use for this data store.- Specified by:
getMapping
in interfaceOpenJPAConfiguration
-
setMetaDataFactory
public void setMetaDataFactory(java.lang.String meta)
Description copied from interface:OpenJPAConfiguration
A plugin string describing theMetaDataFactory
to use.- Specified by:
setMetaDataFactory
in interfaceOpenJPAConfiguration
-
getMetaDataFactory
public java.lang.String getMetaDataFactory()
Description copied from interface:OpenJPAConfiguration
A plugin string describing theMetaDataFactory
to use.- Specified by:
getMetaDataFactory
in interfaceOpenJPAConfiguration
-
newMetaDataFactoryInstance
public MetaDataFactory newMetaDataFactoryInstance()
Description copied from interface:OpenJPAConfiguration
Create a newMetaDataFactory
to use with a repository.- Specified by:
newMetaDataFactoryInstance
in interfaceOpenJPAConfiguration
-
setMetaDataRepository
public void setMetaDataRepository(java.lang.String meta)
Description copied from interface:OpenJPAConfiguration
A plugin string describing theMetaDataRepository
to use.- Specified by:
setMetaDataRepository
in interfaceOpenJPAConfiguration
-
getMetaDataRepository
public java.lang.String getMetaDataRepository()
Description copied from interface:OpenJPAConfiguration
A plugin string describing theMetaDataRepository
to use.- Specified by:
getMetaDataRepository
in interfaceOpenJPAConfiguration
-
setMetaDataRepository
public void setMetaDataRepository(MetaDataRepository meta)
Description copied from interface:OpenJPAConfiguration
The metadata repository of managed class information.- Specified by:
setMetaDataRepository
in interfaceOpenJPAConfiguration
-
getMetaDataRepositoryInstance
public MetaDataRepository 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
public MetaDataRepository newMetaDataRepositoryInstance()
Description copied from interface:OpenJPAConfiguration
Create a new empty metadata repository of the configured type.- Specified by:
newMetaDataRepositoryInstance
in interfaceOpenJPAConfiguration
-
setConnectionUserName
public void setConnectionUserName(java.lang.String connectionUserName)
Description copied from interface:OpenJPAConfiguration
The user name for the data store connection.- Specified by:
setConnectionUserName
in interfaceOpenJPAConfiguration
-
getConnectionUserName
public java.lang.String getConnectionUserName()
Description copied from interface:OpenJPAConfiguration
The user name for the data store connection.- Specified by:
getConnectionUserName
in interfaceOpenJPAConfiguration
-
setConnectionPassword
public void setConnectionPassword(java.lang.String connectionPassword)
Description copied from interface:OpenJPAConfiguration
The password for the data store connection.- Specified by:
setConnectionPassword
in interfaceOpenJPAConfiguration
-
getConnectionPassword
public java.lang.String getConnectionPassword()
Description copied from interface:OpenJPAConfiguration
The password for the data store connection.- Specified by:
getConnectionPassword
in interfaceOpenJPAConfiguration
-
setConnectionURL
public void setConnectionURL(java.lang.String connectionURL)
Description copied from interface:OpenJPAConfiguration
The URL for the data store connection.- Specified by:
setConnectionURL
in interfaceOpenJPAConfiguration
-
getConnectionURL
public java.lang.String getConnectionURL()
Description copied from interface:OpenJPAConfiguration
The URL for the data store connection.- Specified by:
getConnectionURL
in interfaceOpenJPAConfiguration
-
setConnectionDriverName
public void setConnectionDriverName(java.lang.String driverName)
Description copied from interface:OpenJPAConfiguration
Class name of the connection driver.- Specified by:
setConnectionDriverName
in interfaceOpenJPAConfiguration
-
getConnectionDriverName
public java.lang.String getConnectionDriverName()
Description copied from interface:OpenJPAConfiguration
Class name of the connection driver.- Specified by:
getConnectionDriverName
in interfaceOpenJPAConfiguration
-
setConnectionProperties
public void setConnectionProperties(java.lang.String connectionProperties)
Description copied from interface:OpenJPAConfiguration
These properties provide any additional information needed to establish connections.- Specified by:
setConnectionProperties
in interfaceOpenJPAConfiguration
-
getConnectionProperties
public java.lang.String getConnectionProperties()
Description copied from interface:OpenJPAConfiguration
These properties provide any additional information needed to establish connections.- Specified by:
getConnectionProperties
in interfaceOpenJPAConfiguration
-
setConnectionFactoryProperties
public void setConnectionFactoryProperties(java.lang.String connectionFactoryProperties)
Description copied from interface:OpenJPAConfiguration
Configuration properties for the connection factory.- Specified by:
setConnectionFactoryProperties
in interfaceOpenJPAConfiguration
-
getConnectionFactoryProperties
public java.lang.String getConnectionFactoryProperties()
Description copied from interface:OpenJPAConfiguration
Configuration properties for the connection factory.- Specified by:
getConnectionFactoryProperties
in interfaceOpenJPAConfiguration
-
getConnectionFactoryMode
public java.lang.String 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
public void setConnectionFactoryMode(java.lang.String mode)
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
public void setConnectionFactoryName(java.lang.String connectionFactoryName)
Description copied from interface:OpenJPAConfiguration
The name for the data store connection factory.- Specified by:
setConnectionFactoryName
in interfaceOpenJPAConfiguration
-
getConnectionFactoryName
public java.lang.String getConnectionFactoryName()
Description copied from interface:OpenJPAConfiguration
The name for the data store connection factory.- Specified by:
getConnectionFactoryName
in interfaceOpenJPAConfiguration
-
setConnectionFactory
public void setConnectionFactory(java.lang.Object factory)
Description copied from interface:OpenJPAConfiguration
The connection factory.- Specified by:
setConnectionFactory
in interfaceOpenJPAConfiguration
-
getConnectionFactory
public java.lang.Object getConnectionFactory()
Description copied from interface:OpenJPAConfiguration
The connection factory, possibly from JNDI.- Specified by:
getConnectionFactory
in interfaceOpenJPAConfiguration
-
setConnection2UserName
public void setConnection2UserName(java.lang.String connection2UserName)
Description copied from interface:OpenJPAConfiguration
The user name for the non-XA data store connection.- Specified by:
setConnection2UserName
in interfaceOpenJPAConfiguration
-
getConnection2UserName
public java.lang.String getConnection2UserName()
Description copied from interface:OpenJPAConfiguration
The user name for the non-XA data store connection.- Specified by:
getConnection2UserName
in interfaceOpenJPAConfiguration
-
setConnection2Password
public void setConnection2Password(java.lang.String connection2Password)
Description copied from interface:OpenJPAConfiguration
The password for the non-XA data store connection.- Specified by:
setConnection2Password
in interfaceOpenJPAConfiguration
-
getConnection2Password
public java.lang.String getConnection2Password()
Description copied from interface:OpenJPAConfiguration
The password for the non-XA data store connection.- Specified by:
getConnection2Password
in interfaceOpenJPAConfiguration
-
setConnection2URL
public void setConnection2URL(java.lang.String connection2URL)
Description copied from interface:OpenJPAConfiguration
The URL for the non-XA data store connection.- Specified by:
setConnection2URL
in interfaceOpenJPAConfiguration
-
getConnection2URL
public java.lang.String getConnection2URL()
Description copied from interface:OpenJPAConfiguration
The URL for the non-XA data store connection.- Specified by:
getConnection2URL
in interfaceOpenJPAConfiguration
-
setConnection2DriverName
public void setConnection2DriverName(java.lang.String driverName)
Description copied from interface:OpenJPAConfiguration
Class name of the non-XA connection driver.- Specified by:
setConnection2DriverName
in interfaceOpenJPAConfiguration
-
getConnection2DriverName
public java.lang.String getConnection2DriverName()
Description copied from interface:OpenJPAConfiguration
Class name of the non-XA connection driver.- Specified by:
getConnection2DriverName
in interfaceOpenJPAConfiguration
-
setConnection2Properties
public void setConnection2Properties(java.lang.String connection2Properties)
Description copied from interface:OpenJPAConfiguration
These properties provide any additional information needed to establish non-XA connections.- Specified by:
setConnection2Properties
in interfaceOpenJPAConfiguration
-
getConnection2Properties
public java.lang.String getConnection2Properties()
Description copied from interface:OpenJPAConfiguration
These properties provide any additional information needed to establish non-XA connections.- Specified by:
getConnection2Properties
in interfaceOpenJPAConfiguration
-
setConnectionFactory2Properties
public void setConnectionFactory2Properties(java.lang.String connectionFactory2Properties)
Description copied from interface:OpenJPAConfiguration
Configuration properties for the non-XA connection factory.- Specified by:
setConnectionFactory2Properties
in interfaceOpenJPAConfiguration
-
getConnectionFactory2Properties
public java.lang.String getConnectionFactory2Properties()
Description copied from interface:OpenJPAConfiguration
Configuration properties for the non-XA connection factory.- Specified by:
getConnectionFactory2Properties
in interfaceOpenJPAConfiguration
-
setConnectionFactory2Name
public void setConnectionFactory2Name(java.lang.String connectionFactory2Name)
Description copied from interface:OpenJPAConfiguration
The name for the second data store connection factory.- Specified by:
setConnectionFactory2Name
in interfaceOpenJPAConfiguration
-
getConnectionFactory2Name
public java.lang.String getConnectionFactory2Name()
Description copied from interface:OpenJPAConfiguration
The name for the second data store connection factory.- Specified by:
getConnectionFactory2Name
in interfaceOpenJPAConfiguration
-
setConnectionFactory2
public void setConnectionFactory2(java.lang.Object factory)
Description copied from interface:OpenJPAConfiguration
The non-XA connection factory.- Specified by:
setConnectionFactory2
in interfaceOpenJPAConfiguration
-
getConnectionFactory2
public java.lang.Object 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
public void setOptimistic(java.lang.Boolean optimistic)
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
public void setAutoClear(java.lang.String clear)
Description copied from interface:OpenJPAConfiguration
Whether instances clear their state when entering a transaction.- Specified by:
setAutoClear
in interfaceOpenJPAConfiguration
-
getAutoClear
public java.lang.String 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
public void setRetainState(java.lang.Boolean retainState)
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
public void setRestoreState(java.lang.String restoreState)
Description copied from interface:OpenJPAConfiguration
Whether to restore initial state on rollback by default.- Specified by:
setRestoreState
in interfaceOpenJPAConfiguration
-
getRestoreState
public java.lang.String 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
public void setAutoDetach(java.lang.String autoDetach)
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
public java.lang.String 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
public void setDetachState(java.lang.String detachState)
Description copied from interface:OpenJPAConfiguration
Which field values to include when detaching.- Specified by:
setDetachState
in interfaceOpenJPAConfiguration
-
getDetachState
public java.lang.String getDetachState()
-
setDetachState
public void setDetachState(DetachOptions detachState)
Description copied from interface:OpenJPAConfiguration
Return the instance specified by the detach state plugin.- Specified by:
setDetachState
in interfaceOpenJPAConfiguration
-
getDetachStateInstance
public DetachOptions 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
public void setIgnoreChanges(java.lang.Boolean ignoreChanges)
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
public void setNontransactionalRead(java.lang.Boolean nontransactionalRead)
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
public void setNontransactionalWrite(java.lang.Boolean nontransactionalWrite)
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
public void setMultithreaded(java.lang.Boolean multithreaded)
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
public void setFetchBatchSize(java.lang.Integer fetchBatchSize)
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
public void setMaxFetchDepth(java.lang.Integer maxFetchDepth)
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
public void setFetchGroups(java.lang.String fetchGroups)
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
public java.lang.String 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
public java.lang.String[] 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
public void setFetchGroups(java.lang.String[] fetchGroups)
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
public void setFlushBeforeQueries(java.lang.String flush)
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
public java.lang.String 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
public void setLockTimeout(java.lang.Integer timeout)
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
public void setReadLockLevel(java.lang.String level)
Description copied from interface:OpenJPAConfiguration
The default read lock level to use during non-optimistic transactions. Defaults toread
.- Specified by:
setReadLockLevel
in interfaceOpenJPAConfiguration
-
getReadLockLevel
public java.lang.String 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
public void setWriteLockLevel(java.lang.String level)
Description copied from interface:OpenJPAConfiguration
The default write lock level to use during non-optimistic transactions. Defaults towrite
.- Specified by:
setWriteLockLevel
in interfaceOpenJPAConfiguration
-
getWriteLockLevel
public java.lang.String 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
public void setSequence(java.lang.String sequence)
Description copied from interface:OpenJPAConfiguration
Plugin string for the default systemSeq
.- Specified by:
setSequence
in interfaceOpenJPAConfiguration
-
getSequence
public java.lang.String getSequence()
Description copied from interface:OpenJPAConfiguration
Plugin string for the default systemSeq
.- Specified by:
getSequence
in interfaceOpenJPAConfiguration
-
setSequence
public void setSequence(Seq seq)
Description copied from interface:OpenJPAConfiguration
The default system sequence.- Specified by:
setSequence
in interfaceOpenJPAConfiguration
-
getSequenceInstance
public Seq getSequenceInstance()
Description copied from interface:OpenJPAConfiguration
The default system sequence.- Specified by:
getSequenceInstance
in interfaceOpenJPAConfiguration
-
setConnectionRetainMode
public void setConnectionRetainMode(java.lang.String connectionRetainMode)
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
public java.lang.String 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
public void setFilterListeners(java.lang.String filterListeners)
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
public java.lang.String 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
public void setFilterListeners(FilterListener[] listeners)
Description copied from interface:OpenJPAConfiguration
Set the query filter listeners. Overrides the list of listener classes.- Specified by:
setFilterListeners
in interfaceOpenJPAConfiguration
-
getFilterListenerInstances
public FilterListener[] 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
public void setAggregateListeners(java.lang.String aggregateListeners)
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
public java.lang.String 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
public void setAggregateListeners(AggregateListener[] listeners)
Description copied from interface:OpenJPAConfiguration
Set the query function listeners. Overrides the list of listener classes.- Specified by:
setAggregateListeners
in interfaceOpenJPAConfiguration
-
getAggregateListenerInstances
public AggregateListener[] 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
public void setRetryClassRegistration(java.lang.Boolean retry)
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
public java.lang.String getCompatibility()
Description copied from interface:OpenJPAConfiguration
Backwards compatibility options.- Specified by:
getCompatibility
in interfaceOpenJPAConfiguration
-
setCompatibility
public void setCompatibility(java.lang.String compatibility)
Description copied from interface:OpenJPAConfiguration
Backwards compatibility options.- Specified by:
setCompatibility
in interfaceOpenJPAConfiguration
-
getCompatibilityInstance
public Compatibility 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
public java.lang.String getCallbackOptions()
Description copied from interface:OpenJPAConfiguration
Options for configuring callbacks as a String.- Specified by:
getCallbackOptions
in interfaceOpenJPAConfiguration
-
setCallbackOptions
public void setCallbackOptions(java.lang.String options)
Description copied from interface:OpenJPAConfiguration
Options for configuring callbacks set as a comma-separated string value pair.- Specified by:
setCallbackOptions
in interfaceOpenJPAConfiguration
-
getCallbackOptionsInstance
public CallbackOptions getCallbackOptionsInstance()
Description copied from interface:OpenJPAConfiguration
Options for configuring callbacks.- Specified by:
getCallbackOptionsInstance
in interfaceOpenJPAConfiguration
-
getQueryCompilationCache
public java.lang.String getQueryCompilationCache()
Description copied from interface:OpenJPAConfiguration
Configuration settings for the query compilation cache to use.- Specified by:
getQueryCompilationCache
in interfaceOpenJPAConfiguration
- See Also:
QueryCompilationCacheValue
-
setQueryCompilationCache
public void setQueryCompilationCache(java.lang.String queryCompilationCache)
Description copied from interface:OpenJPAConfiguration
Configuration settings for the query compilation cache to use.- Specified by:
setQueryCompilationCache
in interfaceOpenJPAConfiguration
- See Also:
QueryCompilationCacheValue
-
getQueryCompilationCacheInstance
public java.util.Map getQueryCompilationCacheInstance()
Description copied from interface:OpenJPAConfiguration
Configuration settings for the query compilation cache to use.- Specified by:
getQueryCompilationCacheInstance
in interfaceOpenJPAConfiguration
- See Also:
QueryCompilationCacheValue
-
getStoreFacadeTypeRegistry
public StoreFacadeTypeRegistry getStoreFacadeTypeRegistry()
Description copied from interface:OpenJPAConfiguration
Return theStoreFacadeTypeRegistry
instance associated with this configuration.- Specified by:
getStoreFacadeTypeRegistry
in interfaceOpenJPAConfiguration
-
getBrokerFactoryEventManager
public BrokerFactoryEventManager getBrokerFactoryEventManager()
Description copied from interface:OpenJPAConfiguration
Return theBrokerFactoryEventManager
associated with this configuration.- Specified by:
getBrokerFactoryEventManager
in interfaceOpenJPAConfiguration
-
getRuntimeUnenhancedClasses
public java.lang.String 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
public void setRuntimeUnenhancedClasses(java.lang.String mode)
Description copied from interface:OpenJPAConfiguration
Specifies how OpenJPA handles unenhanced types.- Specified by:
setRuntimeUnenhancedClasses
in interfaceOpenJPAConfiguration
-
getCacheMarshallers
public java.lang.String 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
public void setCacheMarshallers(java.lang.String marshallers)
Description copied from interface:OpenJPAConfiguration
A comma-separated list of the plugin strings specifying theCacheMarshaller
s to use.- Specified by:
setCacheMarshallers
in interfaceOpenJPAConfiguration
-
getCacheMarshallerInstances
public java.util.Map 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
public void setValidationMode(java.lang.String mode)
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
public java.lang.String getValidationMode()
Description copied from interface:OpenJPAConfiguration
The bean validation mode to use for managed classes. Defaults toAUTO
.- Specified by:
getValidationMode
in interfaceOpenJPAConfiguration
-
setValidationGroupPrePersist
public void setValidationGroupPrePersist(java.lang.String vgPrePersist)
Description copied from interface:OpenJPAConfiguration
Sets the validation groups for pre-persist- Specified by:
setValidationGroupPrePersist
in interfaceOpenJPAConfiguration
-
getValidationGroupPrePersist
public java.lang.String getValidationGroupPrePersist()
Description copied from interface:OpenJPAConfiguration
Gets the validation groups for pre-persist- Specified by:
getValidationGroupPrePersist
in interfaceOpenJPAConfiguration
-
setValidationGroupPreUpdate
public void setValidationGroupPreUpdate(java.lang.String vgPreUpdate)
Description copied from interface:OpenJPAConfiguration
Sets the validation groups for pre-update- Specified by:
setValidationGroupPreUpdate
in interfaceOpenJPAConfiguration
-
getValidationGroupPreUpdate
public java.lang.String getValidationGroupPreUpdate()
Description copied from interface:OpenJPAConfiguration
Gets the validation groups for pre-update- Specified by:
getValidationGroupPreUpdate
in interfaceOpenJPAConfiguration
-
setValidationGroupPreRemove
public void setValidationGroupPreRemove(java.lang.String vgPreRemove)
Description copied from interface:OpenJPAConfiguration
Sets the validation groups for pre-remove- Specified by:
setValidationGroupPreRemove
in interfaceOpenJPAConfiguration
-
getValidationGroupPreRemove
public java.lang.String getValidationGroupPreRemove()
Description copied from interface:OpenJPAConfiguration
Gets the validation groups for pre-remove- Specified by:
getValidationGroupPreRemove
in interfaceOpenJPAConfiguration
-
getInstrumentation
public java.lang.String 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
public void setInstrumentation(java.lang.String providers)
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
public InstrumentationProvider[] getInstrumentationInstances()
-
setInstrumentationManager
public void setInstrumentationManager(java.lang.String mgr)
-
getInstrumentationManager
public java.lang.String getInstrumentationManager()
-
setInstrumentationManager
public void setInstrumentationManager(InstrumentationManager im)
-
getInstrumentationManagerInstance
public InstrumentationManager 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
public Log getConfigurationLog()
Description copied from class:ConfigurationImpl
Returns the logging channelopenjpa.Runtime
by default.- Specified by:
getConfigurationLog
in interfaceConfiguration
- Overrides:
getConfigurationLog
in classConfigurationImpl
-
setQuerySQLCache
public void setQuerySQLCache(java.lang.String querySQLCache)
Description copied from interface:OpenJPAConfiguration
Sets QuerySQLCache with the given configuration.- Specified by:
setQuerySQLCache
in interfaceOpenJPAConfiguration
-
setQuerySQLCache
public void setQuerySQLCache(PreparedQueryCache querySQLCache)
Description copied from interface:OpenJPAConfiguration
Sets QuerySQLCache with the given cache.- Specified by:
setQuerySQLCache
in interfaceOpenJPAConfiguration
-
getQuerySQLCache
public java.lang.String getQuerySQLCache()
Description copied from interface:OpenJPAConfiguration
Gets the configuration of QuerySQLCache.- Specified by:
getQuerySQLCache
in interfaceOpenJPAConfiguration
-
getQuerySQLCacheInstance
public PreparedQueryCache getQuerySQLCacheInstance()
Description copied from interface:OpenJPAConfiguration
Return PreparedQueryCache used for caching datastore queries.- Specified by:
getQuerySQLCacheInstance
in interfaceOpenJPAConfiguration
-
setFinderCache
public void setFinderCache(java.lang.String finderCache)
Description copied from interface:OpenJPAConfiguration
Set the finder cache from a string configuration.- Specified by:
setFinderCache
in interfaceOpenJPAConfiguration
-
getFinderCache
public java.lang.String getFinderCache()
Description copied from interface:OpenJPAConfiguration
Get the string configuration of the finder cache.- Specified by:
getFinderCache
in interfaceOpenJPAConfiguration
-
getFinderCacheInstance
public FinderCache getFinderCacheInstance()
Description copied from interface:OpenJPAConfiguration
Get the cache of finder queries.- Specified by:
getFinderCacheInstance
in interfaceOpenJPAConfiguration
-
getValidationFactoryInstance
public java.lang.Object getValidationFactoryInstance()
Description copied from interface:OpenJPAConfiguration
The ValidatorFactory provided by the container or application. Defaults tonull
.- Specified by:
getValidationFactoryInstance
in interfaceOpenJPAConfiguration
-
setValidationFactory
public void setValidationFactory(java.lang.Object factory)
Description copied from interface:OpenJPAConfiguration
Set the container or application provided ValidatorFactory instance. If not set, defaults tonull
.- Specified by:
setValidationFactory
in interfaceOpenJPAConfiguration
-
getValidatorInstance
public java.lang.Object 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
public void setValidatorInstance(java.lang.Object val)
Description copied from interface:OpenJPAConfiguration
Set the container or application provided Validator instance. If not set, defaults tonull
.- Specified by:
setValidatorInstance
in interfaceOpenJPAConfiguration
-
getLifecycleEventManager
public java.lang.String getLifecycleEventManager()
Description copied from interface:OpenJPAConfiguration
Gets the lifecycle event manager instance classname.- Specified by:
getLifecycleEventManager
in interfaceOpenJPAConfiguration
-
getLifecycleEventManagerInstance
public LifecycleEventManager getLifecycleEventManagerInstance()
Description copied from interface:OpenJPAConfiguration
Gets the lifecycle event manager instance.- Specified by:
getLifecycleEventManagerInstance
in interfaceOpenJPAConfiguration
-
setLifecycleEventManager
public void setLifecycleEventManager(java.lang.String lem)
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
public void setEncryptionProvider(java.lang.String p)
Description copied from interface:OpenJPAConfiguration
Sets theEncryptionProvider
.- Specified by:
setEncryptionProvider
in interfaceOpenJPAConfiguration
-
getEncryptionProvider
public EncryptionProvider getEncryptionProvider()
Description copied from interface:OpenJPAConfiguration
Gets theEncryptionProvider
.- Specified by:
getEncryptionProvider
in interfaceOpenJPAConfiguration
- Returns:
- EncryptionProvider
-
setDataCacheMode
public void setDataCacheMode(java.lang.String mode)
Description copied from interface:OpenJPAConfiguration
Set theDataCacheMode
- Specified by:
setDataCacheMode
in interfaceOpenJPAConfiguration
- Parameters:
mode
- One of the Sting constants fromDataCacheMode
-
getDataCacheMode
public java.lang.String getDataCacheMode()
Description copied from interface:OpenJPAConfiguration
Return the String constant that matches theDataCacheMode
- Specified by:
getDataCacheMode
in interfaceOpenJPAConfiguration
- Returns:
- DataCacheMode
-
getCacheDistributionPolicy
public java.lang.String 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
public 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
public void setCacheDistributionPolicy(java.lang.String policyPlugin)
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
public void setCacheDistributionPolicyInstance(CacheDistributionPolicy policy)
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
public void setPersistenceEnvironment(java.util.Map<java.lang.String,java.lang.Object> peMap)
-
getPersistenceEnvironment
public java.util.Map<java.lang.String,java.lang.Object> getPersistenceEnvironment()
-
getAuditorInstance
public Auditor getAuditorInstance()
Description copied from interface:OpenJPAConfiguration
Gets the singular instance ofAuditor
associated with this configuration.- Specified by:
getAuditorInstance
in interfaceOpenJPAConfiguration
-
setAuditorInstance
public void setAuditorInstance(Auditor auditor)
Description copied from interface:OpenJPAConfiguration
Sets the singular instance ofAuditor
associated with this configuration.- Specified by:
setAuditorInstance
in interfaceOpenJPAConfiguration
-
getAuditor
public java.lang.String getAuditor()
Description copied from interface:OpenJPAConfiguration
Gets the plug-in string ofAuditor
specified in this configuration.- Specified by:
getAuditor
in interfaceOpenJPAConfiguration
-
setAuditor
public void setAuditor(java.lang.String auditor)
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
public void setPostLoadOnMerge(java.lang.Boolean postLoadOnMerge)
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
public void setOptimizeIdCopy(java.lang.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
-
getDatabaseAction
public java.lang.String 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:
OpenJPAConfiguration.getDatabaseAction()
-
getScriptsAction
public java.lang.String getScriptsAction()
Description copied from interface:OpenJPAConfiguration
Similar toOpenJPAConfiguration.getDatabaseAction()
but write the generated SQL to files.- Specified by:
getScriptsAction
in interfaceOpenJPAConfiguration
- See Also:
OpenJPAConfiguration.getDatabaseAction()
-
getScriptsActionConstant
public int getScriptsActionConstant()
- Specified by:
getScriptsActionConstant
in interfaceOpenJPAConfiguration
- See Also:
OpenJPAConfiguration.getScriptsAction()
-
getCreateSource
public java.lang.String 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:
OpenJPAConfiguration.getScriptsAction()
-
getCreateSourceConstant
public int getCreateSourceConstant()
- Specified by:
getCreateSourceConstant
in interfaceOpenJPAConfiguration
- See Also:
OpenJPAConfiguration.getCreateSource()
-
getDropSource
public java.lang.String getDropSource()
Description copied from interface:OpenJPAConfiguration
Similar toOpenJPAConfiguration.getCreateSource()
but for dropping the database schema and content.- Specified by:
getDropSource
in interfaceOpenJPAConfiguration
- See Also:
OpenJPAConfiguration.getCreateSource()
-
getDropSourceConstant
public int getDropSourceConstant()
- Specified by:
getDropSourceConstant
in interfaceOpenJPAConfiguration
- See Also:
OpenJPAConfiguration.getDatabaseAction()
-
getCreateScriptSource
public java.lang.String getCreateScriptSource()
- Specified by:
getCreateScriptSource
in interfaceOpenJPAConfiguration
- See Also:
OpenJPAConfiguration.getDatabaseAction()
-
getDropScriptSource
public java.lang.String getDropScriptSource()
- Specified by:
getDropScriptSource
in interfaceOpenJPAConfiguration
- See Also:
OpenJPAConfiguration.getCreateSource()
-
getCreateScriptTarget
public java.lang.String getCreateScriptTarget()
- Specified by:
getCreateScriptTarget
in interfaceOpenJPAConfiguration
- See Also:
'script'
-
getDropScriptTarget
public java.lang.String getDropScriptTarget()
- Specified by:
getDropScriptTarget
in interfaceOpenJPAConfiguration
- See Also:
'script'
-
getLoadScriptSource
public java.lang.String 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
public void setUseTCCLinSelectNew(java.lang.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
-
getTypesWithoutEnhancement
public java.util.Collection<java.lang.Class<?>> getTypesWithoutEnhancement()
- Specified by:
getTypesWithoutEnhancement
in interfaceOpenJPAConfiguration
- Returns:
- types which should not get enhanced although they are on the included directories.
-
setTypesWithoutEnhancement
public void setTypesWithoutEnhancement(java.util.Collection<java.lang.Class<?>> value)
- Specified by:
setTypesWithoutEnhancement
in interfaceOpenJPAConfiguration
- See Also:
OpenJPAConfiguration.getTypesWithoutEnhancement()
-
-