com.solarmetric.kodo.impl.jdbc
Interface JDBCConfiguration

All Superinterfaces:

Cloneable, Configuration, Serializable

All Known Subinterfaces:

EEConfiguration

All Known Implementing Classes:

JDBCSimpleConfiguration

public interface JDBCConfiguration

extends Configuration

Configuration that defines the properties necessary to configure runtime and connect to a JDBC DataSource.

In addition to those supported by the Configuration, the following properties are recognized:

• com.solarmetric.kodo.impl.jdbc.AutoReturnTimeout
• com.solarmetric.kodo.impl.jdbc.DictionaryClass
• com.solarmetric.kodo.impl.jdbc.DictionaryProperties
• com.solarmetric.kodo.impl.jdbc.SequenceFactoryClass
• com.solarmetric.kodo.impl.jdbc.SequenceFactoryProperties
• com.solarmetric.kodo.impl.jdbc.PersistentTypes (comma-separated)
• com.solarmetric.kodo.impl.jdbc.WarnOnPeristentTypeFailure

In addition to those supported by the DefaultConfiguration, the following XML preferences are recognized:

• /prefs/db/username
• /prefs/db/password
• /prefs/db/driver
• /prefs/db/url
• /prefs/db/dictionary
• /prefs/db/pool/timeout
• /prefs/db/pool/autoreturn
• /prefs/db/pool/min
• /prefs/db/pool/max
• /prefs/db/sequence/increment
• /prefs/db/schema-name
• /prefs/db/warn-on-persistent-type-failure
• /prefs/db/table-type
• /prefs/db/name-truncation-version
• /prefs/db/persistent-types
• /prefs/db/data-cache-class

Author:

Marc Prud'hommeaux

Method Summary

int	getAutoReturnTimeout() The number of seconds to wait before automatically reclaiming an in-use connection
DBDictionary	getDictionary() The DBDictionary to use.
String	getDictionaryClass() The dictionary class to use to define the RDBMS SQL information
String	getDictionaryProperties() Configuration options for the dictionary.
boolean	getFlatInheritanceMapping() Return whether or not a flat inheritance mapping strategy should be used by default.
String[]	getPersistentTypes() The names of all the persistent types registered with the configured database.
SequenceFactory	getSequenceFactory() The SequenceFactory to use.
String	getSequenceFactoryClass() The class name of the SequenceFactory implementation.
String	getSequenceFactoryProperties() Configuration properties for the sequence factory.
boolean	getWarnOnPersistentTypeFailure() Warn (rather than throw an exception) when the class in the data store's persistent metadata is not found.
void	setAutoReturnTimeout(int timeout) The number of seconds to wait before automatically reclaiming an in-use connection
void	setDictionary(DBDictionary dict) The DBDictionary to use.
void	setDictionaryClass(String clsName) The dictionary class to use to define the RDBMS SQL information
void	setDictionaryProperties(String props) Configuration options for the dictionary.
void	setFlatInheritanceMapping(boolean map) Configure the default inheritance hierarchy mapping strategy.
void	setPersistentTypes(String[] clsNames) The names of all the persistent types registered with the configured database.
void	setSequenceFactory(SequenceFactory seq) The SequenceFactory to use.
void	setSequenceFactoryClass(String clsName) The class name of the SequenceFactory implementation.
void	setSequenceFactoryProperties(String props) Configuration properties for the sequence factory.
void	setWarnOnPersistentTypeFailure(boolean warn) Warn (rather than throw an exception) when the class in the data store's persistent metadata is not found.

Methods inherited from interface com.solarmetric.kodo.conf.Configuration

clone, configurationClone, freeze, fromProperties, getConnectionDriverName, getConnectionFactory, getConnectionFactory2, getConnectionFactory2Name, getConnectionFactoryName, getConnectionPassword, getConnectionURL, getConnectionUserName, getDataCache, getDataCacheClass, getDataCacheProperties, getDefaultFetchBatchSize, getDefaultFetchThreshold, getEnableQueryExtensions, getIgnoreCache, getLicenseKey, getLogger, getLogWriter, getMaxPool, getMinPool, getMsWait, getMultithreaded, getNontransactionalRead, getNontransactionalWrite, getOptimistic, getPersistenceManagerClass, getPersistenceManagerFactoryClass, getPersistenceManagerProperties, getProxyManager, getProxyManagerClass, getProxyManagerProperties, getQueryFilterListeners, getRestoreValues, getRetainValues, isFrozen, setConnectionDriverName, setConnectionFactory, setConnectionFactory2, setConnectionFactory2Name, setConnectionFactoryName, setConnectionPassword, setConnectionURL, setConnectionUserName, setDataCache, setDataCacheClass, setDataCacheProperties, setDefaultFetchBatchSize, setDefaultFetchThreshold, setEnableQueryExtensions, setIgnoreCache, setLicenseKey, setLogger, setLogWriter, setMaxPool, setMinPool, setMsWait, setMultithreaded, setNontransactionalRead, setNontransactionalWrite, setOptimistic, setPersistenceManagerClass, setPersistenceManagerFactoryClass, setPersistenceManagerProperties, setProxyManager, setProxyManagerClass, setProxyManagerProperties, setQueryFilterListeners, setRestoreValues, setRetainValues, toProperties

Method Detail

getAutoReturnTimeout

public int getAutoReturnTimeout()

The number of seconds to wait before automatically reclaiming an in-use connection

setAutoReturnTimeout

public void setAutoReturnTimeout(int timeout)

The number of seconds to wait before automatically reclaiming an in-use connection

getDictionaryClass

public String getDictionaryClass()

The dictionary class to use to define the RDBMS SQL information

setDictionaryClass

public void setDictionaryClass(String clsName)

The dictionary class to use to define the RDBMS SQL information

getDictionaryProperties

public String getDictionaryProperties()

Configuration options for the dictionary.

setDictionaryProperties

public void setDictionaryProperties(String props)

Configuration options for the dictionary.

getDictionary

public DBDictionary getDictionary()

The DBDictionary to use. If a dictionary has been explicitly set via the setDictionary(com.solarmetric.kodo.impl.jdbc.schema.DBDictionary) method, it will be returned. Otherwise, if the dictionary class has been set, a new instance of the class will created and configured with any set dictionary properties. This instance will be cached for subsequence calls to this method. Finally, if no dictionary class has been set a default dictionary will be returned.

setDictionary

public void setDictionary(DBDictionary dict)

The DBDictionary to use.

getSequenceFactoryClass

public String getSequenceFactoryClass()

The class name of the SequenceFactory implementation.

setSequenceFactoryClass

public void setSequenceFactoryClass(String clsName)

The class name of the SequenceFactory implementation.

getSequenceFactoryProperties

public String getSequenceFactoryProperties()

Configuration properties for the sequence factory.

setSequenceFactoryProperties

public void setSequenceFactoryProperties(String props)

Configuration properties for the sequence factory.

getSequenceFactory

public SequenceFactory getSequenceFactory()

The SequenceFactory to use. If a sequence factory has been explicitly set via the setSequenceFactory(com.solarmetric.kodo.impl.jdbc.SequenceFactory) method, it will be returned. Otherwise, if the sequence factory class has been set, a new instance of the class will created and configured with any set sequence factory properties. This instance will be cached for subsequence calls to this method. Finally, if no sequence factory class has been seta default sequence factory will be returned.

setSequenceFactory

public void setSequenceFactory(SequenceFactory seq)

The SequenceFactory to use.

getPersistentTypes

public String[] getPersistentTypes()

The names of all the persistent types registered with the configured database.

setPersistentTypes

public void setPersistentTypes(String[] clsNames)

The names of all the persistent types registered with the configured database.

getWarnOnPersistentTypeFailure

public boolean getWarnOnPersistentTypeFailure()

Warn (rather than throw an exception) when the class in the data store's persistent metadata is not found.

setWarnOnPersistentTypeFailure

public void setWarnOnPersistentTypeFailure(boolean warn)

Warn (rather than throw an exception) when the class in the data store's persistent metadata is not found.

getFlatInheritanceMapping

public boolean getFlatInheritanceMapping()

Return whether or not a flat inheritance mapping strategy should be used by default. If true, then all fields of all classes in a given inheritance hierarchy will by default map into the least-derived type's default primary table. If false then a new default primary table will be created for each class in the inheritance hierarchy, and each type's declared fields will map to that table by default.

setFlatInheritanceMapping

public void setFlatInheritanceMapping(boolean map)

Configure the default inheritance hierarchy mapping strategy.