Moving to a ThreadLocal solution for the ValidationErrorList

manico.james · manico.james · commit 4a20fbfe37da · 2008-08-15T08:29:14.000Z
diff --git a/src/org/owasp/esapi/ESAPI.java b/src/org/owasp/esapi/ESAPI.java
@@ -58,8 +58,6 @@ public class ESAPI {
 	private static SecurityConfiguration securityConfiguration = null;
 
 	private static Validator validator = null;
-	
-	private static ValidatorErrorList validatorErrorList = null;
 
 	/**
 	 * prevent instantiation of this class
@@ -270,13 +268,4 @@ public static Validator validator() {
 	public static void setValidator(Validator validator) {
 		ESAPI.validator = validator;
 	}
-	
-	/**
-	 * @return the validatorErrorList
-	 */
-	public static ValidatorErrorList validatorErrorList() {
-		if (ESAPI.validatorErrorList == null)
-			ESAPI.validatorErrorList = new DefaultValidatorErrorList();
-		return ESAPI.validatorErrorList;
-	}
 }
diff --git a/src/org/owasp/esapi/Validator.java b/src/org/owasp/esapi/Validator.java
@@ -46,6 +46,13 @@
  * @since June 1, 2007
  */
 public interface Validator {
+	
+	/**
+	 * Returns the ThreadLocal instance of the ValidatorErrorList which can be called 
+	 * anywhere in the application without needing to pass the list around.
+	 * @return
+	 */
+	public ValidatorErrorList getValidatorErrorList();
 
 	/**
 	 * Returns true if input is valid according to the specified type. The type parameter must be the name 
diff --git a/src/org/owasp/esapi/ValidatorErrorList.java b/src/org/owasp/esapi/ValidatorErrorList.java
@@ -64,5 +64,10 @@ public interface ValidatorErrorList {
 	 * @param ve
 	 */
     public void addError(String context, ValidationException ve);
+    
+	/**
+	 * Removes all errors from error list.
+	 */
+    public void clearErrors();
 }
 
diff --git a/src/org/owasp/esapi/reference/DefaultValidator.java b/src/org/owasp/esapi/reference/DefaultValidator.java
@@ -71,6 +71,30 @@ public class DefaultValidator implements org.owasp.esapi.Validator {
 	private static final int MAX_CREDIT_CARD_LENGTH = 19;
 	private static final int MAX_PARAMETER_NAME_LENGTH = 100;
 	private static final int MAX_PARAMETER_VALUE_LENGTH = 65535; //max length of MySQL "text" column type
+
+	/** list of errors collection class */
+    private ThreadLocalValidatorErrorList validatorErrorList = new ThreadLocalValidatorErrorList();
+
+    private class ThreadLocalValidatorErrorList extends InheritableThreadLocal {
+        
+        public ValidatorErrorList getValidatorErrorList() {
+        	if ((ValidatorErrorList)super.get() == null) {
+        		super.set(new DefaultValidatorErrorList());
+        	}
+            return (ValidatorErrorList)super.get();
+        }
+
+        public void setValidatorErrorList(ValidatorErrorList validatorErrorList) {
+            super.set(validatorErrorList);
+        }
+    };
+	
+	/**
+	 * @return the validatorErrorList
+	 */
+	public ValidatorErrorList getValidatorErrorList() {
+		return (ValidatorErrorList)validatorErrorList.get();
+	}
 	
 	public DefaultValidator() {
 	}
diff --git a/src/org/owasp/esapi/reference/DefaultValidatorErrorList.java b/src/org/owasp/esapi/reference/DefaultValidatorErrorList.java
@@ -93,4 +93,8 @@ public boolean isEmpty() {
 		if ((errorList == null) || (errorList.size() == 0)) return true;
 		return false;
 	}
+
+	public void clearErrors() {
+		errorList.clear();
+	}
 }

Original file line number	Diff line number	Diff line change
`@@ -93,4 +93,8 @@ public boolean isEmpty() {`
`93`	`93`	`if ((errorList == null) \|\| (errorList.size() == 0)) return true;`
`94`	`94`	`return false;`
`95`	`95`	`}`
	`96`	`+`
	`97`	`+ public void clearErrors() {`
	`98`	`+ errorList.clear();`
	`99`	`+ }`
`96`	`100`	`}`