org.codelibs.fess.crawler.db.allcommon.DBFluteConfig Maven / Gradle / Ivy
/*
* Copyright 2012-2016 CodeLibs Project and the Others.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/
package org.codelibs.fess.crawler.db.allcommon;
import java.lang.reflect.Field;
import java.sql.Connection;
import java.sql.SQLException;
import java.sql.Timestamp;
import javax.sql.DataSource;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.dbflute.bhv.core.context.mapping.MappingDateTimeZoneProvider;
import org.dbflute.bhv.core.supplement.SequenceCacheKeyGenerator;
import org.dbflute.cbean.cipher.GearedCipherManager;
import org.dbflute.cbean.sqlclause.SqlClauseCreator;
import org.dbflute.dbmeta.name.SqlNameFilter;
import org.dbflute.dbway.DBDef;
import org.dbflute.exception.IllegalDBFluteConfigAccessException;
import org.dbflute.jdbc.DataSourceHandler;
import org.dbflute.jdbc.NotClosingConnectionWrapper;
import org.dbflute.jdbc.PhysicalConnectionDigger;
import org.dbflute.jdbc.SQLExceptionDigger;
import org.dbflute.jdbc.StatementConfig;
import org.dbflute.jdbc.ValueType;
import org.dbflute.outsidesql.factory.OutsideSqlExecutorFactory;
import org.dbflute.s2dao.valuetype.TnValueTypes;
import org.dbflute.system.QLog;
import org.dbflute.system.XLog;
import org.dbflute.twowaysql.DisplaySqlBuilder;
import org.dbflute.twowaysql.style.BoundDateDisplayTimeZoneProvider;
import org.dbflute.util.DfReflectionUtil;
import org.lastaflute.jta.dbcp.ConnectionWrapper;
import org.lastaflute.di.exception.SQLRuntimeException;
/**
* @author DBFlute(AutoGenerator)
*/
public class DBFluteConfig {
// ===================================================================================
// Definition
// ==========
/** The logger instance for this class. (NotNull) */
private static final Logger _log = LoggerFactory.getLogger(DBFluteConfig.class);
/** Singleton instance. */
private static final DBFluteConfig _instance = new DBFluteConfig();
// ===================================================================================
// Attribute
// =========
// -----------------------------------------------------
// Configuration
// -------------
// condition-bean or parameter-bean
protected boolean _pagingCountLater = true;
protected boolean _pagingCountLeastJoin = true;
protected boolean _innerJoinAutoDetect = true;
protected boolean _thatsBadTimingDetect = true;
protected boolean _nullOrEmptyQueryAllowed = false;
protected boolean _emptyStringQueryAllowed = false;
protected boolean _emptyStringParameterAllowed = false;
protected boolean _overridingQueryAllowed = false;
protected boolean _nonSpecifiedColumnAccessAllowed = false;
protected boolean _columnNullObjectAllowed = false;
protected boolean _columnNullObjectGearedToSpecify = false;
protected boolean _disableSelectIndex;
protected boolean _queryUpdateCountPreCheck = false;
// logging
protected boolean _queryLogLevelInfo;
protected boolean _executeStatusLogLevelInfo;
protected String _logDatePattern;
protected String _logTimestampPattern;
protected String _logTimePattern;
protected BoundDateDisplayTimeZoneProvider _logTimeZoneProvider;
// environment
protected StatementConfig _defaultStatementConfig;
protected Integer _cursorSelectFetchSize = null;
protected Integer _entitySelectFetchSize = null;
protected boolean _usePagingByCursorSkipSynchronizedFetchSize = false;
protected Integer _fixedPagingByCursorSkipSynchronizedFetchSize = null;
protected DataSourceHandler _dataSourceHandler;
protected PhysicalConnectionDigger _physicalConnectionDigger;
protected SQLExceptionDigger _sqlExceptionDigger;
protected String _outsideSqlPackage = null;
protected MappingDateTimeZoneProvider _mappingDateTimeZoneProvider;
// extension
protected SequenceCacheKeyGenerator _sequenceCacheKeyGenerator;
protected SqlClauseCreator _sqlClauseCreator;
protected SqlNameFilter _tableSqlNameFilter;
protected OutsideSqlExecutorFactory _outsideSqlExecutorFactory;
protected GearedCipherManager _gearedCipherManager;
// internal
protected boolean _internalDebug;
// -----------------------------------------------------
// Database Dependency
// -------------------
// -----------------------------------------------------
// Lock
// ----
protected boolean _locked = true; // at first locked
// ===================================================================================
// Constructor
// ===========
/**
* Constructor.
*/
private DBFluteConfig() { // adjusts default settings
_physicalConnectionDigger = new ImplementedPhysicalConnectionDigger();
_sqlExceptionDigger = new ImplementedSQLExceptionDigger();
}
// ===================================================================================
// Singleton
// =========
/**
* Get singleton instance.
* @return Singleton instance. (NotNull)
*/
public static DBFluteConfig getInstance() {
return _instance;
}
// ===================================================================================
// Paging Select
// =============
public boolean isPagingCountLater() {
return _pagingCountLater;
}
public void setPagingCountLater(boolean pagingCountLater) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting pagingCountLater: " + pagingCountLater);
}
_pagingCountLater = pagingCountLater;
}
public boolean isPagingCountLeastJoin() {
return _pagingCountLeastJoin;
}
public void setPagingCountLeastJoin(boolean pagingCountLeastJoin) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting pagingCountLeastJoin: " + pagingCountLeastJoin);
}
_pagingCountLeastJoin = pagingCountLeastJoin;
}
// ===================================================================================
// Inner Join Auto Detect
// ======================
public boolean isInnerJoinAutoDetect() {
return _innerJoinAutoDetect;
}
public void setInnerJoinAutoDetect(boolean innerJoinAutoDetect) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting innerJoinAutoDetect: " + innerJoinAutoDetect);
}
_innerJoinAutoDetect = innerJoinAutoDetect;
}
// ===================================================================================
// That's-Bad-Timing Detect
// ========================
public boolean isThatsBadTimingDetect() {
return _thatsBadTimingDetect;
}
public void setThatsBadTimingDetect(boolean thatsBadTimingDetect) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting thatsBadTimingDetect: " + thatsBadTimingDetect);
}
_thatsBadTimingDetect = thatsBadTimingDetect;
}
// ===================================================================================
// Invalid Query
// =============
public boolean isNullOrEmptyQueryAllowed() {
return _nullOrEmptyQueryAllowed;
}
/**
* Set whether null-or-empty query is allowed or not.
* This configuration is only for ConditionBean.
* @param nullOrEmptyQueryAllowed The determination, true or false.
*/
public void setNullOrEmptyQueryAllowed(boolean nullOrEmptyQueryAllowed) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting nullOrEmptyQueryAllowed: " + nullOrEmptyQueryAllowed);
}
_nullOrEmptyQueryAllowed = nullOrEmptyQueryAllowed;
}
public boolean isEmptyStringQueryAllowed() {
return _emptyStringQueryAllowed;
}
/**
* Set whether an empty string for query is allowed or not.
* This configuration is only for ConditionBean.
* @param emptyStringQueryAllowed The determination, true or false.
*/
public void setEmptyStringQueryAllowed(boolean emptyStringQueryAllowed) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting emptyStringQueryAllowed: " + emptyStringQueryAllowed);
}
_emptyStringQueryAllowed = emptyStringQueryAllowed;
}
public boolean isEmptyStringParameterAllowed() {
return _emptyStringParameterAllowed;
}
/**
* Set whether an empty string for parameter is allowed or not.
* This configuration is only for ParameterBean.
* @param emptyStringParameterAllowed The determination, true or false.
*/
public void setEmptyStringParameterAllowed(boolean emptyStringParameterAllowed) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting emptyStringParameterAllowed: " + emptyStringParameterAllowed);
}
_emptyStringParameterAllowed = emptyStringParameterAllowed;
}
public boolean isOverridingQueryAllowed() {
return _overridingQueryAllowed;
}
/**
* Set whether overriding query is allowed or not.
* This configuration is only for ConditionBean.
* @param overridingQueryAllowed The determination, true or false.
*/
public void setOverridingQueryAllowed(boolean overridingQueryAllowed) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting overridingQueryAllowed: " + overridingQueryAllowed);
}
_overridingQueryAllowed = overridingQueryAllowed;
}
// ===================================================================================
// Non-Specified Access
// ====================
public boolean isNonSpecifiedColumnAccessAllowed() {
return _nonSpecifiedColumnAccessAllowed;
}
/**
* Set whether non-specified column access is allowed or not.
* This configuration is only for ConditionBean.
* @param nonSpecifiedColumnAccessAllowed The determination, true or false.
*/
public void setNonSpecifiedColumnAccessAllowed(boolean nonSpecifiedColumnAccessAllowed) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting nonSpecifiedColumnAccessAllowed: " + nonSpecifiedColumnAccessAllowed);
}
_nonSpecifiedColumnAccessAllowed = nonSpecifiedColumnAccessAllowed;
}
// ===================================================================================
// Column Null Object
// ==================
public boolean isColumnNullObjectAllowed() {
return _columnNullObjectAllowed;
}
/**
* Set whether column null object is allowed or not.
* This configuration is only for ConditionBean.
* @param columnNullObjectAllowed The determination, true or false.
*/
public void setColumnNullObjectAllowed(boolean columnNullObjectAllowed) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting columnNullObjectAllowed: " + columnNullObjectAllowed);
}
_columnNullObjectAllowed = columnNullObjectAllowed;
}
public boolean isColumnNullObjectGearedToSpecify() {
return _columnNullObjectGearedToSpecify;
}
/**
* Set whether column null object is geared to specify or not.
* This configuration is only for ConditionBean.
* @param columnNullObjectGearedToSpecify The determination, true or false.
*/
public void setColumnNullObjectGearedToSpecify(boolean columnNullObjectGearedToSpecify) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting columnNullObjectGearedToSpecify: " + columnNullObjectGearedToSpecify);
}
_columnNullObjectGearedToSpecify = columnNullObjectGearedToSpecify;
}
// ===================================================================================
// Select Index
// ============
public boolean isDisableSelectIndex() {
return _disableSelectIndex;
}
public void setDisableSelectIndex(boolean disableSelectIndex) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting disableSelectIndex: " + disableSelectIndex);
}
_disableSelectIndex = disableSelectIndex;
}
// ===================================================================================
// Query Update
// ============
public boolean isQueryUpdateCountPreCheck() {
return _queryUpdateCountPreCheck;
}
public void setQueryUpdateCountPreCheck(boolean queryUpdateCountPreCheck) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting queryUpdateCountPreCheck: " + queryUpdateCountPreCheck);
}
_queryUpdateCountPreCheck = queryUpdateCountPreCheck;
}
// ===================================================================================
// Query Log Level Info
// ====================
public void setQueryLogLevelInfo(boolean queryLogLevelInfo) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting queryLogLevelInfo: " + queryLogLevelInfo);
}
QLog.unlock();
QLog.setQueryLogLevelInfo(queryLogLevelInfo);
QLog.lock();
}
// ===================================================================================
// Execute Status Log Level Info
// =============================
public void setExecuteStatusLogLevelInfo(boolean executeStatusLogLevelInfo) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting executeStatusLogLevelInfo: " + executeStatusLogLevelInfo);
}
XLog.unlock();
XLog.setExecuteStatusLogLevelInfo(executeStatusLogLevelInfo);
XLog.lock();
}
// ===================================================================================
// Log Format
// ==========
public String getLogDatePattern() {
return _logDatePattern;
}
public void setLogDatePattern(String logDatePattern) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting logDatePattern: " + logDatePattern);
}
_logDatePattern = logDatePattern;
}
public String getLogTimestampPattern() {
return _logTimestampPattern;
}
public void setLogTimestampPattern(String logTimestampPattern) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting logTimestampPattern: " + logTimestampPattern);
}
_logTimestampPattern = logTimestampPattern;
}
public String getLogTimePattern() {
return _logTimePattern;
}
public void setLogTimePattern(String logTimePattern) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting logTimePattern: " + logTimePattern);
}
_logTimePattern = logTimePattern;
}
public BoundDateDisplayTimeZoneProvider getLogTimeZoneProvider() {
return _logTimeZoneProvider;
}
public void setLogTimeZoneProvider(BoundDateDisplayTimeZoneProvider logTimeZoneProvider) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting logTimeZoneProvider: " + logTimeZoneProvider);
}
_logTimeZoneProvider = logTimeZoneProvider;
}
// ===================================================================================
// Default StatementConfig
// =======================
public StatementConfig getDefaultStatementConfig() {
return _defaultStatementConfig;
}
public void setDefaultStatementConfig(StatementConfig defaultStatementConfig) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting defaultStatementConfig: " + defaultStatementConfig);
}
_defaultStatementConfig = defaultStatementConfig;
}
// ===================================================================================
// CursorSelect FetchSize
// ======================
public Integer getCursorSelectFetchSize() {
return _cursorSelectFetchSize;
}
public void setCursorSelectFetchSize(Integer cursorSelectFetchSize) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting cursorSelectFetchSize: " + cursorSelectFetchSize);
}
_cursorSelectFetchSize = cursorSelectFetchSize;
}
// ===================================================================================
// EntitySelect FetchSize
// ======================
public Integer getEntitySelectFetchSize() {
return _entitySelectFetchSize;
}
public void setEntitySelectFetchSize(Integer entitySelectFetchSize) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting entitySelectFetchSize: " + entitySelectFetchSize);
}
_entitySelectFetchSize = entitySelectFetchSize;
}
// ===================================================================================
// PagingSelect FetchSize
// ======================
public boolean isUsePagingByCursorSkipSynchronizedFetchSize() {
return _usePagingByCursorSkipSynchronizedFetchSize;
}
public void setUsePagingByCursorSkipSynchronizedFetchSize(boolean usePagingByCursorSkipSynchronizedFetchSize) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting usePagingByCursorSkipSynchronizedFetchSize: " + usePagingByCursorSkipSynchronizedFetchSize);
}
_usePagingByCursorSkipSynchronizedFetchSize = usePagingByCursorSkipSynchronizedFetchSize;
}
public Integer getFixedPagingByCursorSkipSynchronizedFetchSize() {
return _fixedPagingByCursorSkipSynchronizedFetchSize;
}
public void setFixedPagingByCursorSkipSynchronizedFetchSize(Integer fixedPagingByCursorSkipSynchronizedFetchSize) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting fixedPagingByCursorSkipSynchronizedFetchSize: " + fixedPagingByCursorSkipSynchronizedFetchSize);
}
_fixedPagingByCursorSkipSynchronizedFetchSize = fixedPagingByCursorSkipSynchronizedFetchSize;
}
// [DBFlute-0.9.0]
// ===================================================================================
// DataSource Handler
// ==================
/**
* @return The handler of data source. (NullAllowed)
*/
public DataSourceHandler getDataSourceHandler() {
return _dataSourceHandler;
}
/**
* @param dataSourceHandler The handler of data source. (NullAllowed)
*/
public void setDataSourceHandler(DataSourceHandler dataSourceHandler) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting dataSourceHandler: " + dataSourceHandler);
}
_dataSourceHandler = dataSourceHandler;
}
// [DBFlute-0.9.7.6]
// ===================================================================================
// PhysicalConnection Digger
// =========================
/**
* @return The digger of physical connection. (NotNull: has a default instance)
*/
public PhysicalConnectionDigger getPhysicalConnectionDigger() {
return _physicalConnectionDigger;
}
/**
* @param physicalConnectionDigger The digger of physical connection. (NotNull)
*/
public void setPhysicalConnectionDigger(PhysicalConnectionDigger physicalConnectionDigger) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting physicalConnectionDigger: " + physicalConnectionDigger);
}
if (physicalConnectionDigger == null) {
throw new IllegalArgumentException("The argument 'physicalConnectionDigger' should not be null.");
}
_physicalConnectionDigger = physicalConnectionDigger;
}
// [DBFlute-0.9.7.8]
// ===================================================================================
// SQLException Digger
// ===================
/**
* @return The digger of SQLException. (NotNull: has a default instance)
*/
public SQLExceptionDigger getSQLExceptionDigger() {
return _sqlExceptionDigger;
}
/**
* @param sqlExceptionDigger The digger of SQLException. (NotNull)
*/
public void setSQLExceptionDigger(SQLExceptionDigger sqlExceptionDigger) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting sqlExceptionDigger: " + sqlExceptionDigger);
}
if (sqlExceptionDigger == null) {
throw new IllegalArgumentException("The argument 'sqlExceptionDigger' should not be null.");
}
_sqlExceptionDigger = sqlExceptionDigger;
}
// ===================================================================================
// OutsideSql Package
// ==================
/**
* @return The package of outside SQL. (NullAllowed)
*/
public String getOutsideSqlPackage() {
return _outsideSqlPackage;
}
/**
* @param outsideSqlPackage The package of outside SQL. (NullAllowed)
*/
public void setOutsideSqlPackage(String outsideSqlPackage) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting outsideSqlPackage: " + outsideSqlPackage);
}
_outsideSqlPackage = outsideSqlPackage;
}
// [DBFlute-1.1.0]
// ===================================================================================
// Mapping Date TimeZone
// =====================
public MappingDateTimeZoneProvider getMappingDateTimeZoneProvider() {
return _mappingDateTimeZoneProvider;
}
public void setMappingDateTimeZoneProvider(MappingDateTimeZoneProvider mappingDateTimeZoneProvider) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting mappingDateTimeZoneProvider: " + mappingDateTimeZoneProvider);
}
_mappingDateTimeZoneProvider = mappingDateTimeZoneProvider;
}
// [DBFlute-0.9.6.4]
// ===================================================================================
// Sequence Cache
// ==============
/**
* @return The key generator of sequence cache. (NullAllowed)
*/
public SequenceCacheKeyGenerator getSequenceCacheKeyGenerator() {
return _sequenceCacheKeyGenerator;
}
/**
* @param sequenceCacheKeyGenerator The key generator of sequence cache. (NullAllowed)
*/
public void setSequenceCacheKeyGenerator(SequenceCacheKeyGenerator sequenceCacheKeyGenerator) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting sequenceCacheKeyGenerator: " + sequenceCacheKeyGenerator);
}
_sequenceCacheKeyGenerator = sequenceCacheKeyGenerator;
}
// [DBFlute-0.9.6.9]
// ===================================================================================
// SqlClause Creator
// =================
/**
* @return The creator of SQL clause. (NullAllowed)
*/
public SqlClauseCreator getSqlClauseCreator() {
return _sqlClauseCreator;
}
/**
* @param sqlClauseCreator The creator of SQL clause. (NullAllowed)
*/
public void setSqlClauseCreator(SqlClauseCreator sqlClauseCreator) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting sqlClauseCreator: " + sqlClauseCreator);
}
_sqlClauseCreator = sqlClauseCreator;
}
// [DBFlute-0.9.7.6]
// ===================================================================================
// TableSqlName Filter
// ===================
/**
* @return The SQL name filter for table. (NullAllowed)
*/
public SqlNameFilter getTableSqlNameFilter() {
return _tableSqlNameFilter;
}
/**
* Set the SQL name filter for table.
* This setting should be called before container's initialization.
* (its exact meaning is: before class loading of DBMeta for table)
* @param tableSqlNameFilter The SQL name filter for table. (NullAllowed)
*/
public void setTableSqlNameFilter(SqlNameFilter tableSqlNameFilter) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting tableSqlNameFilter: " + tableSqlNameFilter);
}
_tableSqlNameFilter = tableSqlNameFilter;
}
// [DBFlute-0.9.7.0]
// ===================================================================================
// OutsideSql Executor
// ===================
public OutsideSqlExecutorFactory getOutsideSqlExecutorFactory() {
return _outsideSqlExecutorFactory;
}
public void setOutsideSqlExecutorFactory(OutsideSqlExecutorFactory outsideSqlExecutorFactory) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting outsideSqlExecutorFactory: " + outsideSqlExecutorFactory);
}
_outsideSqlExecutorFactory = outsideSqlExecutorFactory;
}
// [DBFlute-0.9.7.0]
// ===================================================================================
// Geared Cipher Manager
// =====================
public GearedCipherManager getGearedCipherManager() {
return _gearedCipherManager;
}
public void setGearedCipherManager(GearedCipherManager gearedCipherManager) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting gearedCipherManager: " + gearedCipherManager);
}
_gearedCipherManager = gearedCipherManager;
}
// ===================================================================================
// Database Dependency
// ===================
// ===================================================================================
// Internal Debug
// ==============
public boolean isInternalDebug() {
return _internalDebug;
}
public void setInternalDebug(boolean internalDebug) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Setting internalDebug: " + internalDebug);
}
_internalDebug = internalDebug;
}
// ===================================================================================
// Value Type
// ==========
/**
* Register the basic value type.
* This setting is shared per DBMS in the same class loader.
* @param keyType The type as key. (NotNull)
* @param valueType The basic value type. (NotNull)
*/
public void registerBasicValueType(Class keyType, ValueType valueType) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Registering basic valueType: " + keyType + " = " + valueType);
}
TnValueTypes.registerBasicValueType(currentDBDef(), keyType, valueType);
}
public void removeBasicValueType(Class keyType) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Removing basic valueType: " + keyType);
}
TnValueTypes.removeBasicValueType(currentDBDef(), keyType);
}
/**
* Register the plug-in value type.
* This setting is shared per DBMS in the same class loader.
* @param keyName The name as key. (NotNull)
* @param valueType The plug-in value type. (NotNull)
*/
public void registerPluginValueType(String keyName, ValueType valueType) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Registering plug-in valueType: " + keyName + " = " + valueType);
}
TnValueTypes.registerPluginValueType(currentDBDef(), keyName, valueType);
}
public void removePluginValueType(String keyName) {
assertUnlocked();
if (_log.isInfoEnabled()) {
_log.info("...Removing plug-in valueType: keyName=" + keyName);
}
TnValueTypes.removePluginValueType(currentDBDef(), keyName);
}
// ===================================================================================
// Configuration Lock
// ==================
public void lock() {
if (_locked) {
return;
}
if (_log.isInfoEnabled()) {
_log.info("...Locking the configuration of DBFlute");
}
_locked = true;
}
public void unlock() {
if (!_locked) {
return;
}
if (_log.isInfoEnabled()) {
_log.info("...Unlocking the configuration of DBFlute");
}
_locked = false;
}
public boolean isLocked() {
return _locked;
}
protected void assertUnlocked() {
if (!isLocked()) {
return;
}
throw new IllegalDBFluteConfigAccessException("The configuration of DBFlute is locked.");
}
// ===================================================================================
// Assist Helper
// =============
protected DBDef currentDBDef() {
return DBCurrent.getInstance().currentDBDef();
}
protected boolean isCurrentDBDef(DBDef currentDBDef) {
return DBCurrent.getInstance().isCurrentDBDef(currentDBDef);
}
// ===================================================================================
// Implemented Class
// =================
// -----------------------------------------------------
// Physical Connection
// -------------------
public static class ImplementedPhysicalConnectionDigger implements PhysicalConnectionDigger {
public Connection digUp(Connection conn) throws SQLException {
Connection digged = unwrap(conn);
digged = resolveLaDBCP(digged);
digged = resolveCommonsDBCP(digged);
return digged;
}
protected Connection unwrap(Connection conn) {
if (conn instanceof NotClosingConnectionWrapper) {
return ((NotClosingConnectionWrapper)conn).getActualConnection();
}
return conn;
}
protected Connection resolveLaDBCP(Connection conn) {
if (conn instanceof ConnectionWrapper) {
return ((ConnectionWrapper)conn).getPhysicalConnection();
}
return conn;
}
protected Connection resolveCommonsDBCP(Connection conn) {
Connection resolved = conn;
if ("org.apache.commons.dbcp.PoolingDataSource$PoolGuardConnectionWrapper".equals(resolved.getClass().getName())) {
resolved = getFieldConnection(resolved, "delegate");
}
if ("org.apache.commons.dbcp.PoolableConnection".equals(resolved.getClass().getName())) {
resolved = getFieldConnection(resolved, "_conn");
}
return resolved;
}
protected Connection getFieldConnection(Connection conn, String fieldName) {
Field field = DfReflectionUtil.getWholeField(conn.getClass(), fieldName);
return (Connection)DfReflectionUtil.getValueForcedly(field, conn);
}
}
// -----------------------------------------------------
// SQLException
// ------------
public static class ImplementedSQLExceptionDigger implements SQLExceptionDigger {
public SQLException digUp(Throwable cause) {
SQLException s2found = resolveLaDBCP(cause);
if (s2found != null) {
return s2found;
}
SQLException defaultFound = resolveDefault(cause);
if (defaultFound != null) {
return defaultFound;
}
return null;
}
protected SQLException resolveLaDBCP(Throwable cause) {
if (cause instanceof SQLRuntimeException) {
Throwable nestedCause = ((SQLRuntimeException)cause).getCause();
if (nestedCause instanceof SQLException) {
return (SQLException)nestedCause;
}
}
return null;
}
protected SQLException resolveDefault(Throwable cause) {
Throwable nestedCause = cause.getCause();
if (nestedCause instanceof SQLException) {
return (SQLException)nestedCause;
}
return null;
}
}
// ===================================================================================
// Very Internal
// =============
// very internal (for suppressing warn about 'Not Use Import')
protected String xTms() { return Timestamp.class.getName(); }
protected String xDSc() { return DataSource.class.getName(); }
protected String xSQLEx() { return SQLException.class.getName(); }
protected String xDSqB() { return DisplaySqlBuilder.class.getName(); }
}