| Method from org.apache.openjpa.conf.OpenJPAConfiguration Detail: |
public AggregateListener[] getAggregateListenerInstances()
Return the query function listeners. If none have been set explicitly,
this method instantiates the listeners from the set plugin list. |
public String getAggregateListeners()
|
public String getAutoClear()
Whether instances clear their state when entering a transaction. |
public int getAutoClearConstant()
|
public 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.
|
public int getAutoDetachConstant()
|
public String getBrokerFactory()
|
public BrokerFactoryEventManager getBrokerFactoryEventManager()
|
public String getBrokerImpl()
The plugin string of the BrokerImpl extension to create. |
public Map getCacheMarshallerInstances()
Return the cache marshaller listeners. |
public String getCacheMarshallers()
A comma-separted list of the plugin strings specifying the
CacheMarshaller s to use. |
public String getClassResolver()
The plugin string for the ClassResolver to use for custom
class loading. |
public ClassResolver getClassResolverInstance()
|
public String getCompatibility()
Backwards compatibility options. |
public Compatibility getCompatibilityInstance()
Backwards compatibility options. |
public String getConnection2DriverName()
Class name of the non-XA connection driver. |
public String getConnection2Password()
The password for the non-XA data store connection. |
public String getConnection2Properties()
These properties provide any additional information needed to
establish non-XA connections. |
public String getConnection2URL()
The URL for the non-XA data store connection. |
public String getConnection2UserName()
The user name for the non-XA data store connection. |
public String getConnectionDriverName()
Class name of the connection driver. |
public Object getConnectionFactory()
The connection factory, possibly from JNDI. |
public Object getConnectionFactory2()
The non-XA connection factory. |
public String getConnectionFactory2Name()
The name for the second data store connection factory. |
public String getConnectionFactory2Properties()
Configuration properties for the non-XA connection factory. |
public 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. |
public String getConnectionFactoryName()
The name for the data store connection factory. |
public String getConnectionFactoryProperties()
Configuration properties for the connection factory. |
public String getConnectionPassword()
The password for the data store connection. |
public String getConnectionProperties()
These properties provide any additional information needed to
establish connections. |
public 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.
|
public int getConnectionRetainModeConstant()
Return the connection retain mode as one of the following symbolic
constants:
|
public String getConnectionURL()
The URL for the data store connection. |
public String getConnectionUserName()
The user name for the data store connection. |
public String getDataCache()
The DataCache to use for level-2 data store caching. |
public String getDataCacheManager()
The data cache manager manages this configuration's cache instances. |
public 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. |
public int getDataCacheTimeout()
Default data cache timeout. |
public DetachOptions getDetachStateInstance()
Return the instance specified by the detach state plugin. |
public boolean getDynamicDataStructs()
Return whether to generate dynamic data structures
where possible for cache and runtime usage. |
public 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. |
public String getFetchGroups()
Comma-separated list of fetch group names that will be pre-set for
all new FetchConfiguration s. |
public String[] getFetchGroupsList()
|
public FilterListener[] getFilterListenerInstances()
Return the query filter listeners. If none have been set explicitly,
this method instantiates the listeners from the set plugin list. |
public String getFilterListeners()
A comma-separted list of the plugin strings of the query
FilterListener s to use. |
public String getFlushBeforeQueries()
Returns whether or not OpenJPA should automatically flush
modifications to the data store before executing queries. |
public int getFlushBeforeQueriesConstant()
|
public boolean getIgnoreChanges()
Whether changes in the current transaction are taken into account when
executing queries and iterating extents. |
public String getInverseManager()
The plugin to use for managing inverse relations. |
public String getLockManager()
The plugin to use for datastore lock management. |
public int getLockTimeout()
The time to wait for an object lock in milliseconds, or -1 for no
timeout. |
public String getManagedRuntime()
The plugin string for the ManagedRuntime to use for managed
environments. |
public ManagedRuntime getManagedRuntimeInstance()
The plugin to use for integrating with a managed runtime. |
public String getMapping()
The name mapping to use for this data store. |
public int getMaxFetchDepth()
The maximum relation depth to traverse when eager fetching. Use
-1 for no limit. |
public String getMetaDataFactory()
|
public String getMetaDataRepository()
|
public MetaDataRepository getMetaDataRepositoryInstance()
The metadata repository of managed class information. If no
repository has been set, creates one. |
public boolean getMultithreaded()
Whether brokers or their managed objects will be used by multiple
concurrent threads. |
public boolean getNontransactionalRead()
Whether persistent state is accessible outside a transaction by default. |
public boolean getNontransactionalWrite()
Whether persistent state can be modified outside a transaction by
default. |
public boolean getOptimistic()
Whether to use optimistic transactions by default. |
public String getOrphanedKeyAction()
The action to take when an orphaned key is detected. |
public OrphanedKeyAction getOrphanedKeyActionInstance()
The action to take when an orphaned key is detected. |
public String getProxyManager()
The plugin string for the ProxyManager to use for second
class object proxies. |
public ProxyManager getProxyManagerInstance()
|
public String getQueryCache()
The plugin to use for level-2 data store query caching. |
public String getQueryCompilationCache()
Configuration settings for the query compilation cache to use. |
public Map getQueryCompilationCacheInstance()
Configuration settings for the query compilation cache to use. |
public String getReadLockLevel()
The default read lock level to use during non-optimistic transactions.
Defaults to read. |
public int getReadLockLevelConstant()
The numeric read lock level. |
public RemoteCommitEventManager getRemoteCommitEventManager()
The remote event manager that manages this configuration's remote
event listeners. |
public String getRemoteCommitProvider()
The plugin to use for remote commit notification. |
public String getRestoreState()
Whether to restore initial state on rollback by default. |
public int getRestoreStateConstant()
|
public boolean getRetainState()
Whether to retain state after a transaction by default. |
public 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. |
public 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.
|
public int getRuntimeUnenhancedClassesConstant()
Return the runtime class optimization setting as one of the
following symbolic constants:
|
public String getSavepointManager()
The plugin to use for savepoint management. |
public SavepointManager getSavepointManagerInstance()
Return the configured savepoint manager instance. |
public String getSequence()
Plugin string for the default system Seq . |
public Seq getSequenceInstance()
The default system sequence. |
public String getSpecification()
A configuration can be set with defaults for a specific specification. |
public StoreFacadeTypeRegistry getStoreFacadeTypeRegistry()
|
public String getTransactionMode()
Specifies the behavior of the transaction model. Possible values are:
local: Perform transaction operations locally.
managed: Use managed environment's global
transactions.
|
public String getWriteLockLevel()
The default write lock level to use during non-optimistic transactions.
Defaults to write. |
public int getWriteLockLevelConstant()
The numeric write lock level. |
public boolean isConnectionFactoryModeManaged()
Whether connections are automatically enlisted in global transactions. |
public boolean isTransactionModeManaged()
Return whether managed transactions are being used. |
public boolean metaDataRepositoryAvailable()
Returns true if a metaDataRepository has been created for this
configuration. |
public BrokerImpl newBrokerInstance(String user,
String pass)
Create a new broker instance with the configured plugin data. |
public InverseManager newInverseManagerInstance()
Return a new inverse manager instance using the configured plugin
settings. |
public LockManager newLockManagerInstance()
Return a new lock manager instance using the configured plugin settings. |
public MetaDataFactory newMetaDataFactoryInstance()
|
public MetaDataRepository newMetaDataRepositoryInstance()
Create a new empty metadata repository of the configured type. |
public RemoteCommitProvider newRemoteCommitProviderInstance()
Create a remote commit provider from the configured plugin. |
public void setAggregateListeners(String listeners)
|
public void setAggregateListeners(AggregateListener[] listeners)
Set the query function listeners. Overrides the list of listener classes. |
public void setAutoClear(String clear)
Whether instances clear their state when entering a transaction. |
public void setAutoClear(int clear)
Whether instances clear their state when entering a transaction. |
public 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.
|
public void setAutoDetach(int flags)
|
public void setBrokerFactory(String factory)
|
public void setBrokerImpl(String broker)
The plugin string of the BrokerImpl extension to create. |
public void setCacheMarshallers(String marshallers)
A comma-separted list of the plugin strings specifying the
CacheMarshaller s to use. |
public void setClassResolver(String classResolver)
The plugin string for the ClassResolver to use for custom
class loading. |
public void setClassResolver(ClassResolver classResolver)
|
public void setCompatibility(String compatibility)
Backwards compatibility options. |
public void setConnection2DriverName(String driverName)
Class name of the non-XA connection driver. |
public void setConnection2Password(String connectionPassword)
The password for the non-XA data store connection. |
public void setConnection2Properties(String props)
These properties provide any additional information needed to
establish non-XA connections. |
public void setConnection2URL(String connectionURL)
The URL for the non-XA data store connection. |
public void setConnection2UserName(String connectionUserName)
The user name for the non-XA data store connection. |
public void setConnectionDriverName(String driverName)
Class name of the connection driver. |
public void setConnectionFactory(Object factory)
|
public void setConnectionFactory2(Object factory)
The non-XA connection factory. |
public void setConnectionFactory2Name(String cf2Name)
The name for the second data store connection factory. |
public void setConnectionFactory2Properties(String props)
Configuration properties for the non-XA connection factory. |
public 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. |
public void setConnectionFactoryModeManaged(boolean managed)
Whether connections are automatically enlisted in global transactions. |
public void setConnectionFactoryName(String cfName)
The name for the data store connection factory. |
public void setConnectionFactoryProperties(String props)
Configuration properties for the connection factory. |
public void setConnectionPassword(String connectionPassword)
The password for the data store connection. |
public void setConnectionProperties(String props)
These properties provide any additional information needed to
establish connections. |
public 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.
|
public void setConnectionRetainMode(int mode)
Set the connection retain mode as one of the following symbolic
constants:
|
public void setConnectionURL(String connectionURL)
The URL for the data store connection. |
public void setConnectionUserName(String connectionUserName)
The user name for the data store connection. |
public void setDataCache(String dataCache)
The DataCache to use for level-2 data store caching. |
public void setDataCacheManager(String mgr)
The data cache manager manages this configuration's cache instances. |
public void setDataCacheManager(DataCacheManager manager)
The data cache manager manages this configuration's cache instances. |
public void setDataCacheTimeout(int timeout)
Default data cache timeout. |
public void setDataCacheTimeout(Integer timeout)
|
public void setDetachState(String detachState)
Which field values to include when detaching. |
public void setDetachState(DetachOptions detachState)
Return the instance specified by the detach state plugin. |
public void setDynamicDataStructs(boolean dynamic)
Set whether to generate dynamic data structures
where possible for cache and runtime usage. |
public void setDynamicDataStructs(Boolean dynamic)
|
public 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. |
public void setFetchBatchSize(Integer size)
|
public void setFetchGroups(String groups)
Comma-separated list of fetch group names that will be pre-set for
all new FetchConfiguration s. |
public void setFetchGroups(String[] names)
|
public void setFilterListeners(String listeners)
A comma-separted list of the plugin strings of the query
FilterListener s to use. |
public void setFilterListeners(FilterListener[] listeners)
Set the query filter listeners. Overrides the list of listener classes. |
public void setFlushBeforeQueries(String flush)
Sets whether or not OpenJPA should automatically flush
modifications to the data store before executing queries. |
public void setFlushBeforeQueries(int flushBeforeQueries)
|
public void setIgnoreChanges(boolean ignoreChanges)
Whether changes in the current transaction are taken into account when
executing queries and iterating extents. |
public void setIgnoreChanges(Boolean ignoreChanges)
|
public void setInverseManager(String inverse)
The plugin to use for managing inverse relations. |
public void setLockManager(String lockManager)
The plugin to use for datastore lock management. |
public void setLockTimeout(int timeout)
The time to wait for an object lock in milliseconds, or -1 for no
timeout. |
public void setLockTimeout(Integer timeout)
|
public void setManagedRuntime(String managedRuntime)
The plugin string for the ManagedRuntime to use for managed
environments. |
public void setManagedRuntime(ManagedRuntime runtime)
The plugin to use for integrating with a managed runtime. |
public void setMapping(String mapping)
The name mapping to use for this data store. |
public void setMaxFetchDepth(int depth)
The maximum relation depth to traverse when eager fetching. Use
-1 for no limit. |
public void setMaxFetchDepth(Integer size)
|
public void setMetaDataFactory(String meta)
|
public void setMetaDataRepository(String meta)
|
public void setMetaDataRepository(MetaDataRepository mdRepos)
The metadata repository of managed class information. |
public void setMultithreaded(boolean multithreaded)
Whether brokers or their managed objects will be used by multiple
concurrent threads. |
public void setMultithreaded(Boolean multithreaded)
|
public void setNontransactionalRead(boolean ntRead)
Whether persistent state is accessible outside a transaction by default. |
public void setNontransactionalRead(Boolean ntRead)
|
public void setNontransactionalWrite(boolean ntWrite)
Whether persistent state can be modified outside a transaction by
default. |
public void setNontransactionalWrite(Boolean ntWrite)
|
public void setOptimistic(boolean optimistic)
Whether to use optimistic transactions by default. |
public void setOptimistic(Boolean optimistic)
|
public void setOrphanedKeyAction(String action)
The action to take when an orphaned key is detected. |
public void setOrphanedKeyAction(OrphanedKeyAction action)
The action to take when an orphaned key is detected. |
public void setProxyManager(String proxyManager)
The plugin string for the ProxyManager to use for second
class object proxies. |
public void setProxyManager(ProxyManager manager)
|
public void setQueryCache(String queryCache)
The plugin to use for level-2 data store query caching. |
public void setQueryCompilationCache(String conf)
Configuration settings for the query compilation cache to use. |
public void setReadLockLevel(String level)
The default read lock level to use during non-optimistic transactions.
Defaults to read. |
public void setReadLockLevel(int level)
The numeric read lock level. |
public void setRemoteCommitEventManager(RemoteCommitEventManager manager)
The remote event manager that manages this configuration's remote
event listeners. |
public void setRemoteCommitProvider(String remoteCommitProvider)
The plugin to use for remote commit notification. |
public void setRestoreState(String restoreState)
Whether to restore initial state on rollback by default. |
public void setRestoreState(int restoreState)
Whether to restore initial state on rollback by default. |
public void setRetainState(boolean retainState)
Whether to retain state after a transaction by default. |
public void setRetainState(Boolean retainState)
|
public 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. |
public void setRetryClassRegistration(Boolean warn)
|
public void setRuntimeUnenhancedClasses(String mode)
Specifies how OpenJPA handles unenhanced types. |
public void setRuntimeUnenhancedClasses(int mode)
Set the runtime class optimization setting as one of the
following symbolic constants:
|
public void setSavepointManager(String savepointManager)
The plugin to use for savepoint management. |
public void setSequence(String sequence)
Plugin string for the default system Seq . |
public void setSequence(Seq sequence)
The default system sequence. |
public boolean setSpecification(String spec)
Set the specification that this configuration should use for the
various properties that need to have different defaults for different
spec environments. This should be invoked before any configuration
options are set, as it will mutate various values.
You can only assign the specification once, though it is not fatal
to attempt to do so multiple times. Attempts to set to null will
be ignored. |
public 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.
|
public void setTransactionModeManaged(boolean managed)
Set whether managed transactions are being used. |
public void setWriteLockLevel(String level)
The default write lock level to use during non-optimistic transactions.
Defaults to write. |
public void setWriteLockLevel(int level)
The numeric write lock level. |
public Collection supportedOptions()
Return the set of option strings supported by this runtime. This set
is mutable. |