cleaning code

Author: jlcanovas

jsondiscoverer.examples/src/jsondiscoverer/zoo/test/ExampleZooDiscoverer.java

@@ -12,6 +12,7 @@
 package jsondiscoverer.zoo.test;
 
 import java.io.File;
+import java.io.FileNotFoundException;
 
 import jsondiscoverer.zoo.ModelDrawer;
 import jsondiscoverer.zoo.ZooDiscoverer;
@@ -28,11 +29,11 @@ public class ExampleZooDiscoverer {
 	private static final String DOT_EXE = "C:/Program Files (x86)/Graphviz 2.28/bin/dot.exe"; // Path to DOT executable
 	private static final String WORKING_DIR = "./exampleData/workingDir";
 
-	public static void main(String[] args) {
+	public static void main(String[] args) throws FileNotFoundException {
 		ExampleZooDiscoverer.exampleDiscover();
 	}
 
-	public static void exampleDiscover() {
+	public static void exampleDiscover() throws FileNotFoundException {
 		ZooDiscoverer zooDiscoverer = new ZooDiscoverer(new File("./exampleData/zooDiscoverer"));
 		zooDiscoverer.discover(true);
 

jsondiscoverer.web/WebContent/WEB-INF/config.properties

@@ -1,10 +1,22 @@
+# The URL where the web application will be deployed. 
+# Used for CORS, i.e., only requests from this URL will be accepted
 serverURL=http://localhost:8080
+# A temp folder where all the pictures will be generated
 workingDir=C:/Users/jcanovasi/git/jsonDiscoverer/jsondiscoverer.web/WebContent/workingDir
+# Temp files generated by the injector will be located in this folder (sub-folder of workingDir folder)
 IdInjector=injector
-IdDiscoverer=discoverer
-IdMultiDiscoverer=multidiscoverer
+# Temp files generated by the simple discoverer will be located in this folder (sub-folder of workingDir folder)
+SubfolderSimpleDiscoverer=simpleDiscoverer
+# Temp files generated by the advanced discoverer will be located in this folder (sub-folder of workingDir folder)
+SubfolderAdvancedDiscoverer=advancedDiscoverer
+# Path to DOT executable (used to generate the pictures
 dotExePath=C:/Program Files (x86)/Graphviz 2.28/bin/dot.exe
+# The parameter where the JSON will be included (DO NOT CHANGE)
 JsonParameter=json
+# The parameter where the proxy will take the URL from.
+# (used in the Simple discoverer when the user gives an URL as in put)
 UrlParameter=url
+# Max. number of bytes to read by the proxy
 LimitChars=16384
+# Version of the tool deployed
 version=2.0.0

jsondiscoverer.web/WebContent/WEB-INF/config.properties.development

@@ -1,10 +1,22 @@
+# The URL where the web application will be deployed. 
+# Used for CORS, i.e., only requests from this URL will be accepted
 serverURL=http://localhost:8080
+# A temp folder where all the pictures will be generated
 workingDir=C:/Users/jcanovasi/git/jsonDiscoverer/jsondiscoverer.web/WebContent/workingDir
+# Temp files generated by the injector will be located in this folder (sub-folder of workingDir folder)
 IdInjector=injector
-IdDiscoverer=discoverer
-IdMultiDiscoverer=multidiscoverer
+# Temp files generated by the simple discoverer will be located in this folder (sub-folder of workingDir folder)
+SubfolderSimpleDiscoverer=simpleDiscoverer
+# Temp files generated by the advanced discoverer will be located in this folder (sub-folder of workingDir folder)
+SubfolderAdvancedDiscoverer=advancedDiscoverer
+# Path to DOT executable (used to generate the pictures
 dotExePath=C:/Program Files (x86)/Graphviz 2.28/bin/dot.exe
+# The parameter where the JSON will be included (DO NOT CHANGE)
 JsonParameter=json
+# The parameter where the proxy will take the URL from.
+# (used in the Simple discoverer when the user gives an URL as in put)
 UrlParameter=url
+# Max. number of bytes to read by the proxy
 LimitChars=16384
+# Version of the tool deployed
 version=2.0.0

jsondiscoverer.web/WebContent/WEB-INF/config.properties.server

@@ -1,10 +1,23 @@
+# The URL where the web application will be deployed. 
+# Used for CORS, i.e., only requests from this URL will be accepted
 serverURL=http://som-research.uoc.edu
+# A temp folder where all the pictures will be generated
 workingDir=/opt/local/webapps/jsonDiscoverer/workingDir
+# Temp files generated by the injector will be located in this folder (sub-folder of workingDir folder)
 IdInjector=injector
-IdDiscoverer=discoverer
-IdMultiDiscoverer=multidiscoverer
+# Temp files generated by the simple discoverer will be located in this folder (sub-folder of workingDir folder)
+SubfolderSimpleDiscoverer=simpleDiscoverer
+# Temp files generated by the advanced discoverer will be located in this folder (sub-folder of workingDir folder)
+SubfolderAdvancedDiscoverer=advancedDiscoverer
+# Path to DOT executable (used to generate the pictures
 dotExePath=/usr/bin/dot
+# The parameter where the JSON will be included (DO NOT CHANGE)
 JsonParameter=json
+# The parameter where the proxy will take the URL from.
+# (used in the Simple discoverer when the user gives an URL as in put)
 UrlParameter=url
+# Max. number of bytes to read by the proxy
 LimitChars=16384
+# Version of the tool deployed
 version=2.0.0
+

jsondiscoverer.web/WebContent/WEB-INF/lib/jsondiscoverer.jar

@@ -21,7 +21,7 @@ <h2 id="doc-why">Why this?</h2>
 					With the emergence of the Web 2.0, asynchronous-based web technologies are becoming mainstream mainly thanks to their ability to provide richer, faster and more interactive web experiences. For a long time, these applications have been using XML as interchange format, however, in the last years the JavaScript Object  Notation (<a href="http://json.org/>">JSON</a>) has been gaining in popularity since it provides a lightweigth data exchange format with a significant performance improvement.
 					</p>
 					<p>
-					JSON consists in sets of Object described by name/value pairs. It is <strong>schemaless</strong>, i.e., there is no a structural defition of JSON objects, instead it is implicit. Schemaless data is particularly <a href="http://martinfowler.com/articles/schemaless">interesting in cases dealing with non-uniform data or in schema migration</a>, however, it can become a burden in data integration scenarios (e.g., consuming JSONbased APIs) where it becomes necessary to discover at least partially the underlying structure in order to properly process the data.
+					JSON consists in sets of Object described by name/value pairs. It is <strong>schemaless</strong>, i.e., there is no a structural definition of JSON objects, instead it is implicit. Schemaless data is particularly <a href="http://martinfowler.com/articles/schemaless">interesting in cases dealing with non-uniform data or in schema migration</a>, however, it can become a burden in data integration scenarios (e.g., consuming JSONbased APIs) where it becomes necessary to discover at least partially the underlying structure in order to properly process the data.
 					</p>
 					<p>
 					Nowadays, a considerable number of web applications provide an external API consisting in a set of JSON-based services where all services are interrelated. Indeed, each service gives access to a subset of the application domain and developers must combine them to build any kind of non-trivial functionality on top of that API. Since JSON data is a schemaless format, deducing the right way of combining those services is not a trivial task. JSONDiscoverer aims at discovering (and visualizing) the implicit schema of the JSON data as well as the possible composition links among JSON-based Web APIs.

jsondiscoverer.web/WebContent/app/partials/documentation.html

@@ -58,13 +58,13 @@ public abstract class AbstractJsonDiscoverer extends HttpServlet {
 	public static String dotExePath = null;
 
 	// Version of the app
-	String version = "";
+	public static String version = "";
 
 	// The jsonParam used for discovery (where the json code is stored)
 	static String jsonParam = null;
 
 	// Server for the CORS
-	String serverURL = "";
+	static String serverURL = "";
 
 	Properties properties = null;
 
@@ -83,7 +83,6 @@ public void init() throws ServletException {
 			workingDirString = properties.getProperty("workingDir");
 			dotExePath = properties.getProperty("dotExePath");
 			jsonParam = properties.getProperty("JsonParameter");
-
 			serverURL = properties.getProperty("serverURL");
 			version = properties.getProperty("version");
 			if(serverURL == null) 
@@ -106,6 +105,9 @@ public void init() throws ServletException {
 	 * @throws IOException
 	 */
 	String encodeToString(File imagePath) throws IOException {
+		if(imagePath == null)
+			throw new IllegalArgumentException("imagePath cannot be null");
+		
 		BufferedImage image = ImageIO.read(imagePath);
 
 		String imageString = null;
@@ -134,6 +136,11 @@ String encodeToString(File imagePath) throws IOException {
 	 * @throws ServletException
 	 */
 	String encodeToString(EPackage ePackage,  String uniqueId) throws ServletException {
+		if(ePackage == null)
+			throw new IllegalArgumentException("ePackage cannot be null");
+		if(uniqueId == null)
+			throw new IllegalArgumentException("uniqueId cannot be null");
+		
 		File uniqueWorkingDir = new File(workingDir.getAbsolutePath() + File.separator + uniqueId);
 		if(!uniqueWorkingDir.isDirectory()) throw new ServletException("The working dir could not be set:" + uniqueWorkingDir.getAbsolutePath());
 
@@ -179,6 +186,11 @@ String encodeToString(EPackage ePackage,  String uniqueId) throws ServletExcepti
 	 * @throws ServletException
 	 */
 	String encodeToString(List<EObject> elements,  String uniqueId) throws ServletException {
+		if(elements == null)
+			throw new IllegalArgumentException("elements cannot be null");
+		if(uniqueId == null)
+			throw new IllegalArgumentException("uniqueId cannot be null");
+		
 		File uniqueWorkingDir = new File(workingDir.getAbsolutePath() + File.separator + uniqueId);
 		if(!uniqueWorkingDir.isDirectory()) throw new ServletException("The working dir could not be set:" + uniqueWorkingDir.getAbsolutePath());
 
@@ -225,6 +237,11 @@ String encodeToString(List<EObject> elements,  String uniqueId) throws ServletEx
 	 * @throws ServletException
 	 */
 	File drawModel(List<EObject> elements, String uniqueId) throws ServletException {
+		if(elements == null)
+			throw new IllegalArgumentException("elements cannot be null");
+		if(uniqueId == null)
+			throw new IllegalArgumentException("uniqueId cannot be null");
+		
 		EcorePackage.eINSTANCE.eClass();
 		GraphdescPackage.eINSTANCE.eClass();
 
@@ -253,14 +270,20 @@ File drawModel(List<EObject> elements, String uniqueId) throws ServletException
 	 * @param response
 	 */
 	protected void addResponseOptions(HttpServletResponse response) {
+		if(response == null)
+			throw new IllegalArgumentException("response cannot be null");
+		
 		response.setHeader("Access-Control-Allow-Origin", serverURL);
 		response.setHeader("Access-Control-Allow-Methods", "GET,POST,PUT,DELETE,OPTIONS");
 		response.setHeader("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept");
 		response.addHeader("Access-Control-Allow-Credentials", "true");
 	}
 
 	@Override
-	protected void doOptions(HttpServletRequest arg0, HttpServletResponse response)	throws ServletException, IOException {
+	protected void doOptions(HttpServletRequest request, HttpServletResponse response)	throws ServletException, IOException {
+		if(response == null)
+			throw new IllegalArgumentException("response cannot be null");
+		
 		addResponseOptions(response);
 	}
 }