Package org.apache.openjpa.jdbc.conf

Interface JDBCConfiguration

All Superinterfaces:
BeanInfo, Cloneable, Closeable, Configuration, OpenJPAConfiguration, Serializable
All Known Subinterfaces:
DistributedJDBCConfiguration
All Known Implementing Classes:
DistributedJDBCConfigurationImpl, JDBCConfigurationImpl
public interface JDBCConfiguration extends OpenJPAConfiguration
Configuration that defines the properties necessary to configure runtime and connect to a JDBC DataSource.
Author:
Marc Prud'hommeaux

  • Field Details

    • LOG_SQL

      static final String LOG_SQL
      Name of the logger for SQL execution messages: openjpa.jdbc.SQL.
      See Also:

    • LOG_DIAG

      static final String LOG_DIAG
      Name of the logger for additional jdbc messages: openjpa.jdbc.DIAG.
      See Also:

    • LOG_JDBC

      static final String LOG_JDBC
      Name of the logger for JDBC-related messages: openjpa.jdbc.JDBC.
      See Also:

    • LOG_SCHEMA

      static final String LOG_SCHEMA
      Name of the logger for schema-related messages: openjpa.jdbc.Schema.
      See Also:

  • Method Details

    • getSchema

      String getSchema()
      Default schema for unqualified tables.

    • setSchema

      void setSchema(String schema)
      Default schema for unqualified tables.

    • getSchemas

      String getSchemas()
      Comma-separated list of modifiable schemas for persistent instances.

    • setSchemas

      void setSchemas(String schemas)
      Comma-separated list of modifiable schemas for persistent instances.

    • getSchemasList

      String[] getSchemasList()
      Modificable schema components.

    • setSchemas

      void setSchemas(String[] schemas)
      Modifiable schema components.

    • getTransactionIsolation

      String getTransactionIsolation()
      The transaction isolation level to use at the database level. Possible values are:

    • setTransactionIsolation

      void setTransactionIsolation(String level)
      The transaction isolation level to use at the database level. Possible values are:

    • getTransactionIsolationConstant

      int getTransactionIsolationConstant()
      Return the proper transaction isolation level constant from Connection, or -1 for the default level.

    • setTransactionIsolation

      void setTransactionIsolation(int level)
      Set the proper transaction isolation level constant from Connection, or -1 for the default level.

    • getResultSetType

      String getResultSetType()
      The JDBC result set type. Defaults to forward-only.

    • getResultSetTypeConstant

      int getResultSetTypeConstant()
      Return the result set constant for the result set type.

    • setResultSetType

      void setResultSetType(String type)
      The JDBC result set type. Defaults to forward-only.

    • setResultSetType

      void setResultSetType(int type)
      Set the result set constant type.

    • getFetchDirection

      String getFetchDirection()
      The JDBC fetch direction. Defaults to forward.

    • getFetchDirectionConstant

      int getFetchDirectionConstant()
      Return the result set constant for the fetch direction.

    • setFetchDirection

      void setFetchDirection(String direction)
      The JDBC fetch direction. Defaults to forward.

    • setFetchDirection

      void setFetchDirection(int direction)
      Set the result set fetch direction constant.

    • getEagerFetchMode

      String getEagerFetchMode()
      Specifies the default eager fetch mode to use. Defaults to parallel unless the query is by-oid. Possible values are:
      • none: When querying for an object, do not try to select for related objects at the same time.
      • join: When querying for objects, also select for 1-1 relations in the configured fetch groups using joins.
      • parallel: When querying for objects, also select for both 1-1 relations using joins and to-many relations using batched selects.
      Since:
      0.3.0

    • setEagerFetchMode

      void setEagerFetchMode(String mode)
      Specifies the default eager fetch mode to use. Defaults to parallel unless the query is by-oid. Possible values are:
      • none: When querying for an object, do not try to select for related objects at the same time.
      • join: When querying for objects, also select for 1-1 relations in the configured fetch groups using joins.
      • parallel: When querying for objects, also select for both 1-1 relations using joins and to-many relations using batched selects.

    • getEagerFetchModeConstant

      int getEagerFetchModeConstant()
      Return the eager fetch mode as one of the following symbolic constants:
      Since:
      0.3.0

    • setEagerFetchMode

      void setEagerFetchMode(int eagerFetchMode)
      Set the eager fetch mode as one of the following symbolic constants:
      Since:
      0.3.0

    • getSubclassFetchMode

      String getSubclassFetchMode()
      Specifies the default subclass fetch mode to use. Defaults to join unless the query is by-oid. Possible values are:
      • none: Only select base class data.
      • join: Select both base class and all possible subclass data using joins.
      • parallel: Select for each possible subclass separately.
      Since:
      0.3.2

    • setSubclassFetchMode

      void setSubclassFetchMode(String mode)
      Specifies the default subclass fetch mode to use. Defaults to join unless the query is by-oid. Possible values are:
      • none: Only select base class data.
      • join: Select both base class and all possible subclass data using joins.
      • parallel: Select for each possible subclass separately.
      Since:
      0.3.2

    • getSubclassFetchModeConstant

      int getSubclassFetchModeConstant()
      Return the subclass fetch mode as one of the following symbolic constants:
      Since:
      0.3.2

    • setSubclassFetchMode

      void setSubclassFetchMode(int subclassFetchMode)
      Set the subclass fetch mode as one of the following symbolic constants:
      Since:
      0.3.2

    • getLRSSize

      String getLRSSize()
      How to obtain the size of large result sets. Defaults to unknown.
      • unknown: Do not attempt to calculate the size of large result sets; return Integer.MAX_VALUE.
      • last: For result sets that support random access, calculate the size using ResultSet.last().
      • query: Use a separate COUNT query to calculate the size of the results.

    • getLRSSizeConstant

      int getLRSSizeConstant()
      Return the LRSSizes constant for the large result set size setting.

    • setLRSSize

      void setLRSSize(String lrsSize)
      How to obtain the size of large result sets. Defaults to unknown.
      • unknown: Do not attempt to calculate the size of large result sets; return Integer.MAX_VALUE.
      • last: For result sets that support random access, calculate the size using ResultSet.last().
      • query: Use a separate COUNT query to calculate the size of the results.

    • setLRSSize

      void setLRSSize(int size)
      Set the fetch configuration large result set size constant.

    • getSynchronizeMappings

      String getSynchronizeMappings()
      Whether OpenJPA should try to automatically refresh O/R mapping information and the database schema.

    • setSynchronizeMappings

      void setSynchronizeMappings(String synchronizeMappings)
      Whether OpenJPA should try to automatically refresh O/R mapping information and the database schema.

    • getJDBCListeners

      String getJDBCListeners()
      A comma-separated list of the JDBCListener plugins for listening to JDBCEvents.

    • setJDBCListeners

      void setJDBCListeners(String jdbcListeners)
      A comma-separated list of the JDBCListener plugins for listening to JDBCEvents.

    • getJDBCListenerInstances

      JDBCListener[] getJDBCListenerInstances()
      The JDBCListeners to use.

    • setJDBCListeners

      void setJDBCListeners(JDBCListener[] jdbcListeners)
      The JDBCListeners to use.

    • getConnectionDecorators

      String getConnectionDecorators()
      A comma-separated list of the ConnectionDecorator for adding functionality to JDBC connections.

    • setConnectionDecorators

      void setConnectionDecorators(String decorators)
      A comma-separated list of the ConnectionDecorator for adding functionality to JDBC connections.

    • getConnectionDecoratorInstances

      ConnectionDecorator[] getConnectionDecoratorInstances()
      The ConnectionDecorators to use.

    • setConnectionDecorators

      void setConnectionDecorators(ConnectionDecorator[] decorators)
      The ConnectionDecorators to use.

    • getDBDictionary

      String getDBDictionary()
      The DBDictionary to use to define the RDBMS SQL information.

    • setDBDictionary

      void setDBDictionary(String dbdictionary)
      The DBDictionary to use to define the RDBMS SQL information.

    • getDBDictionaryInstance

      DBDictionary getDBDictionaryInstance()
      The DBDictionary to use.

    • setDBDictionary

      void setDBDictionary(DBDictionary dbdictionary)
      The DBDictionary to use.

    • getUpdateManager

      String getUpdateManager()
      The UpdateManager to use for managing SQL updates.

    • setUpdateManager

      void setUpdateManager(String updateManager)
      The UpdateManager to use for managing SQL updates.

    • getUpdateManagerInstance

      UpdateManager getUpdateManagerInstance()
      The UpdateManager for runtime data store interaction.

    • setUpdateManager

      void setUpdateManager(UpdateManager updateManager)
      The UpdateManager for runtime data store interaction.

    • getDriverDataSource

      String getDriverDataSource()
      The DriverDataSource to use for creating a DataSource from a JDBC Driver.

    • setDriverDataSource

      void setDriverDataSource(String driverDataSource)
      The DriverDataSource to use for creating a DataSource from a JDBC Driver.

    • newDriverDataSourceInstance

      DriverDataSource newDriverDataSourceInstance()
      Create an instance of the DriverDataSource to use for creating a DataSource from a JDBC Driver.

    • getSchemaFactory

      String getSchemaFactory()
      The plugin string for the SchemaFactory to use to provide schema information during system initialization.

    • setSchemaFactory

      void setSchemaFactory(String schemaFactory)
      The plugin string for the SchemaFactory to use to provide schema information during system initialization.

    • getSchemaFactoryInstance

      SchemaFactory getSchemaFactoryInstance()
      The SchemaFactory to use for schema information.

    • setSchemaFactory

      void setSchemaFactory(SchemaFactory schemaFactory)
      The SchemaFactory to use for schema information.

    • getSQLFactory

      String getSQLFactory()
      The SQL factory to use for SQL constructs.

    • getSQLFactoryInstance

      SQLFactory getSQLFactoryInstance()
      The SQL factory to use for SQL constructs.

    • setSQLFactory

      void setSQLFactory(String sqlFactory)
      The SQL factory to use for SQL constructs.

    • setSQLFactory

      void setSQLFactory(SQLFactory sqlFactory)
      The SQL factory to use for SQL constructs.

    • getMappingFactory

      String getMappingFactory()
      A plugin string describing the MetaDataFactory to use for loading and storing object-relational mapping data.

    • setMappingFactory

      void setMappingFactory(String mappingFactory)
      A plugin string describing the MetaDataFactory to use for loading and storing object-relational mapping data.

    • getMappingDefaults

      String getMappingDefaults()
      A plugin string describing the MappingDefaults to use.
      Since:
      0.4.0

    • setMappingDefaults

      void setMappingDefaults(String map)
      A plugin string describing the MappingDefaults to use.
      Since:
      0.4.0

    • getMappingDefaultsInstance

      MappingDefaults getMappingDefaultsInstance()
      The MappingDefaults to use with a repository.
      Since:
      0.4.0

    • setMappingDefaults

      void setMappingDefaults(MappingDefaults map)
      The MappingDefaults to use with a repository.
      Since:
      0.4.0

    • getMappingRepositoryInstance

      MappingRepository getMappingRepositoryInstance()
      Return the mapping repository. Convenience method to cast from the internal metadata repository.

    • newMappingRepositoryInstance

      MappingRepository newMappingRepositoryInstance()
      Return a new empty mapping repository of the configured type. Convenience method to cast from metadata repository.

    • getDataSource

      DataSource getDataSource(StoreContext ctx)
      Return the primary data source to use. The data source will automatically use the given context's user name and password on calls to DataSource.getConnection(). If the given context is null, the data source will use the configuration's default connection user name and password. If those too are null and the first context has been obtained already, then the user name and password for that context will be used, as we know they represent a valid combination. This method avoids casting the result of OpenJPAConfiguration.getConnectionFactory(), and avoids having to pass in the user name and password to obtain connections.

    • getDataSource2

      DataSource getDataSource2(StoreContext ctx)
      Return the non-enlisted data source to use. If there is a valid non-xa connection factory configured, then it will be returned. Its default user name and password on calls to DataSource.getConnection() will be the specified connection 2 user name and password. If those are null and the given context is non-null, its user name password will be used instead. If the context is null too, then the user name and password used to retrieve the first context will be used. If there is no second connection factory the primary connection factory is used.
      See Also:

    • getIdentifierUtil

      String getIdentifierUtil()
      Gets the String constant that matches the IdentifierUtil
      Returns:
      String-based name of the IdentifierUtil

    • getIdentifierUtilInstance

      DBIdentifierUtil getIdentifierUtilInstance()
      Gets the DBIdentifierUtil
      Returns:
      DBIdentifierUtil

    • setIdentifierUtil

      void setIdentifierUtil(DBIdentifierUtil util)
      Sets the DBIdentifierUtil
      Parameters:
      util - instance of the identifier utility