Merge pull request #260 from prashanthjos/master

Changes for adding collector context

Author: stevehu

README.md

@@ -110,6 +110,8 @@ For the latest version, please check the [release](https://github.com/networknt/
 
 ## [Customized MetaSchema](doc/cust-meta.md)
 
+## [Collector Context](doc/collector_context.md)
+
 
 ## Known issues
 

doc/collector_context.md

@@ -0,0 +1,41 @@
+### CollectorContext
+
+
+There could be usecases where we want collect the information while we are validating the data. A simple example could be fetching some value from a database or from a microservice based on the data (which could be a text or a JSON object) in a given JSON node and the schema keyword we are using. 
+
+The fetched data can be stored some where so that it can be used later after the validation is done. Since the current validation logic already parses the data and schema, both validation and collecting the required information can be done in one go.
+
+CollectorContext and Collector classes are designed to satisfy this usage.
+
+#### How to use CollectorContext
+
+Objects of CollectorContext live on ThreadLocal which is unique for every thread. This allows users to add objects to context at many points in the framework like Formats,Keywords,Validators etc.
+
+CollectorContext instance can be obtained by calling the getInstance static method on CollectorContext.This method gives an instance from the ThreadLocal for the current thread.
+
+Collectors are added to CollectorContext. Collectors allows to collect the objects. A Collector is added to CollectorContext with a name and corresponding Collector instance.
+
+```
+CollectorContext collectorContext = CollectorContext.getInstance();
+			collectorContext.add(SAMPLE_COLLECTOR_TYPE, new Collector<List<String>>() {
+				@Override
+				public List<String> collect() {
+					List<String> references = new ArrayList<String>();
+					references.add(getDatasourceMap().get(node.textValue()));
+					return references;
+				}
+			});
+```
+
+To validate the schema with the ability to use CollectorContext, validateAndCollect method has to be invoked on the JsonSchema class. This class returns a ValidationResult that contains the errors encountered during validation and a CollectorContext instance. Objects constructed by Collectors can be retrieved from CollectorContext by using the name they were added with.
+
+
+```
+ ValidationResult validationResult = jsonSchema.validateAndCollect(jsonNode);
+ CollectorContext context = validationResult.getCollectorContext();
+ List<String> contextValue = (List<String>)context.get(SAMPLE_COLLECTOR_TYPE);
+ 
+```
+
+Note that CollectorContext will be removed from ThreadLocal once validateAndCollect method returns. Also the data is loaded into CollectorContext only after all the validations are done.
+

src/main/java/com/networknt/schema/Collector.java

@@ -0,0 +1,13 @@
+package com.networknt.schema;
+
+/**
+ * Basic interface that allows the implementers to collect the information and
+ * return it.
+ *
+ * @param <E>
+ */
+public interface Collector<E> {
+
+	public E collect();
+
+}

src/main/java/com/networknt/schema/CollectorContext.java

@@ -0,0 +1,60 @@
+package com.networknt.schema;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Map.Entry;
+
+/**
+ * Context for holding the output returned by the {@link Collector}
+ * implementations.
+ *
+ */
+public class CollectorContext {
+
+	static final String COLLECTOR_CONTEXT_THREAD_LOCAL_KEY = "COLLECTOR_CONTEXT_THREAD_LOCAL_KEY";
+
+	// Get an instance from thread info (which uses ThreadLocal).
+	public static CollectorContext getInstance() {
+		return (CollectorContext) ThreadInfo.get(COLLECTOR_CONTEXT_THREAD_LOCAL_KEY);
+	}
+
+	/**
+	 * Map for holding the collector type and {@link Collector}
+	 */
+	private Map<String, Collector<?>> collectorMap = new HashMap<String, Collector<?>>();
+
+	/**
+	 * Map for holding the collector type and {@link Collector} class collect method
+	 * output.
+	 */
+	private Map<String, Object> collectorLoadMap = new HashMap<String, Object>();
+
+	public <E> void add(String collectorType, Collector<E> collector) {
+		collectorMap.put(collectorType, collector);
+	}
+
+	public Object get(String collectorType) {
+		if (collectorLoadMap.get(collectorType) == null && collectorMap.get(collectorType) != null) {
+			collectorLoadMap.put(collectorType, collectorMap.get(collectorType).collect());
+		}
+		return collectorLoadMap.get(collectorType);
+	}
+
+	/**
+	 * Load all the collectors associated with the context.
+	 */
+	void load() {
+		for (Entry<String, Collector<?>> collectorEntrySet : collectorMap.entrySet()) {
+			collectorLoadMap.put(collectorEntrySet.getKey(), collectorEntrySet.getValue().collect());
+		}
+	}
+
+	/**
+	 * Reset the context
+	 */
+	void reset() {
+		this.collectorMap = new HashMap<String, Collector<?>>();
+		this.collectorLoadMap = new HashMap<String, Object>();
+	}
+
+}

src/main/java/com/networknt/schema/JsonSchema.java

@@ -169,14 +169,44 @@ private Map<String, JsonValidator> read(JsonNode schemaNode) {
         return validators;
     }
 
-    public Set<ValidationMessage> validate(JsonNode jsonNode, JsonNode rootNode, String at) {
-        Set<ValidationMessage> errors = new LinkedHashSet<ValidationMessage>();
-        for (JsonValidator v : validators.values()) {
-            errors.addAll(v.validate(jsonNode, rootNode, at));
-        }
-        return errors;
+	public Set<ValidationMessage> validate(JsonNode jsonNode, JsonNode rootNode, String at) {
+		Set<ValidationMessage> errors = new LinkedHashSet<ValidationMessage>();
+		for (JsonValidator v : validators.values()) {
+			errors.addAll(v.validate(jsonNode, rootNode, at));
+		}
+		return errors;
+	}
+    
+    public ValidationResult validateAndCollect(JsonNode node) {
+        return validateAndCollect(node, node, AT_ROOT);
     }
 
+    
+	/**
+	 * 
+	 * This method both validates and collects the data in a CollectionContext.
+	 * @param jsonNode
+	 * @param rootNode
+	 * @param at
+	 * @return
+	 */
+	protected ValidationResult validateAndCollect(JsonNode jsonNode, JsonNode rootNode, String at) {
+		try {
+			// Create the collector context object.
+			CollectorContext collectorContext = new CollectorContext();
+			// Set the collector context in thread info, this is unique for every thread.
+			ThreadInfo.set(CollectorContext.COLLECTOR_CONTEXT_THREAD_LOCAL_KEY, collectorContext);
+			Set<ValidationMessage> errors = validate(jsonNode, rootNode, at);
+			// Load all the data from collectors into the context.
+			collectorContext.load();
+			// Collect errors and collector context into validation result.
+			ValidationResult validationResult = new ValidationResult(errors, collectorContext);
+			return validationResult;
+		} finally {
+			ThreadInfo.remove(CollectorContext.COLLECTOR_CONTEXT_THREAD_LOCAL_KEY);
+		}
+	}
+
     @Override
     public String toString() {
         return "\"" + getSchemaPath() + "\" : " + getSchemaNode().toString();
@@ -189,4 +219,5 @@ public boolean hasRequiredValidator() {
 	public JsonValidator getRequiredValidator() {
 		return requiredValidator;
 	}
+
 }

src/main/java/com/networknt/schema/ThreadInfo.java

@@ -0,0 +1,28 @@
+package com.networknt.schema;
+
+import java.util.HashMap;
+import java.util.Map;
+
+public class ThreadInfo {
+
+	private static ThreadLocal<Map<String, Object>> threadLocal = new ThreadLocal<Map<String, Object>>() {
+		protected java.util.Map<String, Object> initialValue() {
+			return new HashMap<String, Object>();
+		};
+	};
+
+	public static Object get(String key) {
+		return threadLocal.get().get(key);
+	}
+
+	public static void set(String key, Object value) {
+		Map<String, Object> threadLocalMap = threadLocal.get();
+		threadLocalMap.put(key, value);
+	}
+
+	public static void remove(String key) {
+		Map<String, Object> threadLocalMap = threadLocal.get();
+		threadLocalMap.remove(key);
+	}
+
+}

src/main/java/com/networknt/schema/ValidationResult.java

@@ -0,0 +1,25 @@
+package com.networknt.schema;
+
+import java.util.Set;
+
+public class ValidationResult {
+
+	private Set<ValidationMessage> validationMessages;
+
+	private CollectorContext collectorContext;
+
+	public ValidationResult(Set<ValidationMessage> validationMessages, CollectorContext collectorContext) {
+		super();
+		this.validationMessages = validationMessages;
+		this.collectorContext = collectorContext;
+	}
+
+	public Set<ValidationMessage> getValidationMessages() {
+		return validationMessages;
+	}
+
+	public CollectorContext getCollectorContext() {
+		return collectorContext;
+	}
+
+}