|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.hibernate.cfg.Environment
public final class Environment
Provides access to configuration info passed in Properties objects.
Hibernate has two property scopes:
property | meaning |
hibernate.dialect | classname of org.hibernate.dialect.Dialect subclass |
hibernate.cache.provider_class | classname of org.hibernate.cache.CacheProvider subclass (if not specified EHCache is used) |
hibernate.connection.provider_class | classname of org.hibernate.connection.ConnectionProvider subclass (if not specified hueristics are used) |
hibernate.connection.username | database username |
hibernate.connection.password | database password |
hibernate.connection.url | JDBC URL (when using java.sql.DriverManager) |
hibernate.connection.driver_class | classname of JDBC driver |
hibernate.connection.isolation | JDBC transaction isolation level (only when using java.sql.DriverManager) | hibernate.connection.pool_size | the maximum size of the connection pool (only when using java.sql.DriverManager) |
hibernate.connection.datasource | databasource JNDI name (when using javax.sql.Datasource) |
hibernate.jndi.url | JNDI InitialContext URL |
hibernate.jndi.class | JNDI InitialContext classname |
hibernate.max_fetch_depth | maximum depth of outer join fetching |
hibernate.jdbc.batch_size | enable use of JDBC2 batch API for drivers which support it |
hibernate.jdbc.fetch_size | set the JDBC fetch size |
hibernate.jdbc.use_scrollable_resultset | enable use of JDBC2 scrollable resultsets (you only need this specify this property when using user supplied connections) |
hibernate.jdbc.use_getGeneratedKeys | enable use of JDBC3 PreparedStatement.getGeneratedKeys() to retrieve natively generated keys after insert. Requires JDBC3+ driver and JRE1.4+ |
hibernate.hbm2ddl.auto | enable auto DDL export |
hibernate.default_schema | use given schema name for unqualified tables (always optional) |
hibernate.default_catalog | use given catalog name for unqualified tables (always optional) |
hibernate.session_factory_name | If set, the factory attempts to bind this name to itself in the JNDI context. This name is also used to support cross JVM Session (de)serialization. |
hibernate.transaction.manager_lookup_class | classname of org.hibernate.transaction.TransactionManagerLookup implementor |
hibernate.transaction.factory_class | the factory to use for instantiating Transactions. (Defaults to JDBCTransactionFactory.) |
hibernate.query.substitutions | query language token substitutions |
SessionFactory
Field Summary | |
---|---|
static java.lang.String |
AUTO_CLOSE_SESSION
Enable automatic session close at end of transaction |
static java.lang.String |
AUTOCOMMIT
JDBC autocommit mode |
static java.lang.String |
BATCH_STRATEGY
Select a custom batcher. |
static java.lang.String |
BATCH_VERSIONED_DATA
Should versioned data be included in batching? |
static java.lang.String |
BYTECODE_PROVIDER
|
static java.lang.String |
C3P0_ACQUIRE_INCREMENT
Number of connections acquired when pool is exhausted |
static java.lang.String |
C3P0_IDLE_TEST_PERIOD
Idle time before a C3P0 pooled connection is validated |
static java.lang.String |
C3P0_MAX_SIZE
Maximum size of C3P0 connection pool |
static java.lang.String |
C3P0_MAX_STATEMENTS
Maximum size of C3P0 statement cache |
static java.lang.String |
C3P0_MIN_SIZE
Minimum size of C3P0 connection pool |
static java.lang.String |
C3P0_TIMEOUT
Maximum idle time for C3P0 connection pool |
static java.lang.String |
CACHE_NAMESPACE
The CacheProvider JNDI namespace, if pre-bound to JNDI. |
static java.lang.String |
CACHE_PROVIDER
The CacheProvider implementation class |
static java.lang.String |
CACHE_PROVIDER_CONFIG
The CacheProvider implementation class |
static java.lang.String |
CACHE_REGION_FACTORY
The RegionFactory implementation class |
static java.lang.String |
CACHE_REGION_PREFIX
The CacheProvider region name prefix |
static java.lang.String |
CONNECTION_PREFIX
prefix for arbitrary JDBC connection properties |
static java.lang.String |
CONNECTION_PROVIDER
ConnectionProvider implementor to use when obtaining connections |
static java.lang.String |
CURRENT_SESSION_CONTEXT_CLASS
Context scoping impl for SessionFactory.getCurrentSession() processing. |
static java.lang.String |
DATASOURCE
java.sql.Datasource JNDI name |
static java.lang.String |
DEFAULT_BATCH_FETCH_SIZE
The default batch size for batch fetching |
static java.lang.String |
DEFAULT_CATALOG
A default database catalog name to use for unqualified tablenames |
static java.lang.String |
DEFAULT_ENTITY_MODE
The EntityMode in which set the Session opened from the SessionFactory. |
static java.lang.String |
DEFAULT_SCHEMA
A default database schema (owner) name to use for unqualified tablenames |
static java.lang.String |
DIALECT
Hibernate SQL Dialect class |
static java.lang.String |
DRIVER
JDBC driver class |
static java.lang.String |
FLUSH_BEFORE_COMPLETION
Enable automatic flush during the JTA beforeCompletion() callback |
static java.lang.String |
FORMAT_SQL
Enable formatting of SQL logged to the console |
static java.lang.String |
GENERATE_STATISTICS
Enable statistics collection |
static java.lang.String |
HBM2DDL_AUTO
Auto export/update schema using hbm2ddl tool. |
static java.lang.String |
ISOLATION
JDBC transaction isolation level |
static java.lang.String |
JACC_CONTEXTID
The jacc context id of the deployment |
static java.lang.String |
JNDI_CLASS
JNDI initial context class, Context.INITIAL_CONTEXT_FACTORY |
static java.lang.String |
JNDI_PREFIX
prefix for arbitrary JNDI InitialContext properties |
static java.lang.String |
JNDI_URL
JNDI provider URL, Context.PROVIDER_URL |
static java.lang.String |
JPAQL_STRICT_COMPLIANCE
|
static java.lang.String |
MAX_FETCH_DEPTH
Maximum depth of outer join fetching |
static java.lang.String |
ORDER_INSERTS
Enable ordering of insert statements for the purpose of more effecient JDBC batching. |
static java.lang.String |
ORDER_UPDATES
Enable ordering of update statements by primary key value |
static java.lang.String |
OUTPUT_STYLESHEET
An XSLT resource used to generate "custom" XML |
static java.lang.String |
PASS
JDBC password |
static java.lang.String |
POOL_SIZE
Maximum number of inactive connections for Hibernate's connection pool |
static java.lang.String |
PROXOOL_EXISTING_POOL
Proxool property to configure the Proxool Provider from an already existing pool (true / false) |
static java.lang.String |
PROXOOL_POOL_ALIAS
Proxool property with the Proxool pool alias to use (Required for PROXOOL_EXISTING_POOL, PROXOOL_PROPERTIES, or PROXOOL_XML) |
static java.lang.String |
PROXOOL_PREFIX
Proxool/Hibernate property prefix |
static java.lang.String |
PROXOOL_PROPERTIES
Proxool property to configure the Proxool Provider using a properties file (/path/to/proxool.properties) |
static java.lang.String |
PROXOOL_XML
Proxool property to configure the Proxool Provider using an XML (/path/to/file.xml) |
static java.lang.String |
QUERY_CACHE_FACTORY
The QueryCacheFactory implementation class. |
static java.lang.String |
QUERY_STARTUP_CHECKING
Should named queries be checked during startup (the default is enabled). |
static java.lang.String |
QUERY_SUBSTITUTIONS
A comma-seperated list of token substitutions to use when translating a Hibernate query to SQL |
static java.lang.String |
QUERY_TRANSLATOR
The classname of the HQL query parser factory |
static java.lang.String |
RELEASE_CONNECTIONS
Specifies how Hibernate should release JDBC connections. |
static java.lang.String |
SESSION_FACTORY_NAME
JNDI name to bind to SessionFactory |
static java.lang.String |
SHOW_SQL
Enable logging of generated SQL to the console |
static java.lang.String |
SQL_EXCEPTION_CONVERTER
The SQLExceptionConverter to use for converting SQLExceptions
to Hibernate's JDBCException hierarchy. |
static java.lang.String |
STATEMENT_BATCH_SIZE
Maximum JDBC batch size. |
static java.lang.String |
STATEMENT_FETCH_SIZE
Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed. |
static java.lang.String |
TRANSACTION_MANAGER_STRATEGY
TransactionManagerLookup implementor to use for obtaining the TransactionManager |
static java.lang.String |
TRANSACTION_STRATEGY
TransactionFactory implementor to use for creating Transactions |
static java.lang.String |
URL
JDBC URL |
static java.lang.String |
USE_GET_GENERATED_KEYS
Tells the JDBC driver to attempt to retrieve row Id with the JDBC 3.0 PreparedStatement.getGeneratedKeys() method. |
static java.lang.String |
USE_IDENTIFIER_ROLLBACK
|
static java.lang.String |
USE_MINIMAL_PUTS
Optimize the cache for mimimal puts instead of minimal gets |
static java.lang.String |
USE_QUERY_CACHE
Enable the query cache (disabled by default) |
static java.lang.String |
USE_REFLECTION_OPTIMIZER
Use bytecode libraries optimized property access |
static java.lang.String |
USE_SCROLLABLE_RESULTSET
Use JDBC scrollable ResultSets. |
static java.lang.String |
USE_SECOND_LEVEL_CACHE
Enable the second-level cache (enabled by default) |
static java.lang.String |
USE_SQL_COMMENTS
Add comments to the generated SQL |
static java.lang.String |
USE_STREAMS_FOR_BINARY
Use java.io streams to read / write binary data from / to JDBC |
static java.lang.String |
USE_STRUCTURED_CACHE
Enable use of structured second-level cache entries |
static java.lang.String |
USER
JDBC user |
static java.lang.String |
USER_TRANSACTION
JNDI name of JTA UserTransaction object |
static java.lang.String |
VERSION
|
static java.lang.String |
WRAP_RESULT_SETS
Enable wrapping of JDBC result sets in order to speed up column name lookups for broken JDBC drivers |
Method Summary | |
---|---|
static BytecodeProvider |
buildBytecodeProvider(java.util.Properties properties)
|
static BytecodeProvider |
getBytecodeProvider()
|
static java.util.Properties |
getProperties()
Return System properties, extended by any properties specified in hibernate.properties. |
static java.lang.String |
isolationLevelToString(int isolation)
Get the name of a JDBC transaction isolation level |
static boolean |
jvmHasJDK14Timestamp()
Does this JVM handle Timestamp in the JDK 1.4 compliant way? |
static boolean |
jvmHasTimestampBug()
Does this JVM have the IBM JDK 1.3.1. |
static boolean |
jvmSupportsGetGeneratedKeys()
|
static boolean |
jvmSupportsLinkedHashCollections()
Does this JVM support LinkedHashSet, LinkedHashMap. |
static boolean |
useReflectionOptimizer()
Should we use CGLIB reflection optimizer. |
static boolean |
useStreamsForBinary()
Should we use streams to bind binary types to JDBC IN parameters. |
static void |
verifyProperties(java.util.Properties props)
Issues warnings to the user when any obsolete property names are used. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String VERSION
public static final java.lang.String CONNECTION_PROVIDER
public static final java.lang.String DRIVER
public static final java.lang.String ISOLATION
public static final java.lang.String URL
public static final java.lang.String USER
public static final java.lang.String PASS
public static final java.lang.String AUTOCOMMIT
public static final java.lang.String POOL_SIZE
public static final java.lang.String DATASOURCE
public static final java.lang.String CONNECTION_PREFIX
public static final java.lang.String JNDI_CLASS
public static final java.lang.String JNDI_URL
public static final java.lang.String JNDI_PREFIX
public static final java.lang.String SESSION_FACTORY_NAME
public static final java.lang.String DIALECT
public static final java.lang.String DEFAULT_SCHEMA
public static final java.lang.String DEFAULT_CATALOG
public static final java.lang.String SHOW_SQL
public static final java.lang.String FORMAT_SQL
public static final java.lang.String USE_SQL_COMMENTS
public static final java.lang.String MAX_FETCH_DEPTH
public static final java.lang.String DEFAULT_BATCH_FETCH_SIZE
public static final java.lang.String USE_STREAMS_FOR_BINARY
public static final java.lang.String USE_SCROLLABLE_RESULTSET
public static final java.lang.String USE_GET_GENERATED_KEYS
public static final java.lang.String STATEMENT_FETCH_SIZE
public static final java.lang.String STATEMENT_BATCH_SIZE
public static final java.lang.String BATCH_STRATEGY
public static final java.lang.String BATCH_VERSIONED_DATA
public static final java.lang.String OUTPUT_STYLESHEET
public static final java.lang.String C3P0_MAX_SIZE
public static final java.lang.String C3P0_MIN_SIZE
public static final java.lang.String C3P0_TIMEOUT
public static final java.lang.String C3P0_MAX_STATEMENTS
public static final java.lang.String C3P0_ACQUIRE_INCREMENT
public static final java.lang.String C3P0_IDLE_TEST_PERIOD
public static final java.lang.String PROXOOL_PREFIX
public static final java.lang.String PROXOOL_XML
public static final java.lang.String PROXOOL_PROPERTIES
public static final java.lang.String PROXOOL_EXISTING_POOL
public static final java.lang.String PROXOOL_POOL_ALIAS
public static final java.lang.String AUTO_CLOSE_SESSION
public static final java.lang.String FLUSH_BEFORE_COMPLETION
public static final java.lang.String RELEASE_CONNECTIONS
public static final java.lang.String CURRENT_SESSION_CONTEXT_CLASS
SessionFactory.getCurrentSession()
processing.
public static final java.lang.String TRANSACTION_STRATEGY
public static final java.lang.String TRANSACTION_MANAGER_STRATEGY
public static final java.lang.String USER_TRANSACTION
public static final java.lang.String CACHE_PROVIDER
public static final java.lang.String CACHE_REGION_FACTORY
RegionFactory
implementation class
public static final java.lang.String CACHE_PROVIDER_CONFIG
public static final java.lang.String CACHE_NAMESPACE
public static final java.lang.String USE_QUERY_CACHE
public static final java.lang.String QUERY_CACHE_FACTORY
public static final java.lang.String USE_SECOND_LEVEL_CACHE
public static final java.lang.String USE_MINIMAL_PUTS
public static final java.lang.String CACHE_REGION_PREFIX
public static final java.lang.String USE_STRUCTURED_CACHE
public static final java.lang.String GENERATE_STATISTICS
public static final java.lang.String USE_IDENTIFIER_ROLLBACK
public static final java.lang.String USE_REFLECTION_OPTIMIZER
public static final java.lang.String QUERY_TRANSLATOR
public static final java.lang.String QUERY_SUBSTITUTIONS
public static final java.lang.String QUERY_STARTUP_CHECKING
public static final java.lang.String HBM2DDL_AUTO
public static final java.lang.String SQL_EXCEPTION_CONVERTER
SQLExceptionConverter
to use for converting SQLExceptions
to Hibernate's JDBCException hierarchy. The default is to use the configured
Dialect
's preferred SQLExceptionConverter.
public static final java.lang.String WRAP_RESULT_SETS
public static final java.lang.String ORDER_UPDATES
public static final java.lang.String ORDER_INSERTS
public static final java.lang.String DEFAULT_ENTITY_MODE
public static final java.lang.String JACC_CONTEXTID
public static final java.lang.String BYTECODE_PROVIDER
public static final java.lang.String JPAQL_STRICT_COMPLIANCE
Method Detail |
---|
public static void verifyProperties(java.util.Properties props)
public static BytecodeProvider getBytecodeProvider()
public static boolean jvmHasTimestampBug()
public static boolean jvmHasJDK14Timestamp()
public static boolean jvmSupportsLinkedHashCollections()
LinkedHashSet
,
LinkedHashMap
public static boolean jvmSupportsGetGeneratedKeys()
public static boolean useStreamsForBinary()
USE_STREAMS_FOR_BINARY
public static boolean useReflectionOptimizer()
USE_REFLECTION_OPTIMIZER
public static java.util.Properties getProperties()
public static java.lang.String isolationLevelToString(int isolation)
isolation
- as defined by java.sql.Connection
Connection
public static BytecodeProvider buildBytecodeProvider(java.util.Properties properties)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |