| /******************************************************************************* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you 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.apache.ofbiz.entity.connection; |
| |
| import java.sql.Connection; |
| import java.sql.Driver; |
| import java.sql.SQLException; |
| import java.util.HashMap; |
| import java.util.Map; |
| import java.util.Properties; |
| import java.util.concurrent.ConcurrentHashMap; |
| |
| import javax.transaction.TransactionManager; |
| |
| import org.apache.commons.dbcp2.DriverConnectionFactory; |
| import org.apache.commons.dbcp2.PoolableConnection; |
| import org.apache.commons.dbcp2.PoolableConnectionFactory; |
| import org.apache.commons.dbcp2.managed.LocalXAConnectionFactory; |
| import org.apache.commons.dbcp2.managed.PoolableManagedConnectionFactory; |
| import org.apache.commons.dbcp2.managed.XAConnectionFactory; |
| import org.apache.commons.pool2.impl.GenericObjectPool; |
| import org.apache.commons.pool2.impl.GenericObjectPoolConfig; |
| import org.apache.ofbiz.base.util.Debug; |
| import org.apache.ofbiz.entity.GenericEntityConfException; |
| import org.apache.ofbiz.entity.GenericEntityException; |
| import org.apache.ofbiz.entity.config.model.EntityConfig; |
| import org.apache.ofbiz.entity.config.model.InlineJdbc; |
| import org.apache.ofbiz.entity.config.model.JdbcElement; |
| import org.apache.ofbiz.entity.datasource.GenericHelperInfo; |
| import org.apache.ofbiz.entity.transaction.TransactionFactoryLoader; |
| import org.apache.ofbiz.entity.transaction.TransactionUtil; |
| |
| /** |
| * Apache Commons DBCP connection factory. |
| * |
| * @see <a href="http://commons.apache.org/proper/commons-dbcp/">Apache Commons DBCP</a> |
| */ |
| public class DBCPConnectionFactory implements ConnectionFactory { |
| |
| public static final String module = DBCPConnectionFactory.class.getName(); |
| // ManagedDataSource is useful to debug the usage of connections in the pool (must be verbose) |
| // In case you don't want to be disturbed in the log (focusing on something else), it's still easy to comment out the line from DebugManagedDataSource |
| protected static final ConcurrentHashMap<String, DebugManagedDataSource> dsCache = new ConcurrentHashMap<String, DebugManagedDataSource>(); |
| |
| public Connection getConnection(GenericHelperInfo helperInfo, JdbcElement abstractJdbc) throws SQLException, GenericEntityException { |
| String cacheKey = helperInfo.getHelperFullName(); |
| DebugManagedDataSource mds = dsCache.get(cacheKey); |
| if (mds != null) { |
| return TransactionUtil.getCursorConnection(helperInfo, mds.getConnection()); |
| } |
| if (!(abstractJdbc instanceof InlineJdbc)) { |
| throw new GenericEntityConfException("DBCP requires an <inline-jdbc> child element in the <datasource> element"); |
| } |
| InlineJdbc jdbcElement = (InlineJdbc) abstractJdbc; |
| // connection properties |
| TransactionManager txMgr = TransactionFactoryLoader.getInstance().getTransactionManager(); |
| String driverName = jdbcElement.getJdbcDriver(); |
| |
| String jdbcUri = helperInfo.getOverrideJdbcUri(jdbcElement.getJdbcUri()); |
| String jdbcUsername = helperInfo.getOverrideUsername(jdbcElement.getJdbcUsername()); |
| String jdbcPassword = helperInfo.getOverridePassword(EntityConfig.getJdbcPassword(jdbcElement)); |
| |
| // pool settings |
| int maxSize = jdbcElement.getPoolMaxsize(); |
| int minSize = jdbcElement.getPoolMinsize(); |
| int maxIdle = jdbcElement.getIdleMaxsize(); |
| // maxIdle must be greater than pool-minsize |
| maxIdle = maxIdle > minSize ? maxIdle : minSize; |
| // load the driver |
| Driver jdbcDriver; |
| synchronized (DBCPConnectionFactory.class) { |
| // Sync needed for MS SQL JDBC driver. See OFBIZ-5216. |
| try { |
| jdbcDriver = (Driver) Class.forName(driverName, true, Thread.currentThread().getContextClassLoader()).newInstance(); |
| } catch (Exception e) { |
| Debug.logError(e, module); |
| throw new GenericEntityException(e.getMessage(), e); |
| } |
| } |
| |
| // connection factory properties |
| Properties cfProps = new Properties(); |
| cfProps.put("user", jdbcUsername); |
| cfProps.put("password", jdbcPassword); |
| |
| // create the connection factory |
| org.apache.commons.dbcp2.ConnectionFactory cf = new DriverConnectionFactory(jdbcDriver, jdbcUri, cfProps); |
| |
| // wrap it with a LocalXAConnectionFactory |
| XAConnectionFactory xacf = new LocalXAConnectionFactory(txMgr, cf); |
| |
| // create the pool object factory |
| PoolableConnectionFactory factory = new PoolableManagedConnectionFactory(xacf, null); |
| factory.setValidationQuery(jdbcElement.getPoolJdbcTestStmt()); |
| factory.setDefaultReadOnly(false); |
| factory.setRollbackOnReturn(false); |
| factory.setEnableAutoCommitOnReturn(false); |
| String transIso = jdbcElement.getIsolationLevel(); |
| if (!transIso.isEmpty()) { |
| if ("Serializable".equals(transIso)) { |
| factory.setDefaultTransactionIsolation(Connection.TRANSACTION_SERIALIZABLE); |
| } else if ("RepeatableRead".equals(transIso)) { |
| factory.setDefaultTransactionIsolation(Connection.TRANSACTION_REPEATABLE_READ); |
| } else if ("ReadUncommitted".equals(transIso)) { |
| factory.setDefaultTransactionIsolation(Connection.TRANSACTION_READ_UNCOMMITTED); |
| } else if ("ReadCommitted".equals(transIso)) { |
| factory.setDefaultTransactionIsolation(Connection.TRANSACTION_READ_COMMITTED); |
| } else if ("None".equals(transIso)) { |
| factory.setDefaultTransactionIsolation(Connection.TRANSACTION_NONE); |
| } |
| } |
| |
| // configure the pool settings |
| GenericObjectPoolConfig poolConfig = new GenericObjectPoolConfig(); |
| poolConfig.setMaxTotal(maxSize); |
| // settings for idle connections |
| poolConfig.setMaxIdle(maxIdle); |
| poolConfig.setMinIdle(minSize); |
| poolConfig.setTimeBetweenEvictionRunsMillis(jdbcElement.getTimeBetweenEvictionRunsMillis()); |
| poolConfig.setMinEvictableIdleTimeMillis(-1); // disabled in favour of setSoftMinEvictableIdleTimeMillis(...) |
| poolConfig.setSoftMinEvictableIdleTimeMillis(jdbcElement.getSoftMinEvictableIdleTimeMillis()); |
| poolConfig.setNumTestsPerEvictionRun(maxSize); // test all the idle connections |
| // settings for when the pool is exhausted |
| poolConfig.setBlockWhenExhausted(true); // the thread requesting the connection waits if no connection is available |
| poolConfig.setMaxWaitMillis(jdbcElement.getPoolSleeptime()); // throw an exception if, after getPoolSleeptime() ms, no connection is available for the requesting thread |
| // settings for the execution of the validation query |
| poolConfig.setTestOnCreate(jdbcElement.getTestOnCreate()); |
| poolConfig.setTestOnBorrow(jdbcElement.getTestOnBorrow()); |
| poolConfig.setTestOnReturn(jdbcElement.getTestOnReturn()); |
| poolConfig.setTestWhileIdle(jdbcElement.getTestWhileIdle()); |
| |
| GenericObjectPool<PoolableConnection> pool = new GenericObjectPool<PoolableConnection>(factory, poolConfig); |
| factory.setPool(pool); |
| |
| mds = new DebugManagedDataSource(pool, xacf.getTransactionRegistry()); |
| mds.setAccessToUnderlyingConnectionAllowed(true); |
| |
| // cache the pool |
| dsCache.putIfAbsent(cacheKey, mds); |
| mds = dsCache.get(cacheKey); |
| |
| return TransactionUtil.getCursorConnection(helperInfo, mds.getConnection()); |
| } |
| |
| public void closeAll() { |
| // no methods on the pool to shutdown; so just clearing for GC |
| dsCache.clear(); |
| } |
| |
| public static Map<String, Object> getDataSourceInfo(String helperName) { |
| Map<String, Object> dataSourceInfo = new HashMap<String, Object>(); |
| DebugManagedDataSource mds = dsCache.get(helperName); |
| if (mds instanceof DebugManagedDataSource) { |
| dataSourceInfo = mds.getInfo(); |
| } |
| return dataSourceInfo; |
| } |
| |
| } |