org.apache.tomcat.dbcp.dbcp2.datasources.PerUserPoolDataSource Maven / Gradle / Ivy
/*
* 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.tomcat.dbcp.dbcp2.datasources;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.sql.Connection;
import java.sql.SQLException;
import java.time.Duration;
import java.util.HashMap;
import java.util.Map;
import java.util.NoSuchElementException;
import javax.naming.NamingException;
import javax.naming.Reference;
import javax.naming.StringRefAddr;
import javax.sql.ConnectionPoolDataSource;
import org.apache.juli.logging.Log;
import org.apache.juli.logging.LogFactory;
import org.apache.tomcat.dbcp.dbcp2.SwallowedExceptionLogger;
import org.apache.tomcat.dbcp.dbcp2.Utils;
import org.apache.tomcat.dbcp.pool2.ObjectPool;
import org.apache.tomcat.dbcp.pool2.impl.GenericObjectPool;
/**
*
* A pooling {@code DataSource} appropriate for deployment within J2EE environment. There are many configuration
* options, most of which are defined in the parent class. This datasource uses individual pools per user, and some
* properties can be set specifically for a given user, if the deployment environment can support initialization of
* mapped properties. So for example, a pool of admin or write-access Connections can be guaranteed a certain number of
* connections, separate from a maximum set for users with read-only connections.
*
*
*
* User passwords can be changed without re-initializing the datasource. When a
* {@code getConnection(userName, password)} request is processed with a password that is different from those used
* to create connections in the pool associated with {@code userName}, an attempt is made to create a new
* connection using the supplied password and if this succeeds, the existing pool is cleared and a new pool is created
* for connections using the new password.
*
*
* @since 2.0
*/
public class PerUserPoolDataSource extends InstanceKeyDataSource {
private static final long serialVersionUID = 7872747993848065028L;
private static final Log log = LogFactory.getLog(PerUserPoolDataSource.class);
private static HashMap createMap() {
// Should there be a default size different from what this ctor provides?
return new HashMap<>();
}
private Map perUserBlockWhenExhausted;
private Map perUserEvictionPolicyClassName;
private Map perUserLifo;
private Map perUserMaxIdle;
private Map perUserMaxTotal;
private Map perUserMaxWaitDuration;
private Map perUserMinEvictableIdleDuration;
private Map perUserMinIdle;
private Map perUserNumTestsPerEvictionRun;
private Map perUserSoftMinEvictableIdleDuration;
private Map perUserTestOnCreate;
private Map perUserTestOnBorrow;
private Map perUserTestOnReturn;
private Map perUserTestWhileIdle;
private Map perUserDurationBetweenEvictionRuns;
private Map perUserDefaultAutoCommit;
private Map perUserDefaultTransactionIsolation;
private Map perUserDefaultReadOnly;
/**
* Map to keep track of Pools for a given user.
*/
private transient Map managers = createMap();
/**
* Default no-arg constructor for Serialization.
*/
public PerUserPoolDataSource() {
}
/**
* Clears pool(s) maintained by this data source.
*
* @see org.apache.tomcat.dbcp.pool2.ObjectPool#clear()
* @since 2.3.0
*/
public void clear() {
managers.values().forEach(manager -> {
try {
getCPDSConnectionFactoryPool(manager).clear();
} catch (final Exception ignored) {
// ignore and try to close others.
}
});
InstanceKeyDataSourceFactory.removeInstance(getInstanceKey());
}
/**
* Closes pool(s) maintained by this data source.
*
* @see org.apache.tomcat.dbcp.pool2.ObjectPool#close()
*/
@Override
public void close() {
managers.values().forEach(manager -> Utils.closeQuietly(getCPDSConnectionFactoryPool(manager)));
InstanceKeyDataSourceFactory.removeInstance(getInstanceKey());
}
/**
* Converts a map with Long milliseconds values to another map with Duration values.
*/
private Map convertMap(final Map currentMap, final Map longMap) {
final Map durationMap = createMap();
longMap.forEach((k, v) -> durationMap.put(k, toDurationOrNull(v)));
if (currentMap == null) {
return durationMap;
}
currentMap.clear();
currentMap.putAll(durationMap);
return currentMap;
}
@Override
protected PooledConnectionManager getConnectionManager(final UserPassKey upKey) {
return managers.get(getPoolKey(upKey.getUserName()));
}
/**
* Gets the underlying pool but does NOT allocate it.
*
* @param manager A CPDSConnectionFactory.
* @return the underlying pool.
*/
private ObjectPool getCPDSConnectionFactoryPool(final PooledConnectionManager manager) {
return ((CPDSConnectionFactory) manager).getPool();
}
/**
* Gets the number of active connections in the default pool.
*
* @return The number of active connections in the default pool.
*/
public int getNumActive() {
return getNumActive(null);
}
/**
* Gets the number of active connections in the pool for a given user.
*
* @param userName
* The user name key.
* @return The user specific value.
*/
public int getNumActive(final String userName) {
final ObjectPool pool = getPool(getPoolKey(userName));
return pool == null ? 0 : pool.getNumActive();
}
/**
* Gets the number of idle connections in the default pool.
*
* @return The number of idle connections in the default pool.
*/
public int getNumIdle() {
return getNumIdle(null);
}
/**
* Gets the number of idle connections in the pool for a given user.
*
* @param userName
* The user name key.
* @return The user specific value.
*/
public int getNumIdle(final String userName) {
final ObjectPool pool = getPool(getPoolKey(userName));
return pool == null ? 0 : pool.getNumIdle();
}
/**
* Gets the user specific value for {@link GenericObjectPool#getBlockWhenExhausted()} for the specified user's pool
* or the default if no user specific value is defined.
*
* @param userName
* The user name key.
* @return The user specific value.
*/
public boolean getPerUserBlockWhenExhausted(final String userName) {
Boolean value = null;
if (perUserBlockWhenExhausted != null) {
value = perUserBlockWhenExhausted.get(userName);
}
if (value == null) {
return getDefaultBlockWhenExhausted();
}
return value.booleanValue();
}
/**
* Gets the user specific default value for {@link Connection#setAutoCommit(boolean)} for the specified user's pool.
*
* @param userName
* The user name key.
* @return The user specific value.
*/
public Boolean getPerUserDefaultAutoCommit(final String userName) {
Boolean value = null;
if (perUserDefaultAutoCommit != null) {
value = perUserDefaultAutoCommit.get(userName);
}
return value;
}
/**
* Gets the user specific default value for {@link Connection#setReadOnly(boolean)} for the specified user's pool.
*
* @param userName
* The user name key.
* @return The user specific value.
*/
public Boolean getPerUserDefaultReadOnly(final String userName) {
Boolean value = null;
if (perUserDefaultReadOnly != null) {
value = perUserDefaultReadOnly.get(userName);
}
return value;
}
/**
* Gets the user specific default value for {@link Connection#setTransactionIsolation(int)} for the specified user's
* pool.
*
* @param userName
* The user name key.
* @return The user specific value.
*/
public Integer getPerUserDefaultTransactionIsolation(final String userName) {
Integer value = null;
if (perUserDefaultTransactionIsolation != null) {
value = perUserDefaultTransactionIsolation.get(userName);
}
return value;
}
/**
* Gets the user specific value for {@link GenericObjectPool#getDurationBetweenEvictionRuns()} for the specified
* user's pool or the default if no user specific value is defined.
*
* @param userName
* The user name key.
* @return The user specific value.
* @since 2.10.0
*/
public Duration getPerUserDurationBetweenEvictionRuns(final String userName) {
Duration value = null;
if (perUserDurationBetweenEvictionRuns != null) {
value = perUserDurationBetweenEvictionRuns.get(userName);
}
if (value == null) {
return getDefaultDurationBetweenEvictionRuns();
}
return value;
}
/**
* Gets the user specific value for {@link GenericObjectPool#getEvictionPolicyClassName()} for the specified user's
* pool or the default if no user specific value is defined.
*
* @param userName
* The user name key.
* @return The user specific value.
*/
public String getPerUserEvictionPolicyClassName(final String userName) {
String value = null;
if (perUserEvictionPolicyClassName != null) {
value = perUserEvictionPolicyClassName.get(userName);
}
if (value == null) {
return getDefaultEvictionPolicyClassName();
}
return value;
}
/**
* Gets the user specific value for {@link GenericObjectPool#getLifo()} for the specified user's pool or the default
* if no user specific value is defined.
*
* @param userName
* The user name key.
* @return The user specific value.
*/
public boolean getPerUserLifo(final String userName) {
Boolean value = null;
if (perUserLifo != null) {
value = perUserLifo.get(userName);
}
if (value == null) {
return getDefaultLifo();
}
return value.booleanValue();
}
/**
* Gets the user specific value for {@link GenericObjectPool#getMaxIdle()} for the specified user's pool or the
* default if no user specific value is defined.
*
* @param userName
* The user name key.
* @return The user specific value.
*/
public int getPerUserMaxIdle(final String userName) {
Integer value = null;
if (perUserMaxIdle != null) {
value = perUserMaxIdle.get(userName);
}
if (value == null) {
return getDefaultMaxIdle();
}
return value.intValue();
}
/**
* Gets the user specific value for {@link GenericObjectPool#getMaxTotal()} for the specified user's pool or the
* default if no user specific value is defined.
*
* @param userName
* The user name key.
* @return The user specific value.
*/
public int getPerUserMaxTotal(final String userName) {
Integer value = null;
if (perUserMaxTotal != null) {
value = perUserMaxTotal.get(userName);
}
if (value == null) {
return getDefaultMaxTotal();
}
return value.intValue();
}
/**
* Gets the user specific value for {@link GenericObjectPool#getMaxWaitDuration()} for the specified user's pool or
* the default if no user specific value is defined.
*
* @param userName
* The user name key.
* @return The user specific value.
* @since 2.10.0
*/
public Duration getPerUserMaxWaitDuration(final String userName) {
Duration value = null;
if (perUserMaxWaitDuration != null) {
value = perUserMaxWaitDuration.get(userName);
}
if (value == null) {
return getDefaultMaxWait();
}
return value;
}
/**
* Gets the user specific value for {@link GenericObjectPool#getMaxWaitDuration()} for the specified user's pool or
* the default if no user specific value is defined.
*
* @param userName
* The user name key.
* @return The user specific value.
* @deprecated Use {@link #getPerUserMaxWaitDuration}.
*/
@Deprecated
public long getPerUserMaxWaitMillis(final String userName) {
return getPerUserMaxWaitDuration(userName).toMillis();
}
/**
* Gets the user specific value for {@link GenericObjectPool#getMinEvictableIdleDuration()} for the specified
* user's pool or the default if no user specific value is defined.
*
* @param userName
* The user name key.
* @return The user specific value, never null.
* @since 2.10.0
*/
public Duration getPerUserMinEvictableIdleDuration(final String userName) {
Duration value = null;
if (perUserMinEvictableIdleDuration != null) {
value = perUserMinEvictableIdleDuration.get(userName);
}
if (value == null) {
return getDefaultMinEvictableIdleDuration();
}
return value;
}
/**
* Gets the user specific value for {@link GenericObjectPool#getMinEvictableIdleDuration()} for the specified
* user's pool or the default if no user specific value is defined.
*
* @param userName
* The user name key.
* @return The user specific value.
* @deprecated Use {@link #getPerUserMinEvictableIdleDuration(String)}.
*/
@Deprecated
public long getPerUserMinEvictableIdleTimeMillis(final String userName) {
return getPerUserMinEvictableIdleDuration(userName).toMillis();
}
/**
* Gets the user specific value for {@link GenericObjectPool#getMinIdle()} for the specified user's pool or the
* default if no user specific value is defined.
*
* @param userName
* The user name key.
* @return The user specific value.
*/
public int getPerUserMinIdle(final String userName) {
Integer value = null;
if (perUserMinIdle != null) {
value = perUserMinIdle.get(userName);
}
if (value == null) {
return getDefaultMinIdle();
}
return value.intValue();
}
/**
* Gets the user specific value for {@link GenericObjectPool#getNumTestsPerEvictionRun()} for the specified user's
* pool or the default if no user specific value is defined.
*
* @param userName
* The user name key.
* @return The user specific value.
*/
public int getPerUserNumTestsPerEvictionRun(final String userName) {
Integer value = null;
if (perUserNumTestsPerEvictionRun != null) {
value = perUserNumTestsPerEvictionRun.get(userName);
}
if (value == null) {
return getDefaultNumTestsPerEvictionRun();
}
return value.intValue();
}
/**
* Gets the user specific value for {@link GenericObjectPool#getSoftMinEvictableIdleDuration()} for the specified
* user's pool or the default if no user specific value is defined.
*
* @param userName
* The user name key.
* @return The user specific value.
* @since 2.10.0
*/
public Duration getPerUserSoftMinEvictableIdleDuration(final String userName) {
Duration value = null;
if (perUserSoftMinEvictableIdleDuration != null) {
value = perUserSoftMinEvictableIdleDuration.get(userName);
}
if (value == null) {
return getDefaultSoftMinEvictableIdleDuration();
}
return value;
}
/**
* Gets the user specific value for {@link GenericObjectPool#getSoftMinEvictableIdleDuration()} for the specified
* user's pool or the default if no user specific value is defined.
*
* @param userName
* The user name key.
* @return The user specific value.
* @deprecated Use {@link #getPerUserSoftMinEvictableIdleDuration(String)}.
*/
@Deprecated
public long getPerUserSoftMinEvictableIdleTimeMillis(final String userName) {
return getPerUserSoftMinEvictableIdleDuration(userName).toMillis();
}
/**
* Gets the user specific value for {@link GenericObjectPool#getTestOnBorrow()} for the specified user's pool or the
* default if no user specific value is defined.
*
* @param userName
* The user name key.
* @return The user specific value.
*/
public boolean getPerUserTestOnBorrow(final String userName) {
Boolean value = null;
if (perUserTestOnBorrow != null) {
value = perUserTestOnBorrow.get(userName);
}
if (value == null) {
return getDefaultTestOnBorrow();
}
return value.booleanValue();
}
/**
* Gets the user specific value for {@link GenericObjectPool#getTestOnCreate()} for the specified user's pool or the
* default if no user specific value is defined.
*
* @param userName
* The user name key.
* @return The user specific value.
*/
public boolean getPerUserTestOnCreate(final String userName) {
Boolean value = null;
if (perUserTestOnCreate != null) {
value = perUserTestOnCreate.get(userName);
}
if (value == null) {
return getDefaultTestOnCreate();
}
return value.booleanValue();
}
/**
* Gets the user specific value for {@link GenericObjectPool#getTestOnReturn()} for the specified user's pool or the
* default if no user specific value is defined.
*
* @param userName
* The user name key.
* @return The user specific value.
*/
public boolean getPerUserTestOnReturn(final String userName) {
Boolean value = null;
if (perUserTestOnReturn != null) {
value = perUserTestOnReturn.get(userName);
}
if (value == null) {
return getDefaultTestOnReturn();
}
return value.booleanValue();
}
/**
* Gets the user specific value for {@link GenericObjectPool#getTestWhileIdle()} for the specified user's pool or
* the default if no user specific value is defined.
*
* @param userName
* The user name key.
* @return The user specific value.
*/
public boolean getPerUserTestWhileIdle(final String userName) {
Boolean value = null;
if (perUserTestWhileIdle != null) {
value = perUserTestWhileIdle.get(userName);
}
if (value == null) {
return getDefaultTestWhileIdle();
}
return value.booleanValue();
}
/**
* Gets the user specific value for {@link GenericObjectPool#getDurationBetweenEvictionRuns()} for the specified
* user's pool or the default if no user specific value is defined.
*
* @param userName
* The user name key.
* @return The user specific value.
* @deprecated Use {@link #getPerUserDurationBetweenEvictionRuns(String)}.
*/
@Deprecated
public long getPerUserTimeBetweenEvictionRunsMillis(final String userName) {
return getPerUserDurationBetweenEvictionRuns(userName).toMillis();
}
/**
* Returns the object pool associated with the given PoolKey.
*
* @param poolKey
* PoolKey identifying the pool
* @return the GenericObjectPool pooling connections for the userName and datasource specified by the PoolKey
*/
private ObjectPool getPool(final PoolKey poolKey) {
final CPDSConnectionFactory mgr = (CPDSConnectionFactory) managers.get(poolKey);
return mgr == null ? null : mgr.getPool();
}
@Override
protected PooledConnectionAndInfo getPooledConnectionAndInfo(final String userName, final String password)
throws SQLException {
final PoolKey key = getPoolKey(userName);
ObjectPool pool;
PooledConnectionManager manager;
synchronized (this) {
manager = managers.get(key);
if (manager == null) {
try {
registerPool(userName, password);
manager = managers.get(key);
} catch (final NamingException e) {
throw new SQLException("RegisterPool failed", e);
}
}
pool = getCPDSConnectionFactoryPool(manager);
}
PooledConnectionAndInfo info = null;
try {
info = pool.borrowObject();
} catch (final NoSuchElementException ex) {
throw new SQLException("Could not retrieve connection info from pool", ex);
} catch (final Exception e) {
// See if failure is due to CPDSConnectionFactory authentication failure
try {
testCPDS(userName, password);
} catch (final Exception ex) {
throw new SQLException("Could not retrieve connection info from pool", ex);
}
// New password works, so kill the old pool, create a new one, and borrow
manager.closePool(userName);
synchronized (this) {
managers.remove(key);
}
try {
registerPool(userName, password);
pool = getPool(key);
} catch (final NamingException ne) {
throw new SQLException("RegisterPool failed", ne);
}
try {
info = pool.borrowObject();
} catch (final Exception ex) {
throw new SQLException("Could not retrieve connection info from pool", ex);
}
}
return info;
}
/**
* Creates a pool key from the provided parameters.
*
* @param userName
* User name
* @return The pool key
*/
private PoolKey getPoolKey(final String userName) {
return new PoolKey(getDataSourceName(), userName);
}
/**
* Returns a {@code PerUserPoolDataSource} {@link Reference}.
*/
@Override
public Reference getReference() throws NamingException {
final Reference ref = new Reference(getClass().getName(), PerUserPoolDataSourceFactory.class.getName(), null);
ref.add(new StringRefAddr("instanceKey", getInstanceKey()));
return ref;
}
Map put(Map map, final K key, final V value) {
if (map == null) {
map = createMap();
}
map.put(key, value);
return map;
}
/**
* Supports Serialization interface.
*
* @param in
* a {@link java.io.ObjectInputStream} value
* @throws IOException
* if an error occurs
* @throws ClassNotFoundException
* if an error occurs
*/
private void readObject(final ObjectInputStream in) throws IOException, ClassNotFoundException {
try {
in.defaultReadObject();
final PerUserPoolDataSource oldDS = (PerUserPoolDataSource) new PerUserPoolDataSourceFactory()
.getObjectInstance(getReference(), null, null, null);
this.managers = oldDS.managers;
} catch (final NamingException e) {
throw new IOException("NamingException: " + e);
}
}
private synchronized void registerPool(final String userName, final String password)
throws NamingException, SQLException {
final ConnectionPoolDataSource cpds = testCPDS(userName, password);
// Set up the factory we will use (passing the pool associates
// the factory with the pool, so we do not have to do so
// explicitly)
final CPDSConnectionFactory factory = new CPDSConnectionFactory(cpds, getValidationQuery(), getValidationQueryTimeoutDuration(),
isRollbackAfterValidation(), userName, password);
factory.setMaxConn(getMaxConnDuration());
// Create an object pool to contain our PooledConnections
final GenericObjectPool pool = new GenericObjectPool<>(factory);
factory.setPool(pool);
pool.setBlockWhenExhausted(getPerUserBlockWhenExhausted(userName));
pool.setEvictionPolicyClassName(getPerUserEvictionPolicyClassName(userName));
pool.setLifo(getPerUserLifo(userName));
pool.setMaxIdle(getPerUserMaxIdle(userName));
pool.setMaxTotal(getPerUserMaxTotal(userName));
pool.setMaxWait(getPerUserMaxWaitDuration(userName));
pool.setMinEvictableIdleDuration(getPerUserMinEvictableIdleDuration(userName));
pool.setMinIdle(getPerUserMinIdle(userName));
pool.setNumTestsPerEvictionRun(getPerUserNumTestsPerEvictionRun(userName));
pool.setSoftMinEvictableIdleDuration(getPerUserSoftMinEvictableIdleDuration(userName));
pool.setTestOnCreate(getPerUserTestOnCreate(userName));
pool.setTestOnBorrow(getPerUserTestOnBorrow(userName));
pool.setTestOnReturn(getPerUserTestOnReturn(userName));
pool.setTestWhileIdle(getPerUserTestWhileIdle(userName));
pool.setDurationBetweenEvictionRuns(getPerUserDurationBetweenEvictionRuns(userName));
pool.setSwallowedExceptionListener(new SwallowedExceptionLogger(log));
final PooledConnectionManager old = managers.put(getPoolKey(userName), factory);
if (old != null) {
throw new IllegalStateException("Pool already contains an entry for this user/password: " + userName);
}
}
private Map replaceAll(final Map currentMap, final Map newMap) {
if (currentMap == null) {
return new HashMap<>(newMap);
}
currentMap.clear();
currentMap.putAll(newMap);
return currentMap;
}
void setPerUserBlockWhenExhausted(final Map newMap) {
assertInitializationAllowed();
perUserBlockWhenExhausted = replaceAll(perUserBlockWhenExhausted, newMap);
}
/**
* Sets a user specific value for {@link GenericObjectPool#getBlockWhenExhausted()} for the specified user's pool.
*
* @param userName
* The user name key.
* @param value
* The user specific value.
*/
public void setPerUserBlockWhenExhausted(final String userName, final Boolean value) {
assertInitializationAllowed();
perUserBlockWhenExhausted = put(perUserBlockWhenExhausted, userName, value);
}
void setPerUserDefaultAutoCommit(final Map newMap) {
assertInitializationAllowed();
perUserDefaultAutoCommit = replaceAll(perUserDefaultAutoCommit, newMap);
}
/**
* Sets a user specific default value for {@link Connection#setAutoCommit(boolean)} for the specified user's pool.
*
* @param userName
* The user name key.
* @param value
* The user specific value.
*/
public void setPerUserDefaultAutoCommit(final String userName, final Boolean value) {
assertInitializationAllowed();
perUserDefaultAutoCommit = put(perUserDefaultAutoCommit, userName, value);
}
void setPerUserDefaultReadOnly(final Map newMap) {
assertInitializationAllowed();
perUserDefaultReadOnly = replaceAll(perUserDefaultReadOnly, newMap);
}
/**
* Sets a user specific default value for {@link Connection#setReadOnly(boolean)} for the specified user's pool.
*
* @param userName
* The user name key.
* @param value
* The user specific value.
*/
public void setPerUserDefaultReadOnly(final String userName, final Boolean value) {
assertInitializationAllowed();
perUserDefaultReadOnly = put(perUserDefaultReadOnly, userName, value);
}
void setPerUserDefaultTransactionIsolation(final Map newMap) {
assertInitializationAllowed();
perUserDefaultTransactionIsolation = replaceAll(perUserDefaultTransactionIsolation, newMap);
}
/**
* Sets a user specific default value for {@link Connection#setTransactionIsolation(int)} for the specified user's
* pool.
*
* @param userName
* The user name key.
* @param value
* The user specific value.
*/
public void setPerUserDefaultTransactionIsolation(final String userName, final Integer value) {
assertInitializationAllowed();
perUserDefaultTransactionIsolation = put(perUserDefaultTransactionIsolation, userName, value);
}
void setPerUserDurationBetweenEvictionRuns(final Map newMap) {
assertInitializationAllowed();
perUserDurationBetweenEvictionRuns = replaceAll(perUserDurationBetweenEvictionRuns, newMap);
}
/**
* Sets a user specific value for {@link GenericObjectPool#getDurationBetweenEvictionRuns()} for the specified
* user's pool.
*
* @param userName
* The user name key.
* @param value
* The user specific value.
* @since 2.10.0
*/
public void setPerUserDurationBetweenEvictionRuns(final String userName, final Duration value) {
assertInitializationAllowed();
perUserDurationBetweenEvictionRuns = put(perUserDurationBetweenEvictionRuns, userName, value);
}
void setPerUserEvictionPolicyClassName(final Map newMap) {
assertInitializationAllowed();
perUserEvictionPolicyClassName = replaceAll(perUserEvictionPolicyClassName, newMap);
}
/**
* Sets a user specific value for {@link GenericObjectPool#getEvictionPolicyClassName()} for the specified user's
* pool.
*
* @param userName
* The user name key.
* @param value
* The user specific value.
*/
public void setPerUserEvictionPolicyClassName(final String userName, final String value) {
assertInitializationAllowed();
perUserEvictionPolicyClassName = put(perUserEvictionPolicyClassName, userName, value);
}
void setPerUserLifo(final Map newMap) {
assertInitializationAllowed();
perUserLifo = replaceAll(perUserLifo, newMap);
}
/**
* Sets a user specific value for {@link GenericObjectPool#getLifo()} for the specified user's pool.
*
* @param userName
* The user name key.
* @param value
* The user specific value.
*/
public void setPerUserLifo(final String userName, final Boolean value) {
assertInitializationAllowed();
perUserLifo = put(perUserLifo, userName, value);
}
void setPerUserMaxIdle(final Map newMap) {
assertInitializationAllowed();
perUserMaxIdle = replaceAll(perUserMaxIdle, newMap);
}
/**
* Sets a user specific value for {@link GenericObjectPool#getMaxIdle()} for the specified user's pool.
*
* @param userName
* The user name key.
* @param value
* The user specific value.
*/
public void setPerUserMaxIdle(final String userName, final Integer value) {
assertInitializationAllowed();
perUserMaxIdle = put(perUserMaxIdle, userName, value);
}
void setPerUserMaxTotal(final Map newMap) {
assertInitializationAllowed();
perUserMaxTotal = replaceAll(perUserMaxTotal, newMap);
}
/**
* Sets a user specific value for {@link GenericObjectPool#getMaxTotal()} for the specified user's pool.
*
* @param userName
* The user name key.
* @param value
* The user specific value.
*/
public void setPerUserMaxTotal(final String userName, final Integer value) {
assertInitializationAllowed();
perUserMaxTotal = put(perUserMaxTotal, userName, value);
}
/**
* Sets a user specific value for {@link GenericObjectPool#getMaxWaitDuration()} for the specified user's pool.
*
* @param userName
* The user name key.
* @param value
* The user specific value.
* @since 2.10.0
*/
public void setPerUserMaxWait(final String userName, final Duration value) {
assertInitializationAllowed();
perUserMaxWaitDuration = put(perUserMaxWaitDuration, userName, value);
}
void setPerUserMaxWaitDuration(final Map newMap) {
assertInitializationAllowed();
perUserMaxWaitDuration = replaceAll(perUserMaxWaitDuration, newMap);
}
void setPerUserMaxWaitMillis(final Map newMap) {
assertInitializationAllowed();
perUserMaxWaitDuration = convertMap(perUserMaxWaitDuration, newMap);
}
/**
* Sets a user specific value for {@link GenericObjectPool#getMaxWaitDuration()} for the specified user's pool.
*
* @param userName
* The user name key.
* @param value
* The user specific value.
* @deprecated Use {@link #setPerUserMaxWait(String, Duration)}.
*/
@Deprecated
public void setPerUserMaxWaitMillis(final String userName, final Long value) {
setPerUserMaxWait(userName, toDurationOrNull(value));
}
void setPerUserMinEvictableIdle(final Map newMap) {
assertInitializationAllowed();
perUserMinEvictableIdleDuration = replaceAll(perUserMinEvictableIdleDuration, newMap);
}
/**
* Sets a user specific value for {@link GenericObjectPool#getMinEvictableIdleDuration()} for the specified user's
* pool.
*
* @param userName
* The user name key.
* @param value
* The user specific value.
* @since 2.10.0
*/
public void setPerUserMinEvictableIdle(final String userName, final Duration value) {
assertInitializationAllowed();
perUserMinEvictableIdleDuration = put(perUserMinEvictableIdleDuration, userName, value);
}
/**
* Sets a user specific value for {@link GenericObjectPool#getMinEvictableIdleDuration()} for the specified user's
* pool.
*
* @param userName
* The user name key.
* @param value
* The user specific value.
* @deprecated Use {@link #setPerUserMinEvictableIdle(String, Duration)}.
*/
@Deprecated
public void setPerUserMinEvictableIdleTimeMillis(final String userName, final Long value) {
setPerUserMinEvictableIdle(userName, toDurationOrNull(value));
}
void setPerUserMinIdle(final Map newMap) {
assertInitializationAllowed();
perUserMinIdle = replaceAll(perUserMinIdle, newMap);
}
/**
* Sets a user specific value for {@link GenericObjectPool#getMinIdle()} for the specified user's pool.
*
* @param userName
* The user name key.
* @param value
* The user specific value.
*/
public void setPerUserMinIdle(final String userName, final Integer value) {
assertInitializationAllowed();
perUserMinIdle = put(perUserMinIdle, userName, value);
}
void setPerUserNumTestsPerEvictionRun(final Map newMap) {
assertInitializationAllowed();
perUserNumTestsPerEvictionRun = replaceAll(perUserNumTestsPerEvictionRun, newMap);
}
/**
* Sets a user specific value for {@link GenericObjectPool#getNumTestsPerEvictionRun()} for the specified user's
* pool.
*
* @param userName
* The user name key.
* @param value
* The user specific value.
*/
public void setPerUserNumTestsPerEvictionRun(final String userName, final Integer value) {
assertInitializationAllowed();
perUserNumTestsPerEvictionRun = put(perUserNumTestsPerEvictionRun, userName, value);
}
void setPerUserSoftMinEvictableIdle(final Map newMap) {
assertInitializationAllowed();
perUserSoftMinEvictableIdleDuration = replaceAll(perUserSoftMinEvictableIdleDuration, newMap);
}
/**
* Sets a user specific value for {@link GenericObjectPool#getSoftMinEvictableIdleDuration()} for the specified
* user's pool.
*
* @param userName
* The user name key.
* @param value
* The user specific value.
* @since 2.10.0
*/
public void setPerUserSoftMinEvictableIdle(final String userName, final Duration value) {
assertInitializationAllowed();
perUserSoftMinEvictableIdleDuration = put(perUserSoftMinEvictableIdleDuration, userName, value);
}
/**
* Sets a user specific value for {@link GenericObjectPool#getSoftMinEvictableIdleDuration()} for the specified
* user's pool.
*
* @param userName
* The user name key.
* @param value
* The user specific value.
* @deprecated Use {@link #setPerUserSoftMinEvictableIdle(String, Duration)}.
*/
@Deprecated
public void setPerUserSoftMinEvictableIdleTimeMillis(final String userName, final Long value) {
setPerUserSoftMinEvictableIdle(userName, toDurationOrNull(value));
}
void setPerUserTestOnBorrow(final Map newMap) {
assertInitializationAllowed();
perUserTestOnBorrow = replaceAll(perUserTestOnBorrow, newMap);
}
/**
* Sets a user specific value for {@link GenericObjectPool#getTestOnBorrow()} for the specified user's pool.
*
* @param userName
* The user name key.
* @param value
* The user specific value.
*/
public void setPerUserTestOnBorrow(final String userName, final Boolean value) {
assertInitializationAllowed();
perUserTestOnBorrow = put(perUserTestOnBorrow, userName, value);
}
void setPerUserTestOnCreate(final Map newMap) {
assertInitializationAllowed();
perUserTestOnCreate = replaceAll(perUserTestOnCreate, newMap);
}
/**
* Sets a user specific value for {@link GenericObjectPool#getTestOnCreate()} for the specified user's pool.
*
* @param userName
* The user name key.
* @param value
* The user specific value.
*/
public void setPerUserTestOnCreate(final String userName, final Boolean value) {
assertInitializationAllowed();
perUserTestOnCreate = put(perUserTestOnCreate, userName, value);
}
void setPerUserTestOnReturn(final Map newMap) {
assertInitializationAllowed();
perUserTestOnReturn = replaceAll(perUserTestOnReturn, newMap);
}
/**
* Sets a user specific value for {@link GenericObjectPool#getTestOnReturn()} for the specified user's pool.
*
* @param userName
* The user name key.
* @param value
* The user specific value.
*/
public void setPerUserTestOnReturn(final String userName, final Boolean value) {
assertInitializationAllowed();
perUserTestOnReturn = put(perUserTestOnReturn, userName, value);
}
void setPerUserTestWhileIdle(final Map newMap) {
assertInitializationAllowed();
perUserTestWhileIdle = replaceAll(perUserTestWhileIdle, newMap);
}
/**
* Sets a user specific value for {@link GenericObjectPool#getTestWhileIdle()} for the specified user's pool.
*
* @param userName
* The user name key.
* @param value
* The user specific value.
*/
public void setPerUserTestWhileIdle(final String userName, final Boolean value) {
assertInitializationAllowed();
perUserTestWhileIdle = put(perUserTestWhileIdle, userName, value);
}
/**
* Sets a user specific value for {@link GenericObjectPool#getDurationBetweenEvictionRuns()} for the specified
* user's pool.
*
* @param userName
* The user name key.
* @param value
* The user specific value.
* @deprecated Use {@link #setPerUserDurationBetweenEvictionRuns(String, Duration)}.
*/
@Deprecated
public void setPerUserTimeBetweenEvictionRunsMillis(final String userName, final Long value) {
setPerUserDurationBetweenEvictionRuns(userName, toDurationOrNull(value));
}
@Override
protected void setupDefaults(final Connection con, final String userName) throws SQLException {
Boolean defaultAutoCommit = isDefaultAutoCommit();
if (userName != null) {
final Boolean userMax = getPerUserDefaultAutoCommit(userName);
if (userMax != null) {
defaultAutoCommit = userMax;
}
}
Boolean defaultReadOnly = isDefaultReadOnly();
if (userName != null) {
final Boolean userMax = getPerUserDefaultReadOnly(userName);
if (userMax != null) {
defaultReadOnly = userMax;
}
}
int defaultTransactionIsolation = getDefaultTransactionIsolation();
if (userName != null) {
final Integer userMax = getPerUserDefaultTransactionIsolation(userName);
if (userMax != null) {
defaultTransactionIsolation = userMax.intValue();
}
}
if (defaultAutoCommit != null && con.getAutoCommit() != defaultAutoCommit.booleanValue()) {
con.setAutoCommit(defaultAutoCommit.booleanValue());
}
if (defaultTransactionIsolation != UNKNOWN_TRANSACTIONISOLATION) {
con.setTransactionIsolation(defaultTransactionIsolation);
}
if (defaultReadOnly != null && con.isReadOnly() != defaultReadOnly.booleanValue()) {
con.setReadOnly(defaultReadOnly.booleanValue());
}
}
private Duration toDurationOrNull(final Long millis) {
return millis == null ? null : Duration.ofMillis(millis.longValue());
}
}