Provided status endpoint for REST operations and return data in JSON format.

richard3d · richard3d · commit abcf4beccfc7 · 2017-12-02T13:32:45.000-08:00
diff --git a/analytics/mapreduce/src/main/java/mil/nga/giat/geowave/analytic/mapreduce/operations/DBScanCommand.java b/analytics/mapreduce/src/main/java/mil/nga/giat/geowave/analytic/mapreduce/operations/DBScanCommand.java
@@ -67,6 +67,11 @@ public void execute(
 
 		computeResults(params);
 	}
+	
+	@Override
+	public boolean runAsync() {
+		return true;
+	}
 
 	public List<String> getParameters() {
 		return parameters;
diff --git a/analytics/mapreduce/src/main/java/mil/nga/giat/geowave/analytic/mapreduce/operations/KdeCommand.java b/analytics/mapreduce/src/main/java/mil/nga/giat/geowave/analytic/mapreduce/operations/KdeCommand.java
@@ -51,6 +51,11 @@ public void execute(
 		computeResults(params);
 	}
 
+	@Override
+	public boolean runAsync() {
+		return true;
+	}
+
 	public KDEJobRunner createRunner(
 			final OperationParams params ) {
 		// Ensure we have all the required arguments
diff --git a/analytics/mapreduce/src/main/java/mil/nga/giat/geowave/analytic/mapreduce/operations/NearestNeighborCommand.java b/analytics/mapreduce/src/main/java/mil/nga/giat/geowave/analytic/mapreduce/operations/NearestNeighborCommand.java
@@ -60,6 +60,11 @@ public void execute(
 
 		computeResults(params);
 	}
+	
+	@Override
+	public boolean runAsync() {
+		return true;
+	}
 
 	public List<String> getParameters() {
 		return parameters;
diff --git a/core/cli/src/main/java/mil/nga/giat/geowave/core/cli/api/ServiceEnabledCommand.java b/core/cli/src/main/java/mil/nga/giat/geowave/core/cli/api/ServiceEnabledCommand.java
@@ -23,6 +23,16 @@ abstract public T computeResults(
 			OperationParams params )
 			throws Exception;
 
+	/**
+	 * this method provides a hint to the service running the command whether it
+	 * should be run asynchronously or not
+	 * 
+	 * @return should this method be run asynchronously
+	 */
+	public boolean runAsync() {
+		return false;
+	}
+
 	/**
 	 * the method to expose as a resource
 	 *
diff --git a/core/ingest/src/main/java/mil/nga/giat/geowave/core/ingest/operations/KafkaToGeowaveCommand.java b/core/ingest/src/main/java/mil/nga/giat/geowave/core/ingest/operations/KafkaToGeowaveCommand.java
@@ -95,6 +95,11 @@ public void execute(
 
 		computeResults(params);
 	}
+	
+	@Override
+	public boolean runAsync() {
+		return true;
+	}
 
 	public IngestFromKafkaDriver getDriver() {
 		return driver;
diff --git a/core/ingest/src/main/java/mil/nga/giat/geowave/core/ingest/operations/ListPluginsCommand.java b/core/ingest/src/main/java/mil/nga/giat/geowave/core/ingest/operations/ListPluginsCommand.java
@@ -42,6 +42,11 @@ public void execute(
 					string);
 		}
 	}
+	
+	@Override
+	public boolean runAsync() {
+		return true;
+	}
 
 	@Override
 	public List<String> computeResults(
diff --git a/core/ingest/src/main/java/mil/nga/giat/geowave/core/ingest/operations/LocalToGeowaveCommand.java b/core/ingest/src/main/java/mil/nga/giat/geowave/core/ingest/operations/LocalToGeowaveCommand.java
@@ -82,6 +82,11 @@ public void execute(
 			final OperationParams params ) {
 		computeResults(params);
 	}
+	
+	@Override
+	public boolean runAsync() {
+		return true;
+	}
 
 	public List<String> getParameters() {
 		return parameters;
diff --git a/core/ingest/src/main/java/mil/nga/giat/geowave/core/ingest/operations/LocalToHdfsCommand.java b/core/ingest/src/main/java/mil/nga/giat/geowave/core/ingest/operations/LocalToHdfsCommand.java
@@ -70,6 +70,11 @@ public void execute(
 
 		computeResults(params);
 	}
+	
+	@Override
+	public boolean runAsync() {
+		return true;
+	}
 
 	public List<String> getParameters() {
 		return parameters;
diff --git a/core/ingest/src/main/java/mil/nga/giat/geowave/core/ingest/operations/LocalToKafkaCommand.java b/core/ingest/src/main/java/mil/nga/giat/geowave/core/ingest/operations/LocalToKafkaCommand.java
@@ -70,6 +70,11 @@ public void execute(
 			throws Exception {
 		computeResults(params);
 	}
+	
+	@Override
+	public boolean runAsync() {
+		return true;
+	}
 
 	public List<String> getParameters() {
 		return parameters;
diff --git a/core/ingest/src/main/java/mil/nga/giat/geowave/core/ingest/operations/LocalToMapReduceToGeowaveCommand.java b/core/ingest/src/main/java/mil/nga/giat/geowave/core/ingest/operations/LocalToMapReduceToGeowaveCommand.java
@@ -94,6 +94,11 @@ public void execute(
 
 		computeResults(params);
 	}
+	
+	@Override
+	public boolean runAsync() {
+		return true;
+	}
 
 	public List<String> getParameters() {
 		return parameters;
diff --git a/core/ingest/src/main/java/mil/nga/giat/geowave/core/ingest/operations/MapReduceToGeowaveCommand.java b/core/ingest/src/main/java/mil/nga/giat/geowave/core/ingest/operations/MapReduceToGeowaveCommand.java
@@ -95,6 +95,11 @@ public void execute(
 
 		computeResults(params);
 	}
+	
+	@Override
+	public boolean runAsync() {
+		return true;
+	}
 
 	public List<String> getParameters() {
 		return parameters;
diff --git a/services/rest/pom.xml b/services/rest/pom.xml
@@ -116,7 +116,7 @@
 				</dependency>
 				<dependency>
 					<groupId>mil.nga.giat</groupId>
-					<artifactId>geowave-analytic-javaspark</artifactId>
+					<artifactId>geowave-analytic-spark</artifactId>
 					<version>${project.version}</version>
 				</dependency>
 				<dependency>
diff --git a/services/rest/src/main/java/mil/nga/giat/geowave/service/rest/ApiRestletApplication.java b/services/rest/src/main/java/mil/nga/giat/geowave/service/rest/ApiRestletApplication.java
@@ -10,6 +10,10 @@
 
 import java.util.Iterator;
 import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import java.util.concurrent.Future;
 import java.util.logging.Level;
 
 import javax.management.MBeanServer;
@@ -30,7 +34,6 @@
 
 import mil.nga.giat.geowave.core.cli.VersionUtils;
 import mil.nga.giat.geowave.core.cli.api.ServiceEnabledCommand;
-import mil.nga.giat.geowave.service.rest.operations.FileUpload;
 
 /**
  * This class provides the main webapp entry point
@@ -40,6 +43,8 @@ public class ApiRestletApplication extends
 {
 	private final static Logger LOGGER = LoggerFactory.getLogger(ApiRestletApplication.class);
 	private ArrayList<RestRoute> availableRoutes = null;
+	private ExecutorService asyncOperationPool = Executors.newFixedThreadPool(10);
+	private ConcurrentHashMap<String, Future> asyncOperationStatuses = new ConcurrentHashMap<String, Future>();
 
 	public ApiRestletApplication() {
 		super();
@@ -66,6 +71,12 @@ public synchronized Restlet createInboundRoot() {
 		getContext().getAttributes().put(
 				"availableRoutes",
 				availableRoutes);
+		getContext().getAttributes().put(
+				"asyncOperationPool",
+				asyncOperationPool);
+		getContext().getAttributes().put(
+				"asyncOperationStatuses",
+				asyncOperationStatuses);
 
 		// actual mapping here
 		router.attachDefault(MainResource.class);
@@ -74,7 +85,10 @@ public synchronized Restlet createInboundRoot() {
 				SwaggerResource.class);
 		router.attach(
 				"/v0/fileupload",
-				FileUpload.class);
+				FileUploadResource.class);
+		router.attach(
+				"/v0/operation_status",
+				AsyncOperationStatusResource.class);
 		attachApiRoutes(router);
 		return router;
 	}
diff --git a/services/rest/src/main/java/mil/nga/giat/geowave/service/rest/AsyncOperationStatusResource.java b/services/rest/src/main/java/mil/nga/giat/geowave/service/rest/AsyncOperationStatusResource.java
@@ -0,0 +1,67 @@
+package mil.nga.giat.geowave.service.rest;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.Future;
+
+import org.restlet.ext.jackson.JacksonRepresentation;
+import org.restlet.representation.Representation;
+import org.restlet.resource.Get;
+import org.restlet.resource.ServerResource;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import mil.nga.giat.geowave.service.rest.operations.RestOperationStatusMessage;
+
+/**
+ * ServerResource that returns the status of async REST operations submitted to
+ * the server
+ */
+public class AsyncOperationStatusResource extends
+		ServerResource
+{
+	private static final Logger LOGGER = LoggerFactory.getLogger(AsyncOperationStatusResource.class);
+	
+	@Get("json")
+	public Representation getStatus(
+			final Representation request ) {
+
+		RestOperationStatusMessage status = new RestOperationStatusMessage();
+		ConcurrentHashMap<String, Future<?>> opStatuses = null;
+		String id = getQueryValue("id");
+		try {
+			// look up the operation status
+			opStatuses = (ConcurrentHashMap<String, Future<?>>) this.getApplication().getContext().getAttributes().get(
+					"asyncOperationStatuses");
+			if (opStatuses.get(id) != null) {
+				Future<?> future = opStatuses.get(id);
+
+				if (future.isDone()) {
+					status.status = RestOperationStatusMessage.StatusType.COMPLETE;
+					status.message = "operation success";
+					status.data = future.get();
+					opStatuses.remove(id);
+				}
+				else {
+					status.status = RestOperationStatusMessage.StatusType.RUNNING;
+				}
+				return new JacksonRepresentation<RestOperationStatusMessage>(
+						status);
+			}
+		}
+		catch (final Exception e) {
+			LOGGER.error("Error exception: ", e.getMessage());
+			status.status = RestOperationStatusMessage.StatusType.ERROR;
+			status.message = "exception occurred";
+			status.data = e;
+			if (opStatuses != null) opStatuses.remove(id);
+			return new JacksonRepresentation<RestOperationStatusMessage>(
+					status);
+		}
+		status.status = RestOperationStatusMessage.StatusType.ERROR;
+		status.message = "no operation found for ID: " + id;
+		return new JacksonRepresentation<RestOperationStatusMessage>(
+				status);
+	}
+}
diff --git a/services/rest/src/main/java/mil/nga/giat/geowave/service/rest/FileUploadResource.java b/services/rest/src/main/java/mil/nga/giat/geowave/service/rest/FileUploadResource.java
@@ -1,4 +1,4 @@
-package mil.nga.giat.geowave.service.rest.operations;
+package mil.nga.giat.geowave.service.rest;
 
 import java.io.File;
 import java.util.List;
@@ -17,7 +17,7 @@
 /**
  * ServerResource to handle uploading files. Uses restlet fileupload.
  */
-public class FileUpload extends
+public class FileUploadResource extends
 		ServerResource
 {
 	private static class UploadedFile
diff --git a/services/rest/src/main/java/mil/nga/giat/geowave/service/rest/GeoWaveOperationServiceWrapper.java b/services/rest/src/main/java/mil/nga/giat/geowave/service/rest/GeoWaveOperationServiceWrapper.java
diff --git a/services/rest/src/main/java/mil/nga/giat/geowave/service/rest/operations/RestOperationStatusMessage.java b/services/rest/src/main/java/mil/nga/giat/geowave/service/rest/operations/RestOperationStatusMessage.java

Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,11 @@ public void execute(`
`42`	`42`	`string);`
`43`	`43`	`}`
`44`	`44`	`}`
	`45`	`+`
	`46`	`+ @Override`
	`47`	`+ public boolean runAsync() {`
	`48`	`+ return true;`
	`49`	`+ }`
`45`	`50`
`46`	`51`	`@Override`
`47`	`52`	`public List<String> computeResults(`