This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-dbcp.git
The following commit(s) were added to refs/heads/master by this push: new 1a0e9e8 Fix typo in method name. Javadoc. Private static final should be in upper case. 1a0e9e8 is described below commit 1a0e9e8a61b7e8327a159516907778cd74da7a3b Author: Gary Gregory <gardgreg...@gmail.com> AuthorDate: Sat Jun 5 08:57:48 2021 -0400 Fix typo in method name. Javadoc. Private static final should be in upper case. --- .../dbcp2/datasources/InstanceKeyDataSource.java | 2 +- .../datasources/InstanceKeyDataSourceFactory.java | 20 +++++++++--------- .../datasources/KeyedCPDSConnectionFactory.java | 24 +++++++++++----------- .../dbcp2/datasources/PerUserPoolDataSource.java | 2 +- .../dbcp2/datasources/SharedPoolDataSource.java | 8 +------- .../commons/dbcp2/datasources/UserPassKey.java | 3 ++- .../commons/dbcp2/datasources/TestUserPassKey.java | 2 +- 7 files changed, 28 insertions(+), 33 deletions(-) diff --git a/src/main/java/org/apache/commons/dbcp2/datasources/InstanceKeyDataSource.java b/src/main/java/org/apache/commons/dbcp2/datasources/InstanceKeyDataSource.java index 2b5dbab..b97be75 100644 --- a/src/main/java/org/apache/commons/dbcp2/datasources/InstanceKeyDataSource.java +++ b/src/main/java/org/apache/commons/dbcp2/datasources/InstanceKeyDataSource.java @@ -138,7 +138,7 @@ public abstract class InstanceKeyDataSource implements DataSource, Referenceable private Boolean defaultReadOnly; /** - * Default no-arg constructor for Serialization + * Default no-arg constructor for Serialization. */ public InstanceKeyDataSource() { } diff --git a/src/main/java/org/apache/commons/dbcp2/datasources/InstanceKeyDataSourceFactory.java b/src/main/java/org/apache/commons/dbcp2/datasources/InstanceKeyDataSourceFactory.java index 211ef7d..db9bdf7 100644 --- a/src/main/java/org/apache/commons/dbcp2/datasources/InstanceKeyDataSourceFactory.java +++ b/src/main/java/org/apache/commons/dbcp2/datasources/InstanceKeyDataSourceFactory.java @@ -42,11 +42,11 @@ import org.apache.commons.dbcp2.ListException; */ abstract class InstanceKeyDataSourceFactory implements ObjectFactory { - private static final Map<String, InstanceKeyDataSource> instanceMap = new ConcurrentHashMap<>(); + private static final Map<String, InstanceKeyDataSource> INSTANCE_MAP = new ConcurrentHashMap<>(); static synchronized String registerNewInstance(final InstanceKeyDataSource ds) { int max = 0; - for (final String s : instanceMap.keySet()) { + for (final String s : INSTANCE_MAP.keySet()) { if (s != null) { try { max = Math.max(max, Integer.parseInt(s)); @@ -58,13 +58,13 @@ abstract class InstanceKeyDataSourceFactory implements ObjectFactory { final String instanceKey = String.valueOf(max + 1); // Put a placeholder here for now, so other instances will not // take our key. We will replace with a pool when ready. - instanceMap.put(instanceKey, ds); + INSTANCE_MAP.put(instanceKey, ds); return instanceKey; } static void removeInstance(final String key) { if (key != null) { - instanceMap.remove(key); + INSTANCE_MAP.remove(key); } } @@ -80,8 +80,8 @@ abstract class InstanceKeyDataSourceFactory implements ObjectFactory { */ public static void closeAll() throws Exception { // Get iterator to loop over all instances of this data source. - final List<Throwable> exceptionList = new ArrayList<>(instanceMap.size()); - for (final Entry<String, InstanceKeyDataSource> next : instanceMap.entrySet()) { + final List<Throwable> exceptionList = new ArrayList<>(INSTANCE_MAP.size()); + for (final Entry<String, InstanceKeyDataSource> next : INSTANCE_MAP.entrySet()) { // Bullet-proof to avoid anything else but problems from InstanceKeyDataSource#close(). if (next != null) { @SuppressWarnings("resource") final InstanceKeyDataSource value = next.getValue(); @@ -94,7 +94,7 @@ abstract class InstanceKeyDataSourceFactory implements ObjectFactory { } } } - instanceMap.clear(); + INSTANCE_MAP.clear(); if (!exceptionList.isEmpty()) { throw new ListException("Could not close all InstanceKeyDataSource instances.", exceptionList); } @@ -115,7 +115,7 @@ abstract class InstanceKeyDataSourceFactory implements ObjectFactory { final RefAddr refAddr = ref.get("instanceKey"); if (refAddr != null && refAddr.getContent() != null) { // object was bound to JNDI via Referenceable API. - obj = instanceMap.get(refAddr.getContent()); + obj = INSTANCE_MAP.get(refAddr.getContent()); } else { // Tomcat JNDI creates a Reference out of server.xml // <ResourceParam> configuration and passes it to an @@ -123,14 +123,14 @@ abstract class InstanceKeyDataSourceFactory implements ObjectFactory { String key = null; if (name != null) { key = name.toString(); - obj = instanceMap.get(key); + obj = INSTANCE_MAP.get(key); } if (obj == null) { final InstanceKeyDataSource ds = getNewInstance(ref); setCommonProperties(ref, ds); obj = ds; if (key != null) { - instanceMap.put(key, ds); + INSTANCE_MAP.put(key, ds); } } } diff --git a/src/main/java/org/apache/commons/dbcp2/datasources/KeyedCPDSConnectionFactory.java b/src/main/java/org/apache/commons/dbcp2/datasources/KeyedCPDSConnectionFactory.java index 5976253..e289d2e 100644 --- a/src/main/java/org/apache/commons/dbcp2/datasources/KeyedCPDSConnectionFactory.java +++ b/src/main/java/org/apache/commons/dbcp2/datasources/KeyedCPDSConnectionFactory.java @@ -112,24 +112,24 @@ class KeyedCPDSConnectionFactory implements KeyedPooledObjectFactory<UserPassKey */ @Override public synchronized PooledObject<PooledConnectionAndInfo> makeObject(final UserPassKey upkey) throws Exception { - PooledConnection pc = null; - final String userName = upkey.getUsername(); + PooledConnection pooledConnection = null; + final String userName = upkey.getUserName(); final String password = upkey.getPassword(); if (userName == null) { - pc = cpds.getPooledConnection(); + pooledConnection = cpds.getPooledConnection(); } else { - pc = cpds.getPooledConnection(userName, password); + pooledConnection = cpds.getPooledConnection(userName, password); } - if (pc == null) { + if (pooledConnection == null) { throw new IllegalStateException("Connection pool data source returned null from getPooledConnection"); } // should we add this object as a listener or the pool. // consider the validateObject method in decision - pc.addConnectionEventListener(this); - final PooledConnectionAndInfo pci = new PooledConnectionAndInfo(pc, userName, upkey.getPasswordCharArray()); - pcMap.put(pc, pci); + pooledConnection.addConnectionEventListener(this); + final PooledConnectionAndInfo pci = new PooledConnectionAndInfo(pooledConnection, userName, upkey.getPasswordCharArray()); + pcMap.put(pooledConnection, pci); return new DefaultPooledObject<>(pci); } @@ -139,10 +139,10 @@ class KeyedCPDSConnectionFactory implements KeyedPooledObjectFactory<UserPassKey */ @Override public void destroyObject(final UserPassKey key, final PooledObject<PooledConnectionAndInfo> p) throws Exception { - final PooledConnection pc = p.getObject().getPooledConnection(); - pc.removeConnectionEventListener(this); - pcMap.remove(pc); - pc.close(); + final PooledConnection pooledConnection = p.getObject().getPooledConnection(); + pooledConnection.removeConnectionEventListener(this); + pcMap.remove(pooledConnection); + pooledConnection.close(); } /** diff --git a/src/main/java/org/apache/commons/dbcp2/datasources/PerUserPoolDataSource.java b/src/main/java/org/apache/commons/dbcp2/datasources/PerUserPoolDataSource.java index 9f5df69..40d1b94 100644 --- a/src/main/java/org/apache/commons/dbcp2/datasources/PerUserPoolDataSource.java +++ b/src/main/java/org/apache/commons/dbcp2/datasources/PerUserPoolDataSource.java @@ -134,7 +134,7 @@ public class PerUserPoolDataSource extends InstanceKeyDataSource { @Override protected PooledConnectionManager getConnectionManager(final UserPassKey upKey) { - return managers.get(getPoolKey(upKey.getUsername())); + return managers.get(getPoolKey(upKey.getUserName())); } private ObjectPool<PooledConnectionAndInfo> getCPDSConnectionFactoryPool(final PooledConnectionManager manager) { diff --git a/src/main/java/org/apache/commons/dbcp2/datasources/SharedPoolDataSource.java b/src/main/java/org/apache/commons/dbcp2/datasources/SharedPoolDataSource.java index d015f71..95b8384 100644 --- a/src/main/java/org/apache/commons/dbcp2/datasources/SharedPoolDataSource.java +++ b/src/main/java/org/apache/commons/dbcp2/datasources/SharedPoolDataSource.java @@ -76,9 +76,6 @@ public class SharedPoolDataSource extends InstanceKeyDataSource { InstanceKeyDataSourceFactory.removeInstance(getInstanceKey()); } - // ------------------------------------------------------------------- - // Properties - /** * Gets {@link GenericKeyedObjectPool#getMaxTotal()} for this pool. * @@ -120,9 +117,6 @@ public class SharedPoolDataSource extends InstanceKeyDataSource { return pool == null ? 0 : pool.getNumIdle(); } - // ---------------------------------------------------------------------- - // Inherited abstract methods - @Override protected PooledConnectionAndInfo getPooledConnectionAndInfo(final String userName, final String userPassword) throws SQLException { @@ -155,7 +149,7 @@ public class SharedPoolDataSource extends InstanceKeyDataSource { } /** - * Returns a <code>SharedPoolDataSource</code> {@link Reference}. + * Creates a new {@link Reference} to a {@link SharedPoolDataSource}. */ @Override public Reference getReference() throws NamingException { diff --git a/src/main/java/org/apache/commons/dbcp2/datasources/UserPassKey.java b/src/main/java/org/apache/commons/dbcp2/datasources/UserPassKey.java index 42ad36d..0149655 100644 --- a/src/main/java/org/apache/commons/dbcp2/datasources/UserPassKey.java +++ b/src/main/java/org/apache/commons/dbcp2/datasources/UserPassKey.java @@ -21,6 +21,7 @@ import java.io.Serializable; import java.util.Objects; import org.apache.commons.dbcp2.Utils; +import org.apache.commons.pool2.KeyedObjectPool; /** * <p> @@ -102,7 +103,7 @@ class UserPassKey implements Serializable { * * @return value of user name. */ - String getUsername() { + String getUserName() { return userName; } diff --git a/src/test/java/org/apache/commons/dbcp2/datasources/TestUserPassKey.java b/src/test/java/org/apache/commons/dbcp2/datasources/TestUserPassKey.java index be63c15..2ee4160 100644 --- a/src/test/java/org/apache/commons/dbcp2/datasources/TestUserPassKey.java +++ b/src/test/java/org/apache/commons/dbcp2/datasources/TestUserPassKey.java @@ -42,7 +42,7 @@ public class TestUserPassKey { @Test public void testGettersAndSetters() { - assertEquals("user", userPassKey.getUsername()); + assertEquals("user", userPassKey.getUserName()); assertEquals("pass", userPassKey.getPassword()); assertArrayEquals(Utils.toCharArray("pass"), userPassKey.getPasswordCharArray()); }