consistent use of JDK 1.5's ThreadLocal.remove() over ThreadLocal.set(null), preventing leaks (SPR-7441)

jhoeller · jhoeller · commit e56cfb81734c · 2010-09-01T17:17:25.000Z
diff --git a/org.springframework.aop/src/main/java/org/springframework/aop/framework/AopContext.java b/org.springframework.aop/src/main/java/org/springframework/aop/framework/AopContext.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2009 the original author or authors.
+ * Copyright 2002-2010 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -76,7 +76,12 @@ public static Object currentProxy() throws IllegalStateException {
 	 */
 	static Object setCurrentProxy(Object proxy) {
 		Object old = currentProxy.get();
-		currentProxy.set(proxy);
+		if (proxy != null) {
+			currentProxy.set(proxy);
+		}
+		else {
+			currentProxy.remove();
+		}
 		return old;
 	}
 
diff --git a/org.springframework.aop/src/main/java/org/springframework/aop/target/ThreadLocalTargetSource.java b/org.springframework.aop/src/main/java/org/springframework/aop/target/ThreadLocalTargetSource.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2008 the original author or authors.
+ * Copyright 2002-2010 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -106,7 +106,7 @@ public void destroy() {
 			this.targetSet.clear();
 		}
 		// Clear ThreadLocal, just in case.
-		this.targetInThread.set(null);
+		this.targetInThread.remove();
 	}
 
 
diff --git a/org.springframework.beans/src/main/java/org/springframework/beans/factory/support/AbstractBeanFactory.java b/org.springframework.beans/src/main/java/org/springframework/beans/factory/support/AbstractBeanFactory.java
@@ -904,13 +904,13 @@ else if (curVal instanceof String) {
 	protected void afterPrototypeCreation(String beanName) {
 		Object curVal = this.prototypesCurrentlyInCreation.get();
 		if (curVal instanceof String) {
-			this.prototypesCurrentlyInCreation.set(null);
+			this.prototypesCurrentlyInCreation.remove();
 		}
 		else if (curVal instanceof Set) {
 			Set<String> beanNameSet = (Set<String>) curVal;
 			beanNameSet.remove(beanName);
 			if (beanNameSet.isEmpty()) {
-				this.prototypesCurrentlyInCreation.set(null);
+				this.prototypesCurrentlyInCreation.remove();
 			}
 		}
 	}
diff --git a/org.springframework.beans/src/main/java/org/springframework/beans/factory/xml/XmlBeanDefinitionReader.java b/org.springframework.beans/src/main/java/org/springframework/beans/factory/xml/XmlBeanDefinitionReader.java
@@ -344,7 +344,7 @@ public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefin
 		finally {
 			currentResources.remove(encodedResource);
 			if (currentResources.isEmpty()) {
-				this.resourcesCurrentlyBeingLoaded.set(null);
+				this.resourcesCurrentlyBeingLoaded.remove();
 			}
 		}
 	}
diff --git a/org.springframework.context.support/src/main/java/org/springframework/scheduling/quartz/SchedulerFactoryBean.java b/org.springframework.context.support/src/main/java/org/springframework/scheduling/quartz/SchedulerFactoryBean.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2009 the original author or authors.
+ * Copyright 2002-2010 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -496,16 +496,16 @@ public void afterPropertiesSet() throws Exception {
 
 		finally {
 			if (this.resourceLoader != null) {
-				configTimeResourceLoaderHolder.set(null);
+				configTimeResourceLoaderHolder.remove();
 			}
 			if (this.taskExecutor != null) {
-				configTimeTaskExecutorHolder.set(null);
+				configTimeTaskExecutorHolder.remove();
 			}
 			if (this.dataSource != null) {
-				configTimeDataSourceHolder.set(null);
+				configTimeDataSourceHolder.remove();
 			}
 			if (this.nonTransactionalDataSource != null) {
-				configTimeNonTransactionalDataSourceHolder.set(null);
+				configTimeNonTransactionalDataSourceHolder.remove();
 			}
 		}
 
diff --git a/org.springframework.context/src/main/java/org/springframework/context/i18n/LocaleContextHolder.java b/org.springframework.context/src/main/java/org/springframework/context/i18n/LocaleContextHolder.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2009 the original author or authors.
+ * Copyright 2002-2010 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -51,8 +51,8 @@ public abstract class LocaleContextHolder {
 	 * Reset the LocaleContext for the current thread.
 	 */
 	public static void resetLocaleContext() {
-		localeContextHolder.set(null);
-		inheritableLocaleContextHolder.set(null);
+		localeContextHolder.remove();
+		inheritableLocaleContextHolder.remove();
 	}
 
 	/**
@@ -75,11 +75,11 @@ public static void setLocaleContext(LocaleContext localeContext) {
 	public static void setLocaleContext(LocaleContext localeContext, boolean inheritable) {
 		if (inheritable) {
 			inheritableLocaleContextHolder.set(localeContext);
-			localeContextHolder.set(null);
+			localeContextHolder.remove();
 		}
 		else {
 			localeContextHolder.set(localeContext);
-			inheritableLocaleContextHolder.set(null);
+			inheritableLocaleContextHolder.remove();
 		}
 	}
 
diff --git a/org.springframework.jdbc/src/main/java/org/springframework/jdbc/datasource/UserCredentialsDataSourceAdapter.java b/org.springframework.jdbc/src/main/java/org/springframework/jdbc/datasource/UserCredentialsDataSourceAdapter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2009 the original author or authors.
+ * Copyright 2002-2010 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -114,7 +114,7 @@ public void setCredentialsForCurrentThread(String username, String password) {
 	 * @see #setCredentialsForCurrentThread
 	 */
 	public void removeCredentialsFromCurrentThread() {
-		this.threadBoundCredentials.set(null);
+		this.threadBoundCredentials.remove();
 	}
 
 
diff --git a/org.springframework.jms/src/main/java/org/springframework/jms/connection/UserCredentialsConnectionFactoryAdapter.java b/org.springframework.jms/src/main/java/org/springframework/jms/connection/UserCredentialsConnectionFactoryAdapter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2009 the original author or authors.
+ * Copyright 2002-2010 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -131,7 +131,7 @@ public void setCredentialsForCurrentThread(String username, String password) {
 	 * @see #setCredentialsForCurrentThread
 	 */
 	public void removeCredentialsFromCurrentThread() {
-		this.threadBoundCredentials.set(null);
+		this.threadBoundCredentials.remove();
 	}
 
 
diff --git a/org.springframework.orm/src/main/java/org/springframework/orm/hibernate3/LocalSessionFactoryBean.java b/org.springframework.orm/src/main/java/org/springframework/orm/hibernate3/LocalSessionFactoryBean.java
@@ -776,19 +776,19 @@ else if (strategyAndRegion.length > 0) {
 
 		finally {
 			if (dataSource != null) {
-				configTimeDataSourceHolder.set(null);
+				configTimeDataSourceHolder.remove();
 			}
 			if (this.jtaTransactionManager != null) {
-				configTimeTransactionManagerHolder.set(null);
+				configTimeTransactionManagerHolder.remove();
 			}
 			if (this.cacheRegionFactory != null) {
-				configTimeCacheProviderHolder.set(null);
+				configTimeCacheProviderHolder.remove();
 			}
 			if (this.cacheProvider != null) {
-				configTimeCacheProviderHolder.set(null);
+				configTimeCacheProviderHolder.remove();
 			}
 			if (this.lobHandler != null) {
-				configTimeLobHandlerHolder.set(null);
+				configTimeLobHandlerHolder.remove();
 			}
 			if (overrideClassLoader) {
 				// Reset original thread context ClassLoader.
@@ -896,7 +896,7 @@ public void destroy() throws HibernateException {
 		finally {
 			if (dataSource != null) {
 				// Reset DataSource holder.
-				configTimeDataSourceHolder.set(null);
+				configTimeDataSourceHolder.remove();
 			}
 		}
 	}
@@ -942,7 +942,7 @@ public Object doInHibernate(Session session) throws HibernateException, SQLExcep
 		}
 		finally {
 			if (dataSource != null) {
-				configTimeDataSourceHolder.set(null);
+				configTimeDataSourceHolder.remove();
 			}
 		}
 	}
@@ -984,7 +984,7 @@ public Object doInHibernate(Session session) throws HibernateException, SQLExcep
 		}
 		finally {
 			if (dataSource != null) {
-				configTimeDataSourceHolder.set(null);
+				configTimeDataSourceHolder.remove();
 			}
 		}
 	}
@@ -1054,7 +1054,7 @@ public Object doInHibernate(Session session) throws HibernateException, SQLExcep
 		}
 		finally {
 			if (dataSource != null) {
-				configTimeDataSourceHolder.set(null);
+				configTimeDataSourceHolder.remove();
 			}
 		}
 	}
diff --git a/org.springframework.orm/src/main/java/org/springframework/orm/hibernate3/SessionFactoryUtils.java b/org.springframework.orm/src/main/java/org/springframework/orm/hibernate3/SessionFactoryUtils.java
@@ -735,7 +735,7 @@ public static void processDeferredClose(SessionFactory sessionFactory) {
 			closeSession(session);
 		}
 		if (holderMap.isEmpty()) {
-			deferredCloseHolder.set(null);
+			deferredCloseHolder.remove();
 		}
 	}
 
diff --git a/org.springframework.orm/src/main/java/org/springframework/orm/ibatis/SqlMapClientFactoryBean.java b/org.springframework.orm/src/main/java/org/springframework/orm/ibatis/SqlMapClientFactoryBean.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2009 the original author or authors.
+ * Copyright 2002-2010 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -306,7 +306,7 @@ public void afterPropertiesSet() throws Exception {
 		finally {
 			if (this.lobHandler != null) {
 				// Reset LobHandler holder.
-				configTimeLobHandlerHolder.set(null);
+				configTimeLobHandlerHolder.remove();
 			}
 		}
 	}
diff --git a/org.springframework.transaction/src/main/java/org/springframework/jca/cci/connection/ConnectionSpecConnectionFactoryAdapter.java b/org.springframework.transaction/src/main/java/org/springframework/jca/cci/connection/ConnectionSpecConnectionFactoryAdapter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2009 the original author or authors.
+ * Copyright 2002-2010 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -96,7 +96,7 @@ public void setConnectionSpecForCurrentThread(ConnectionSpec spec) {
 	 * @see #setConnectionSpecForCurrentThread
 	 */
 	public void removeConnectionSpecFromCurrentThread() {
-		this.threadBoundSpec.set(null);
+		this.threadBoundSpec.remove();
 	}
 
 
diff --git a/org.springframework.transaction/src/main/java/org/springframework/transaction/support/TransactionSynchronizationManager.java b/org.springframework.transaction/src/main/java/org/springframework/transaction/support/TransactionSynchronizationManager.java
@@ -223,7 +223,7 @@ private static Object doUnbindResource(Object actualKey) {
 		Object value = map.remove(actualKey);
 		// Remove entire ThreadLocal if empty...
 		if (map.isEmpty()) {
-			resources.set(null);
+			resources.remove();
 		}
 		if (value != null && logger.isTraceEnabled()) {
 			logger.trace("Removed value [" + value + "] for key [" + actualKey + "] from thread [" +
@@ -314,7 +314,7 @@ public static void clearSynchronization() throws IllegalStateException {
 			throw new IllegalStateException("Cannot deactivate transaction synchronization - not active");
 		}
 		logger.trace("Clearing transaction synchronization");
-		synchronizations.set(null);
+		synchronizations.remove();
 	}
 
 
diff --git a/org.springframework.web/src/main/java/org/springframework/web/context/request/RequestContextHolder.java b/org.springframework.web/src/main/java/org/springframework/web/context/request/RequestContextHolder.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2009 the original author or authors.
+ * Copyright 2002-2010 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -57,8 +57,8 @@ public abstract class RequestContextHolder  {
 	 * Reset the RequestAttributes for the current thread.
 	 */
 	public static void resetRequestAttributes() {
-		requestAttributesHolder.set(null);
-		inheritableRequestAttributesHolder.set(null);
+		requestAttributesHolder.remove();
+		inheritableRequestAttributesHolder.remove();
 	}
 
 	/**
@@ -80,11 +80,11 @@ public static void setRequestAttributes(RequestAttributes attributes) {
 	public static void setRequestAttributes(RequestAttributes attributes, boolean inheritable) {
 		if (inheritable) {
 			inheritableRequestAttributesHolder.set(attributes);
-			requestAttributesHolder.set(null);
+			requestAttributesHolder.remove();
 		}
 		else {
 			requestAttributesHolder.set(attributes);
-			inheritableRequestAttributesHolder.set(null);
+			inheritableRequestAttributesHolder.remove();
 		}
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright 2002-2008 the original author or authors.`
	`2`	`+ * Copyright 2002-2010 the original author or authors.`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -106,7 +106,7 @@ public void destroy() {`
`106`	`106`	`this.targetSet.clear();`
`107`	`107`	`}`
`108`	`108`	`// Clear ThreadLocal, just in case.`
`109`		`- this.targetInThread.set(null);`
	`109`	`+ this.targetInThread.remove();`
`110`	`110`	`}`
`111`	`111`
`112`	`112`
Original file line number	Diff line number	Diff line change
`@@ -904,13 +904,13 @@ else if (curVal instanceof String) {`
`904`	`904`	`protected void afterPrototypeCreation(String beanName) {`
`905`	`905`	`Object curVal = this.prototypesCurrentlyInCreation.get();`
`906`	`906`	`if (curVal instanceof String) {`
`907`		`- this.prototypesCurrentlyInCreation.set(null);`
	`907`	`+ this.prototypesCurrentlyInCreation.remove();`
`908`	`908`	`}`
`909`	`909`	`else if (curVal instanceof Set) {`
`910`	`910`	`Set<String> beanNameSet = (Set<String>) curVal;`
`911`	`911`	`beanNameSet.remove(beanName);`
`912`	`912`	`if (beanNameSet.isEmpty()) {`
`913`		`- this.prototypesCurrentlyInCreation.set(null);`
	`913`	`+ this.prototypesCurrentlyInCreation.remove();`
`914`	`914`	`}`
`915`	`915`	`}`
`916`	`916`	`}`
Original file line number	Diff line number	Diff line change
`@@ -344,7 +344,7 @@ public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefin`
`344`	`344`	`finally {`
`345`	`345`	`currentResources.remove(encodedResource);`
`346`	`346`	`if (currentResources.isEmpty()) {`
`347`		`- this.resourcesCurrentlyBeingLoaded.set(null);`
	`347`	`+ this.resourcesCurrentlyBeingLoaded.remove();`
`348`	`348`	`}`
`349`	`349`	`}`
`350`	`350`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright 2002-2009 the original author or authors.`
	`2`	`+ * Copyright 2002-2010 the original author or authors.`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -496,16 +496,16 @@ public void afterPropertiesSet() throws Exception {`
`496`	`496`
`497`	`497`	`finally {`
`498`	`498`	`if (this.resourceLoader != null) {`
`499`		`- configTimeResourceLoaderHolder.set(null);`
	`499`	`+ configTimeResourceLoaderHolder.remove();`
`500`	`500`	`}`
`501`	`501`	`if (this.taskExecutor != null) {`
`502`		`- configTimeTaskExecutorHolder.set(null);`
	`502`	`+ configTimeTaskExecutorHolder.remove();`
`503`	`503`	`}`
`504`	`504`	`if (this.dataSource != null) {`
`505`		`- configTimeDataSourceHolder.set(null);`
	`505`	`+ configTimeDataSourceHolder.remove();`
`506`	`506`	`}`
`507`	`507`	`if (this.nonTransactionalDataSource != null) {`
`508`		`- configTimeNonTransactionalDataSourceHolder.set(null);`
	`508`	`+ configTimeNonTransactionalDataSourceHolder.remove();`
`509`	`509`	`}`
`510`	`510`	`}`
`511`	`511`
Original file line number	Diff line number	Diff line change
`@@ -776,19 +776,19 @@ else if (strategyAndRegion.length > 0) {`
`776`	`776`
`777`	`777`	`finally {`
`778`	`778`	`if (dataSource != null) {`
`779`		`- configTimeDataSourceHolder.set(null);`
	`779`	`+ configTimeDataSourceHolder.remove();`
`780`	`780`	`}`
`781`	`781`	`if (this.jtaTransactionManager != null) {`
`782`		`- configTimeTransactionManagerHolder.set(null);`
	`782`	`+ configTimeTransactionManagerHolder.remove();`
`783`	`783`	`}`
`784`	`784`	`if (this.cacheRegionFactory != null) {`
`785`		`- configTimeCacheProviderHolder.set(null);`
	`785`	`+ configTimeCacheProviderHolder.remove();`
`786`	`786`	`}`
`787`	`787`	`if (this.cacheProvider != null) {`
`788`		`- configTimeCacheProviderHolder.set(null);`
	`788`	`+ configTimeCacheProviderHolder.remove();`
`789`	`789`	`}`
`790`	`790`	`if (this.lobHandler != null) {`
`791`		`- configTimeLobHandlerHolder.set(null);`
	`791`	`+ configTimeLobHandlerHolder.remove();`
`792`	`792`	`}`
`793`	`793`	`if (overrideClassLoader) {`
`794`	`794`	`// Reset original thread context ClassLoader.`
`@@ -896,7 +896,7 @@ public void destroy() throws HibernateException {`
`896`	`896`	`finally {`
`897`	`897`	`if (dataSource != null) {`
`898`	`898`	`// Reset DataSource holder.`
`899`		`- configTimeDataSourceHolder.set(null);`
	`899`	`+ configTimeDataSourceHolder.remove();`
`900`	`900`	`}`
`901`	`901`	`}`
`902`	`902`	`}`
`@@ -942,7 +942,7 @@ public Object doInHibernate(Session session) throws HibernateException, SQLExcep`
`942`	`942`	`}`
`943`	`943`	`finally {`
`944`	`944`	`if (dataSource != null) {`
`945`		`- configTimeDataSourceHolder.set(null);`
	`945`	`+ configTimeDataSourceHolder.remove();`
`946`	`946`	`}`
`947`	`947`	`}`
`948`	`948`	`}`
`@@ -984,7 +984,7 @@ public Object doInHibernate(Session session) throws HibernateException, SQLExcep`
`984`	`984`	`}`
`985`	`985`	`finally {`
`986`	`986`	`if (dataSource != null) {`
`987`		`- configTimeDataSourceHolder.set(null);`
	`987`	`+ configTimeDataSourceHolder.remove();`
`988`	`988`	`}`
`989`	`989`	`}`
`990`	`990`	`}`
`@@ -1054,7 +1054,7 @@ public Object doInHibernate(Session session) throws HibernateException, SQLExcep`
`1054`	`1054`	`}`
`1055`	`1055`	`finally {`
`1056`	`1056`	`if (dataSource != null) {`
`1057`		`- configTimeDataSourceHolder.set(null);`
	`1057`	`+ configTimeDataSourceHolder.remove();`
`1058`	`1058`	`}`
`1059`	`1059`	`}`
`1060`	`1060`	`}`
Original file line number	Diff line number	Diff line change
`@@ -735,7 +735,7 @@ public static void processDeferredClose(SessionFactory sessionFactory) {`
`735`	`735`	`closeSession(session);`
`736`	`736`	`}`
`737`	`737`	`if (holderMap.isEmpty()) {`
`738`		`- deferredCloseHolder.set(null);`
	`738`	`+ deferredCloseHolder.remove();`
`739`	`739`	`}`
`740`	`740`	`}`
`741`	`741`