Package org.apache.openjpa.conf

Interface OpenJPAConfiguration

All Superinterfaces:
BeanInfo, Cloneable, Closeable, Configuration, Serializable
All Known Subinterfaces:
DistributedConfiguration, DistributedJDBCConfiguration, JDBCConfiguration
All Known Implementing Classes:
DistributedJDBCConfigurationImpl, JDBCConfigurationImpl, OpenJPAConfigurationImpl, XMLConfiguration
public interface OpenJPAConfiguration extends Configuration
Defines the properties necessary to configure runtime properties and connect to a data source. There is a 1-1 relation between a configuration and a BrokerFactory. All setter methods that take primitive parameters also have wrapper setter with the appropriate primitive wrapper. This is so the interface can be in accordance with the J2EE Connector Architecture.
Author:
Marc Prud'hommeaux, Abe White
See Also:

  • Field Details

    • LOG_METADATA

      static final String LOG_METADATA
      Name of logger for metadata-related messages: openjpa.MetaData.
      See Also:

    • LOG_ENHANCE

      static final String LOG_ENHANCE
      Name of logger for enhancement-related messages: openjpa.Enhance.
      See Also:

    • LOG_RUNTIME

      static final String LOG_RUNTIME
      Name of logger for messages from the runtime system: openjpa.Runtime.
      See Also:

    • LOG_QUERY

      static final String LOG_QUERY
      Name of logger for query logging: openjpa.Query.
      See Also:

    • LOG_DATACACHE

      static final String LOG_DATACACHE
      Name of logger for messages from the data cache: openjpa.DataCache.
      See Also:

    • LOG_TOOL

      static final String LOG_TOOL
      Name of logger for messages from the development tools: openjpa.Tool.
      See Also:

    • OPTION_NONTRANS_READ

      static final String OPTION_NONTRANS_READ
      Option for runtimes that support nontransactional reads.
      See Also:

    • OPTION_OPTIMISTIC

      static final String OPTION_OPTIMISTIC
      Option for runtimes that support optimistic transactions.
      See Also:

    • OPTION_ID_APPLICATION

      static final String OPTION_ID_APPLICATION
      Option for runtimes that support application identity.
      See Also:

    • OPTION_ID_DATASTORE

      static final String OPTION_ID_DATASTORE
      Option for runtimes that support application identity.
      See Also:

    • OPTION_QUERY_SQL

      static final String OPTION_QUERY_SQL
      Option for SQL support.
      See Also:

    • OPTION_TYPE_COLLECTION

      static final String OPTION_TYPE_COLLECTION
      Option for runtimes that support persistent collection fields.
      See Also:

    • OPTION_TYPE_MAP

      static final String OPTION_TYPE_MAP
      Option for runtimes that support persistent map fields.
      See Also:

    • OPTION_TYPE_ARRAY

      static final String OPTION_TYPE_ARRAY
      Option for runtimes that support persistent array fields.
      See Also:

    • OPTION_NULL_CONTAINER

      static final String OPTION_NULL_CONTAINER
      Option for runtime that can differentiate between null and empty container fields.
      See Also:

    • OPTION_EMBEDDED_RELATION

      static final String OPTION_EMBEDDED_RELATION
      Option for runtimes that support embedded relations to other persistence capable objects.
      See Also:

    • OPTION_EMBEDDED_COLLECTION_RELATION

      static final String OPTION_EMBEDDED_COLLECTION_RELATION
      Option for runtimes that support collections of embedded relations to other persistence capable objects.
      See Also:

    • OPTION_EMBEDDED_MAP_RELATION

      static final String OPTION_EMBEDDED_MAP_RELATION
      Option for runtimes that support maps of embedded relations to other persistence capable objects.
      See Also:

    • OPTION_INC_FLUSH

      static final String OPTION_INC_FLUSH
      Option for runtimes that support incremental flushing.
      See Also:

    • OPTION_VALUE_AUTOASSIGN

      static final String OPTION_VALUE_AUTOASSIGN
      Option for runtimes that the autoassign value strategy.
      See Also:

    • OPTION_VALUE_INCREMENT

      static final String OPTION_VALUE_INCREMENT
      Option for runtimes that the increment value strategy.
      See Also:

    • OPTION_DATASTORE_CONNECTION

      static final String OPTION_DATASTORE_CONNECTION
      Option for runtimes that support returning the datastore connection.
      See Also:

    • OPTION_JDBC_CONNECTION

      static final String OPTION_JDBC_CONNECTION
      Option for runtimes that support returning the datastore connection that is a JDBC Connection.
      See Also:

    • OPTION_POSTLOAD_ON_MERGE

      static final String OPTION_POSTLOAD_ON_MERGE
      Option for enable fire @PostLoad events on merge operations
      See Also:

    • OPTION_USE_TCCL_IN_SELECT_NEW

      static final String OPTION_USE_TCCL_IN_SELECT_NEW
      Option to enable TCCL if the result class for select new is not found in the entities classloader
      See Also:

  • Method Details

    • supportedOptions

      Collection<String> supportedOptions()
      Return the set of option strings supported by this runtime. This set is mutable.

    • getSpecification

      String getSpecification()
      Get a name of the Specification. Specification determines various important default behaviors.

    • getSpecificationInstance

      Specification getSpecificationInstance()
      Get the Specification. Specification determines various important default behaviors.
      Since:
      2.0.0

    • setSpecification

      void setSpecification(String spec)
      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.
      Parameters:
      spec - fullname of the specification that possibly encodes major and minor version information. For encoding format
      Since:
      1.1.0
      See Also:

    • setSpecification

      void setSpecification(Specification spec)
      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.
      Parameters:
      spec - fullname of the specification that possibly encodes major and minor version information. For encoding format
      Since:
      2.0.0
      See Also:

    • getClassResolver

      String getClassResolver()
      The plugin string for the ClassResolver to use for custom class loading.

    • setClassResolver

      void setClassResolver(String classResolver)
      The plugin string for the ClassResolver to use for custom class loading.

    • getClassResolverInstance

      ClassResolver getClassResolverInstance()
      The ClassResolver to use.

    • setClassResolver

      void setClassResolver(ClassResolver classResolver)
      The ClassResolver to use.

    • getBrokerFactory

      String getBrokerFactory()
      The BrokerFactory class to use.

    • setBrokerFactory

      void setBrokerFactory(String factory)
      The BrokerFactory class to use.

    • getBrokerImpl

      String getBrokerImpl()
      The plugin string of the BrokerImpl extension to create.

    • setBrokerImpl

      void setBrokerImpl(String broker)
      The plugin string of the BrokerImpl extension to create.

    • newBrokerInstance

      BrokerImpl newBrokerInstance(String user, String pass)
      Create a new broker instance with the configured plugin data.

    • getDataCache

      String getDataCache()
      The DataCache to use for level-2 data store caching.

    • setDataCache

      void setDataCache(String dataCache)
      The DataCache to use for level-2 data store caching.

    • getDataCacheManager

      String getDataCacheManager()
      The data cache manager manages this configuration's cache instances.

    • setDataCacheManager

      void setDataCacheManager(String mgr)
      The data cache manager manages this configuration's cache instances.

    • getDataCacheManagerInstance

      DataCacheManager getDataCacheManagerInstance()
      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.
      Since:
      0.3.0

    • setDataCacheManager

      void setDataCacheManager(DataCacheManager manager)
      The data cache manager manages this configuration's cache instances.
      Since:
      0.3.0

    • getDataCacheTimeout

      int getDataCacheTimeout()
      Default data cache timeout.
      Since:
      0.2.5

    • setDataCacheTimeout

      void setDataCacheTimeout(int timeout)
      Default data cache timeout.
      Since:
      0.2.5

    • setDataCacheTimeout

      void setDataCacheTimeout(Integer timeout)
      Wrapper for JCA usage of setDataCacheTimeout(int).
      Since:
      0.2.5

    • getRefreshFromDataCache

      boolean getRefreshFromDataCache()
      Gets whether entity state is to be refreshed from DataCache. 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.
      Since:
      1.2.0

    • setRefreshFromDataCache

      void setRefreshFromDataCache(boolean refreshFromDataCache)
      Sets whether entity state is to be refreshed from DataCache. 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.
      Since:
      1.2.0

    • setRefreshFromDataCache

      void setRefreshFromDataCache(Boolean refreshFromDataCache)
      Sets whether entity state is to be refreshed from DataCache. 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.
      Since:
      1.2.0

    • getQueryCache

      String getQueryCache()
      The plugin to use for level-2 data store query caching.
      Since:
      0.2.5

    • setQueryCache

      void setQueryCache(String queryCache)
      The plugin to use for level-2 data store query caching.
      Since:
      0.2.5

    • getDynamicDataStructs

      boolean getDynamicDataStructs()
      Return whether to generate dynamic data structures where possible for cache and runtime usage.
      Since:
      0.3.3

    • setDynamicDataStructs

      void setDynamicDataStructs(boolean dynamic)
      Set whether to generate dynamic data structures where possible for cache and runtime usage.
      Since:
      0.3.3

    • setDynamicDataStructs

      void setDynamicDataStructs(Boolean dynamic)
      Wrapper for JCA usage of setDynamicDataStructs(boolean).

    • getLockManager

      String getLockManager()
      The plugin to use for datastore lock management.
      Since:
      0.3.1

    • setLockManager

      void setLockManager(String lockManager)
      The plugin to use for datastore lock management.
      Since:
      0.3.1

    • newLockManagerInstance

      LockManager newLockManagerInstance()
      Return a new lock manager instance using the configured plugin settings.

    • getInverseManager

      String getInverseManager()
      The plugin to use for managing inverse relations.
      Since:
      0.3.2

    • setInverseManager

      void setInverseManager(String inverse)
      The plugin to use for managing inverse relations.
      Since:
      0.3.2

    • newInverseManagerInstance

      InverseManager newInverseManagerInstance()
      Return a new inverse manager instance using the configured plugin settings.
      Since:
      0.3.2

    • getSavepointManager

      String getSavepointManager()
      The plugin to use for savepoint management.
      Since:
      0.3.4

    • setSavepointManager

      void setSavepointManager(String savepointManager)
      The plugin to use for savepoint management.
      Since:
      0.3.4

    • getSavepointManagerInstance

      SavepointManager getSavepointManagerInstance()
      Return the configured savepoint manager instance.

    • getOrphanedKeyAction

      String getOrphanedKeyAction()
      The action to take when an orphaned key is detected.
      Since:
      0.3.2.2

    • setOrphanedKeyAction

      void setOrphanedKeyAction(String action)
      The action to take when an orphaned key is detected.
      Since:
      0.3.2.2

    • getOrphanedKeyActionInstance

      OrphanedKeyAction getOrphanedKeyActionInstance()
      The action to take when an orphaned key is detected.
      Since:
      0.3.2.2

    • setOrphanedKeyAction

      void setOrphanedKeyAction(OrphanedKeyAction action)
      The action to take when an orphaned key is detected.
      Since:
      0.3.2.2

    • getRemoteCommitProvider

      String getRemoteCommitProvider()
      The plugin to use for remote commit notification.
      Since:
      0.2.5

    • setRemoteCommitProvider

      void setRemoteCommitProvider(String remoteCommitProvider)
      The plugin to use for remote commit notification.
      Since:
      0.2.5

    • newRemoteCommitProviderInstance

      RemoteCommitProvider newRemoteCommitProviderInstance()
      Create a remote commit provider from the configured plugin.
      Since:
      0.3.0

    • getRemoteCommitEventManager

      RemoteCommitEventManager getRemoteCommitEventManager()
      The remote event manager that manages this configuration's remote event listeners.
      Since:
      0.3.0

    • setRemoteCommitEventManager

      void setRemoteCommitEventManager(RemoteCommitEventManager manager)
      The remote event manager that manages this configuration's remote event listeners.
      Since:
      0.3.0

    • getTransactionMode

      String getTransactionMode()
      Specifies the behavior of the transaction model. Possible values are:
      • local: Perform transaction operations locally.
      • managed: Use managed environment's global transactions.
      Since:
      0.2.5

    • setTransactionMode

      void setTransactionMode(String mode)
      Specifies the behavior of the transaction model. Possible values are:
      • local: Perform transaction operations locally.
      • managed: Use managed environment's global transactions.
      Since:
      0.2.5

    • isTransactionModeManaged

      boolean isTransactionModeManaged()
      Return whether managed transactions are being used.

    • setTransactionModeManaged

      void setTransactionModeManaged(boolean managed)
      Set whether managed transactions are being used.

    • getManagedRuntime

      String getManagedRuntime()
      The plugin string for the ManagedRuntime to use for managed environments.

    • setManagedRuntime

      void setManagedRuntime(String managedRuntime)
      The plugin string for the ManagedRuntime to use for managed environments.

    • getManagedRuntimeInstance

      ManagedRuntime getManagedRuntimeInstance()
      The plugin to use for integrating with a managed runtime.

    • setManagedRuntime

      void setManagedRuntime(ManagedRuntime runtime)
      The plugin to use for integrating with a managed runtime.

    • getProxyManager

      String getProxyManager()
      The plugin string for the ProxyManager to use for second class object proxies.

    • setProxyManager

      void setProxyManager(String proxyManager)
      The plugin string for the ProxyManager to use for second class object proxies.

    • getProxyManagerInstance

      ProxyManager getProxyManagerInstance()
      The ProxyManager to use.

    • setProxyManager

      void setProxyManager(ProxyManager manager)
      The ProxyManager to use.

    • getMapping

      String getMapping()
      The name mapping to use for this data store.

    • setMapping

      void setMapping(String mapping)
      The name mapping to use for this data store.

    • getMetaDataFactory

      String getMetaDataFactory()
      A plugin string describing the MetaDataFactory to use.

    • setMetaDataFactory

      void setMetaDataFactory(String meta)
      A plugin string describing the MetaDataFactory to use.

    • newMetaDataFactoryInstance

      MetaDataFactory newMetaDataFactoryInstance()
      Create a new MetaDataFactory to use with a repository.

    • getMetaDataRepository

      String getMetaDataRepository()
      A plugin string describing the MetaDataRepository to use.

    • setMetaDataRepository

      void setMetaDataRepository(String meta)
      A plugin string describing the MetaDataRepository to use.

    • getMetaDataRepositoryInstance

      MetaDataRepository getMetaDataRepositoryInstance()
      The metadata repository of managed class information. If no repository has been set, creates one.
      Since:
      0.3.0

    • metaDataRepositoryAvailable

      boolean metaDataRepositoryAvailable()
      Returns true if a metaDataRepository has been created for this configuration.
      Since:
      1.1.0 1.0.1

    • newMetaDataRepositoryInstance

      MetaDataRepository newMetaDataRepositoryInstance()
      Create a new empty metadata repository of the configured type.

    • setMetaDataRepository

      void setMetaDataRepository(MetaDataRepository mdRepos)
      The metadata repository of managed class information.
      Since:
      0.3.0

    • getConnectionUserName

      String getConnectionUserName()
      The user name for the data store connection.

    • setConnectionUserName

      void setConnectionUserName(String connectionUserName)
      The user name for the data store connection.

    • getConnectionPassword

      String getConnectionPassword()
      The password for the data store connection.

    • setConnectionPassword

      void setConnectionPassword(String connectionPassword)
      The password for the data store connection.

    • getConnectionURL

      String getConnectionURL()
      The URL for the data store connection.

    • setConnectionURL

      void setConnectionURL(String connectionURL)
      The URL for the data store connection.

    • getConnectionDriverName

      String getConnectionDriverName()
      Class name of the connection driver.

    • setConnectionDriverName

      void setConnectionDriverName(String driverName)
      Class name of the connection driver.

    • getConnectionFactoryName

      String getConnectionFactoryName()
      The name for the data store connection factory.

    • setConnectionFactoryName

      void setConnectionFactoryName(String cfName)
      The name for the data store connection factory.

    • getConnectionFactory

      Object getConnectionFactory()
      The connection factory, possibly from JNDI.

    • setConnectionFactory

      void setConnectionFactory(Object factory)
      The connection factory.

    • getConnectionProperties

      String getConnectionProperties()
      These properties provide any additional information needed to establish connections.

    • setConnectionProperties

      void setConnectionProperties(String props)
      These properties provide any additional information needed to establish connections.

    • getConnectionFactoryProperties

      String getConnectionFactoryProperties()
      Configuration properties for the connection factory.

    • setConnectionFactoryProperties

      void setConnectionFactoryProperties(String props)
      Configuration properties for the connection factory.

    • getConnectionFactoryMode

      String getConnectionFactoryMode()
      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.
      Defaults to local.

    • setConnectionFactoryMode

      void setConnectionFactoryMode(String mode)
      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.
      Defaults to local.

    • isConnectionFactoryModeManaged

      boolean isConnectionFactoryModeManaged()
      Whether connections are automatically enlisted in global transactions.

    • setConnectionFactoryModeManaged

      void setConnectionFactoryModeManaged(boolean managed)
      Whether connections are automatically enlisted in global transactions.

    • getConnection2UserName

      String getConnection2UserName()
      The user name for the non-XA data store connection.

    • setConnection2UserName

      void setConnection2UserName(String connectionUserName)
      The user name for the non-XA data store connection.

    • getConnection2Password

      String getConnection2Password()
      The password for the non-XA data store connection.

    • setConnection2Password

      void setConnection2Password(String connectionPassword)
      The password for the non-XA data store connection.

    • getConnection2URL

      String getConnection2URL()
      The URL for the non-XA data store connection.

    • setConnection2URL

      void setConnection2URL(String connectionURL)
      The URL for the non-XA data store connection.

    • getConnection2DriverName

      String getConnection2DriverName()
      Class name of the non-XA connection driver.

    • setConnection2DriverName

      void setConnection2DriverName(String driverName)
      Class name of the non-XA connection driver.

    • getConnectionFactory2Name

      String getConnectionFactory2Name()
      The name for the second data store connection factory.

    • setConnectionFactory2Name

      void setConnectionFactory2Name(String cf2Name)
      The name for the second data store connection factory.

    • getConnectionFactory2

      Object getConnectionFactory2()
      The non-XA connection factory.

    • setConnectionFactory2

      void setConnectionFactory2(Object factory)
      The non-XA connection factory.

    • getConnection2Properties

      String getConnection2Properties()
      These properties provide any additional information needed to establish non-XA connections.
      Since:
      0.3.0

    • setConnection2Properties

      void setConnection2Properties(String props)
      These properties provide any additional information needed to establish non-XA connections.
      Since:
      0.3.0

    • getConnectionFactory2Properties

      String getConnectionFactory2Properties()
      Configuration properties for the non-XA connection factory.
      Since:
      0.2.5

    • setConnectionFactory2Properties

      void setConnectionFactory2Properties(String props)
      Configuration properties for the non-XA connection factory.
      Since:
      0.2.5

    • getOptimistic

      boolean getOptimistic()
      Whether to use optimistic transactions by default.

    • setOptimistic

      void setOptimistic(boolean optimistic)
      Whether to use optimistic transactions by default.

    • setOptimistic

      void setOptimistic(Boolean optimistic)
      Wrapper for JCA usage of setOptimistic(boolean).

    • getRetainState

      boolean getRetainState()
      Whether to retain state after a transaction by default.

    • setRetainState

      void setRetainState(boolean retainState)
      Whether to retain state after a transaction by default.

    • setRetainState

      void setRetainState(Boolean retainState)
      Wrapper for JCA usage of setRetainState(boolean).

    • getAutoClear

      String getAutoClear()
      Whether instances clear their state when entering a transaction.

    • setAutoClear

      void setAutoClear(String clear)
      Whether instances clear their state when entering a transaction.

    • getAutoClearConstant

      int getAutoClearConstant()
      Return the AutoClear constant.

    • setAutoClear

      void setAutoClear(int clear)
      Whether instances clear their state when entering a transaction.

    • getRestoreState

      String getRestoreState()
      Whether to restore initial state on rollback by default.

    • setRestoreState

      void setRestoreState(String restoreState)
      Whether to restore initial state on rollback by default.

    • getRestoreStateConstant

      int getRestoreStateConstant()
      Return the RestoreState constant.

    • setRestoreState

      void setRestoreState(int restoreState)
      Whether to restore initial state on rollback by default.

    • getIgnoreChanges

      boolean getIgnoreChanges()
      Whether changes in the current transaction are taken into account when executing queries and iterating extents.

    • setIgnoreChanges

      void setIgnoreChanges(boolean ignoreChanges)
      Whether changes in the current transaction are taken into account when executing queries and iterating extents.

    • setIgnoreChanges

      void setIgnoreChanges(Boolean ignoreChanges)
      Wrapper for JCA usage of setIgnoreChanges(boolean).

    • getAutoDetach

      String getAutoDetach()
      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.

    • setAutoDetach

      void setAutoDetach(String detach)
      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.

    • getAutoDetachConstant

      int getAutoDetachConstant()
      The AutoDetach flags.

    • setAutoDetach

      void setAutoDetach(int flags)
      The AutoDetach flags.

    • setDetachState

      void setDetachState(String detachState)
      Which field values to include when detaching.

    • getDetachStateInstance

      DetachOptions getDetachStateInstance()
      Return the instance specified by the detach state plugin.

    • setDetachState

      void setDetachState(DetachOptions detachState)
      Return the instance specified by the detach state plugin.

    • getNontransactionalRead

      boolean getNontransactionalRead()
      Whether persistent state is accessible outside a transaction by default.

    • setNontransactionalRead

      void setNontransactionalRead(boolean ntRead)
      Whether persistent state is accessible outside a transaction by default.

    • setNontransactionalRead

      void setNontransactionalRead(Boolean ntRead)
      Wrapper for JCA usage of setNontransactionalRead(boolean).

    • getNontransactionalWrite

      boolean getNontransactionalWrite()
      Whether persistent state can be modified outside a transaction by default.

    • setNontransactionalWrite

      void setNontransactionalWrite(boolean ntWrite)
      Whether persistent state can be modified outside a transaction by default.

    • setNontransactionalWrite

      void setNontransactionalWrite(Boolean ntWrite)
      Wrapper for JCA usage of setNontransactionalWrite(boolean).

    • getMultithreaded

      boolean getMultithreaded()
      Whether brokers or their managed objects will be used by multiple concurrent threads.

    • setMultithreaded

      void setMultithreaded(boolean multithreaded)
      Whether brokers or their managed objects will be used by multiple concurrent threads.

    • setMultithreaded

      void setMultithreaded(Boolean multithreaded)
      Wrapper for JCA usage of setMultithreaded(boolean).

    • getFetchBatchSize

      int getFetchBatchSize()
      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.

    • setFetchBatchSize

      void setFetchBatchSize(int size)
      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.

    • setFetchBatchSize

      void setFetchBatchSize(Integer size)
      Wrapper for JCA usage of setFetchBatchSize(int).

    • getMaxFetchDepth

      int getMaxFetchDepth()
      The maximum relation depth to traverse when eager fetching. Use -1 for no limit.

    • setMaxFetchDepth

      void setMaxFetchDepth(int depth)
      The maximum relation depth to traverse when eager fetching. Use -1 for no limit.

    • setMaxFetchDepth

      void setMaxFetchDepth(Integer size)
      Wrapper for JCA usage of setMaxFetchDepth(int).

    • getFetchGroups

      String getFetchGroups()
      Comma-separated list of fetch group names that will be pre-set for all new FetchConfigurations.
      Since:
      0.2.5

    • setFetchGroups

      void setFetchGroups(String groups)
      Comma-separated list of fetch group names that will be pre-set for all new FetchConfigurations.
      Since:
      0.2.5

    • getFetchGroupsList

      String[] getFetchGroupsList()
      List of fetch group names that will be pre-set for all new FetchConfigurations.

    • setFetchGroups

      void setFetchGroups(String[] names)
      List of fetch group names that will be pre-set for all new FetchConfigurations.

    • getFlushBeforeQueries

      String getFlushBeforeQueries()
      Returns whether or not OpenJPA should automatically flush modifications to the data store before executing queries.
      Since:
      0.2.5

    • setFlushBeforeQueries

      void setFlushBeforeQueries(String flush)
      Sets whether or not OpenJPA should automatically flush modifications to the data store before executing queries.
      Since:
      0.2.5

    • getFlushBeforeQueriesConstant

      int getFlushBeforeQueriesConstant()
      Returns one of QueryFlushModes.FLUSH_TRUE, QueryFlushModes.FLUSH_FALSE, or QueryFlushModes.FLUSH_WITH_CONNECTION, as determined by parsing the string returned by getFlushBeforeQueries().
      Since:
      0.2.5

    • setFlushBeforeQueries

      void setFlushBeforeQueries(int flushBeforeQueries)
      Set to one of QueryFlushModes.FLUSH_TRUE, QueryFlushModes.FLUSH_FALSE, or QueryFlushModes.FLUSH_WITH_CONNECTION.
      Since:
      0.2.5

    • getLockTimeout

      int getLockTimeout()
      The time to wait for an object lock in milliseconds, or -1 for no timeout.
      Since:
      0.3.1

    • setLockTimeout

      void setLockTimeout(int timeout)
      The time to wait for an object lock in milliseconds, or -1 for no timeout.
      Since:
      0.3.1

    • setLockTimeout

      void setLockTimeout(Integer timeout)
      Wrapper for JCA usage of setLockTimeout(int).
      Since:
      0.3.1

    • getQueryTimeout

      int getQueryTimeout()
      The time to wait for a query to execute in milliseconds, or -1 for no timeout.
      Since:
      2.0.0

    • setQueryTimeout

      void setQueryTimeout(int timeout)
      The time to wait for a query to execute in milliseconds, or -1 for no timeout.
      Since:
      0.3.1

    • getReadLockLevel

      String getReadLockLevel()
      The default read lock level to use during non-optimistic transactions. Defaults to read.
      Since:
      0.3.1

    • setReadLockLevel

      void setReadLockLevel(String level)
      The default read lock level to use during non-optimistic transactions. Defaults to read.
      Since:
      0.3.1

    • getReadLockLevelConstant

      int getReadLockLevelConstant()
      The numeric read lock level.
      Since:
      0.3.1

    • setReadLockLevel

      void setReadLockLevel(int level)
      The numeric read lock level.
      Since:
      0.3.1

    • getWriteLockLevel

      String getWriteLockLevel()
      The default write lock level to use during non-optimistic transactions. Defaults to write.
      Since:
      0.3.1

    • setWriteLockLevel

      void setWriteLockLevel(String level)
      The default write lock level to use during non-optimistic transactions. Defaults to write.
      Since:
      0.3.1

    • getWriteLockLevelConstant

      int getWriteLockLevelConstant()
      The numeric write lock level.
      Since:
      0.3.1

    • setWriteLockLevel

      void setWriteLockLevel(int level)
      The numeric write lock level.
      Since:
      0.3.1

    • getSequence

      String getSequence()
      Plugin string for the default system Seq.

    • setSequence

      void setSequence(String sequence)
      Plugin string for the default system Seq.

    • getSequenceInstance

      Seq getSequenceInstance()
      The default system sequence.

    • setSequence

      void setSequence(Seq sequence)
      The default system sequence.

    • getConnectionRetainMode

      String getConnectionRetainMode()
      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.
      Since:
      0.2.5

    • setConnectionRetainMode

      void setConnectionRetainMode(String mode)
      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.
      Since:
      0.2.5

    • getConnectionRetainModeConstant

      int getConnectionRetainModeConstant()
      Return the connection retain mode as one of the following symbolic constants:

    • setConnectionRetainMode

      void setConnectionRetainMode(int mode)
      Set the connection retain mode as one of the following symbolic constants:

    • getFilterListeners

      String getFilterListeners()
      A comma-separted list of the plugin strings of the query FilterListeners to use.

    • setFilterListeners

      void setFilterListeners(String listeners)
      A comma-separted list of the plugin strings of the query FilterListeners to use.

    • getFilterListenerInstances

      FilterListener[] getFilterListenerInstances()
      Return the query filter listeners. If none have been set explicitly, this method instantiates the listeners from the set plugin list.

    • setFilterListeners

      void setFilterListeners(FilterListener[] listeners)
      Set the query filter listeners. Overrides the list of listener classes.

    • getAggregateListeners

      String getAggregateListeners()
      A comma-separted list of the plugin strings of the query AggregateListeners to use.

    • setAggregateListeners

      void setAggregateListeners(String listeners)
      A comma-separted list of the plugin strings of the query AggregateListeners to use.

    • getAggregateListenerInstances

      AggregateListener[] getAggregateListenerInstances()
      Return the query function listeners. If none have been set explicitly, this method instantiates the listeners from the set plugin list.

    • setAggregateListeners

      void setAggregateListeners(AggregateListener[] listeners)
      Set the query function listeners. Overrides the list of listener classes.

    • getRetryClassRegistration

      boolean getRetryClassRegistration()
      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 to false.
      Since:
      0.3.2.3

    • setRetryClassRegistration

      void setRetryClassRegistration(boolean warn)
      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 to false.
      Since:
      0.3.2.3

    • setRetryClassRegistration

      void setRetryClassRegistration(Boolean warn)
      Wrapper for JCA usage of setRetryClassRegistration(boolean).
      Since:
      0.3.2.3

    • getCompatibility

      String getCompatibility()
      Backwards compatibility options.

    • setCompatibility

      void setCompatibility(String compatibility)
      Backwards compatibility options.

    • getCompatibilityInstance

      Compatibility getCompatibilityInstance()
      Backwards compatibility options.

    • getCallbackOptions

      String getCallbackOptions()
      Options for configuring callbacks as a String.
      Since:
      2.0.0

    • getCallbackOptionsInstance

      CallbackOptions getCallbackOptionsInstance()
      Options for configuring callbacks.
      Since:
      2.0.0

    • setCallbackOptions

      void setCallbackOptions(String options)
      Options for configuring callbacks set as a comma-separated string value pair.
      Since:
      2.0.0

    • getQueryCompilationCache

      String getQueryCompilationCache()
      Configuration settings for the query compilation cache to use.
      Since:
      0.9.6
      See Also:

    • setQueryCompilationCache

      void setQueryCompilationCache(String conf)
      Configuration settings for the query compilation cache to use.
      Since:
      0.9.6
      See Also:

    • getQueryCompilationCacheInstance

      Map getQueryCompilationCacheInstance()
      Configuration settings for the query compilation cache to use.
      Since:
      0.9.6
      See Also:

    • getStoreFacadeTypeRegistry

      StoreFacadeTypeRegistry getStoreFacadeTypeRegistry()
      Return the StoreFacadeTypeRegistry instance associated with this configuration.

    • getBrokerFactoryEventManager

      BrokerFactoryEventManager getBrokerFactoryEventManager()
      Return the BrokerFactoryEventManager associated with this configuration.
      Since:
      1.0.0

    • getRuntimeUnenhancedClasses

      String getRuntimeUnenhancedClasses()
      Specifies how OpenJPA handles unenhanced types. Possible values are:
      • supported: Runtime optimization of persistent types is available. This is the default
      • unsupported: 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.
      Since:
      1.0.0

    • setRuntimeUnenhancedClasses

      void setRuntimeUnenhancedClasses(String mode)
      Specifies how OpenJPA handles unenhanced types.
      Since:
      1.0.0

    • getRuntimeUnenhancedClassesConstant

      int getRuntimeUnenhancedClassesConstant()
      Return the runtime class optimization setting as one of the following symbolic constants:
      Since:
      1.0.0

    • setRuntimeUnenhancedClasses

      void setRuntimeUnenhancedClasses(int mode)
      Set the runtime class optimization setting as one of the following symbolic constants:
      Since:
      1.0.0

    • getDynamicEnhancementAgent

      boolean getDynamicEnhancementAgent()
      Whether OpenJPA will attempt to dynamically load the enhancement agent.

    • setDynamicEnhancementAgent

      void setDynamicEnhancementAgent(boolean dynamic)
      Sets whether OpenJPA will attempt to dynamically load the enhancement agent.

    • getCacheMarshallers

      String getCacheMarshallers()
      A comma-separted list of the plugin strings specifying the CacheMarshallers to use.
      Since:
      1.1.0

    • setCacheMarshallers

      void setCacheMarshallers(String marshallers)
      A comma-separated list of the plugin strings specifying the CacheMarshallers to use.
      Since:
      1.1.0

    • getCacheMarshallerInstances

      Map<String,CacheMarshaller> getCacheMarshallerInstances()
      Return the cache marshaller listeners.
      Since:
      1.1.0

    • isInitializeEagerly

      boolean isInitializeEagerly()
      Affirms if all configured elements are initialized eagerly as opposed to lazily on-demand.
      Since:
      1.3.0

    • setInitializeEagerly

      void setInitializeEagerly(boolean flag)
      Sets whether all configured elements will be initialized eagerly or lazily on-demand.
      Since:
      1.3.0

    • getQuerySQLCacheInstance

      PreparedQueryCache getQuerySQLCacheInstance()
      Return PreparedQueryCache used for caching datastore queries.
      Since:
      2.0.0

    • getQuerySQLCache

      String getQuerySQLCache()
      Gets the configuration of QuerySQLCache.
      Since:
      2.0.0

    • setQuerySQLCache

      void setQuerySQLCache(PreparedQueryCache cache)
      Sets QuerySQLCache with the given cache.
      Since:
      2.0.0

    • setQuerySQLCache

      void setQuerySQLCache(String config)
      Sets QuerySQLCache with the given configuration.
      Since:
      2.0.0

    • getFinderCacheInstance

      FinderCache getFinderCacheInstance()
      Get the cache of finder queries.
      Since:
      2.0.0

    • getFinderCache

      String getFinderCache()
      Get the string configuration of the finder cache.
      Since:
      2.0.0

    • setFinderCache

      void setFinderCache(String cache)
      Set the finder cache from a string configuration.
      Since:
      2.0.0

    • getValidationMode

      String getValidationMode()
      The bean validation mode to use for managed classes. Defaults to AUTO.
      Since:
      2.0.0

    • setValidationMode

      void setValidationMode(String mode)
      Set the bean validation mode to use for managed classes. If not set, defaults to AUTO.
      Since:
      2.0.0

    • getValidationFactoryInstance

      Object getValidationFactoryInstance()
      The ValidatorFactory provided by the container or application. Defaults to null.
      Since:
      2.0.0

    • setValidationFactory

      void setValidationFactory(Object factory)
      Set the container or application provided ValidatorFactory instance. If not set, defaults to null.
      Since:
      2.0.0

    • getValidatorInstance

      Object getValidatorInstance()
      The Validator provided by the container or created by the runtime. Defaults to null.
      Since:
      2.0.0

    • setValidatorInstance

      void setValidatorInstance(Object val)
      Set the container or application provided Validator instance. If not set, defaults to null.
      Since:
      2.0.0

    • getLifecycleEventManager

      String getLifecycleEventManager()
      Gets the lifecycle event manager instance classname.
      Since:
      2.0.0

    • getLifecycleEventManagerInstance

      LifecycleEventManager getLifecycleEventManagerInstance()
      Gets the lifecycle event manager instance.
      Since:
      2.0.0

    • setLifecycleEventManager

      void setLifecycleEventManager(String eventMgr)
      Sets the lifecycle event manager instance classname.
      Since:
      2.0.0

    • getValidationGroupPrePersist

      String getValidationGroupPrePersist()
      Gets the validation groups for pre-persist
      Since:
      2.0.0

    • setValidationGroupPrePersist

      void setValidationGroupPrePersist(String vgPrePersist)
      Sets the validation groups for pre-persist
      Since:
      2.0.0

    • getValidationGroupPreUpdate

      String getValidationGroupPreUpdate()
      Gets the validation groups for pre-update
      Since:
      2.0.0

    • setValidationGroupPreUpdate

      void setValidationGroupPreUpdate(String vgPreUpdate)
      Sets the validation groups for pre-update
      Since:
      2.0.0

    • getValidationGroupPreRemove

      String getValidationGroupPreRemove()
      Gets the validation groups for pre-remove
      Since:
      2.0.0

    • setValidationGroupPreRemove

      void setValidationGroupPreRemove(String vgPreRemove)
      Sets the validation groups for pre-remove
      Since:
      2.0.0

    • setEncryptionProvider

      void setEncryptionProvider(String className)
      Sets the EncryptionProvider.

    • getEncryptionProvider

      EncryptionProvider getEncryptionProvider()
      Gets the EncryptionProvider.
      Returns:
      EncryptionProvider

    • setDataCacheMode

      void setDataCacheMode(String mode)
      Set the DataCacheMode
      Parameters:
      mode - One of the Sting constants from DataCacheMode
      Since:
      2.0.0

    • getDataCacheMode

      String getDataCacheMode()
      Return the String constant that matches the DataCacheMode
      Returns:
      DataCacheMode
      Since:
      2.0.0

    • getCacheDistributionPolicyInstance

      CacheDistributionPolicy getCacheDistributionPolicyInstance()
      Gets the policy object that determines distribution of cached instances across named partitions of L2 data cache.
      Returns:
      an implementation of CacheDistributionPolicy.
      Since:
      2.0.0

    • setCacheDistributionPolicyInstance

      void setCacheDistributionPolicyInstance(CacheDistributionPolicy policy)
      Sets the policy object that determines distribution of cached instances across named partitions of L2 data cache.
      Parameters:
      policy - a non-null implementation of CacheDistributionPolicy.
      Since:
      2.0.0

    • getCacheDistributionPolicy

      String getCacheDistributionPolicy()
      Gets the plug-in string that described the policy to distribute cached instances across named partitions of L2 data cache.
      Returns:
      a plug-in string for CacheDistributionPolicy.
      Since:
      2.0.0

    • setCacheDistributionPolicy

      void setCacheDistributionPolicy(String policyPlugin)
      Sets the plug-in string that describes the policy to distribute cached instances across named partitions of L2 data cache.
      Parameters:
      a - plug-in string for CacheDistributionPolicy.
      Since:
      2.0.0

    • getInstrumentation

      String getInstrumentation()
      Gets the plug-in string that defines instrumentation providers and what they instrument.
      Returns:
      a plug-in string for the instrumentation configuration
      Since:
      2.1.0

    • setInstrumentation

      void setInstrumentation(String providers)
      Sets the plug-in string that defines instrumentation providers and what they instrument.
      Parameters:
      providers - a plug-in string for the instrumentation configuration
      Since:
      2.1.0

    • getInstrumentationManagerInstance

      InstrumentationManager getInstrumentationManagerInstance()
      Gets an instance of the instrumentation manager. The instrumentation provides access to configured instrumentation providers and can be used to manage them at runtime.
      Returns:
      an instance of the instrumentation manager
      Since:
      2.1.0

    • getAuditorInstance

      Auditor getAuditorInstance()
      Gets the singular instance of Auditor associated with this configuration.
      Since:
      2.2.0

    • setAuditorInstance

      void setAuditorInstance(Auditor auditor)
      Sets the singular instance of Auditor associated with this configuration.
      Since:
      2.2.0

    • getAuditor

      String getAuditor()
      Gets the plug-in string of Auditor specified in this configuration.
      Since:
      2.2.0

    • setAuditor

      void setAuditor(String s)
      Sets the plug-in string of Auditor specified in this configuration.
      Since:
      2.2.0

    • getPostLoadOnMerge

      boolean getPostLoadOnMerge()
      Whether to send @PostLoad events on a merge operation.
      Since:
      2.2.0

    • setPostLoadOnMerge

      void setPostLoadOnMerge(boolean postLoadOnMerge)
      Whether to send @PostLoad events on a merge operation.
      Since:
      2.2.0

    • setPostLoadOnMerge

      void setPostLoadOnMerge(Boolean postLoadOnMerge)
      Whether to send @PostLoad events on a merge operation.
      Since:
      2.2.0

    • getOptimizeIdCopy

      boolean getOptimizeIdCopy()
      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.
      Since:
      2.2.0

    • setOptimizeIdCopy

      void setOptimizeIdCopy(boolean optimizeIds)
      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.
      Since:
      2.2.0

    • setOptimizeIdCopy

      void setOptimizeIdCopy(Boolean optimizeIds)
      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.
      Since:
      2.2.0

    • getUseTCCLinSelectNew

      boolean getUseTCCLinSelectNew()
      Indicates if the Thread#contextClassLoader should be used as fallback if the result class for select new is not found by the classloader of the entity.
      Since:
      2.4.2

    • setUseTCCLinSelectNew

      void setUseTCCLinSelectNew(boolean useTcclForSelectNew)
      Indicates if the Thread#contextClassLoader should be used as fallback if the result class for select new is not found by the classloader of the entity.
      Since:
      2.4.2

    • setUseTCCLinSelectNew

      void setUseTCCLinSelectNew(Boolean useTcclForSelectNew)
      Indicates if the Thread#contextClassLoader should be used as fallback if the result class for select new is not found by the classloader of the entity.
      Since:
      2.4.2

    • getDatabaseAction

      String getDatabaseAction()
      database action from the persistence unit. See 'jakarta.persistence.schema-generation.database.action'
      Returns:
      openjpa internal schemaAction which corresponds to the JPA action.
      Since:
      3.0.0

    • getDatabaseActionConstant

      int getDatabaseActionConstant()
      Since:
      3.0.0
      See Also:

    • getScriptsAction

      String getScriptsAction()
      Similar to getDatabaseAction() but write the generated SQL to files.
      Since:
      3.0.0
      See Also:

    • getScriptsActionConstant

      int getScriptsActionConstant()
      Since:
      3.0.0
      See Also:

    • getCreateSource

      String getCreateSource()
      Optional run a DB action before accessing the database. The possible values in the persistence unit are:
      Since:
      3.0.0
      See Also:

    • getCreateSourceConstant

      int getCreateSourceConstant()
      Since:
      3.0.0
      See Also:

    • getDropSource

      String getDropSource()
      Similar to getCreateSource() but for dropping the database schema and content.
      Since:
      3.0.0
      See Also:

    • getDropSourceConstant

      int getDropSourceConstant()
      Since:
      3.0.0
      See Also:

    • getCreateScriptSource

      String getCreateScriptSource()
      Since:
      3.0.0
      See Also:

    • getDropScriptSource

      String getDropScriptSource()
      Since:
      3.0.0
      See Also:

    • getCreateScriptTarget

      String getCreateScriptTarget()
      Since:
      3.0.0
      See Also:

    • getDropScriptTarget

      String getDropScriptTarget()
      Since:
      3.0.0
      See Also:

    • getLoadScriptSource

      String getLoadScriptSource()
      Can be used to load a set of initial data into the database.
      Since:
      3.0.0

    • getTypesWithoutEnhancement

      Collection<Class<?>> getTypesWithoutEnhancement()
      Returns:
      types which should not get enhanced although they are on the included directories.
      Since:
      3.1.1

    • setTypesWithoutEnhancement

      void setTypesWithoutEnhancement(Collection<Class<?>> typesWithoutEnhancement)
      Since:
      3.1.1
      See Also: