Merge pull request #17 from PDAL/feature/exceptions-handling

Make Exceptions Handling better

Author: pomadchin

build.sbt

@@ -1,7 +1,7 @@
 name := "pdal-jni"
 
 lazy val commonSettings = Seq(
-  version := "1.8.3" + Environment.versionSuffix,
+  version := "1.8.4" + Environment.versionSuffix,
   scalaVersion := "2.11.12",
   crossScalaVersions := Seq("2.12.8", "2.11.12"),
   organization := "io.pdal",

core/src/main/scala/io/pdal/Pipeline.scala

@@ -38,7 +38,7 @@ import ch.jodersky.jni.nativeLoader
 class Pipeline(val json: String) extends Native {
   Pipeline // reference the object so that the nativeLoader will load the JNI native libraries
 
-  @native def initialise(): Unit
+  @native def initialize(): Unit
   @native def execute(): Unit
   @native def getPointViews(): PointViewIterator
   @native def dispose(): Unit
@@ -52,5 +52,5 @@ class Pipeline(val json: String) extends Native {
 
 @nativeLoader("pdaljni.1.4")
 object Pipeline {
-  def apply(json: String): Pipeline = { val p = new Pipeline(json); p.initialise(); p }
+  def apply(json: String): Pipeline = { val p = new Pipeline(json); p.initialize(); p }
 }

core/src/main/scala/io/pdal/PipelineException.scala

@@ -0,0 +1,39 @@
+/******************************************************************************
+  * Copyright (c) 2016, hobu Inc.  ([email protected])
+  *
+  * All rights reserved.
+  *
+  * Redistribution and use in source and binary forms, with or without
+  * modification, are permitted provided that the following
+  * conditions are met:
+  *
+  *     * Redistributions of source code must retain the above copyright
+  *       notice, this list of conditions and the following disclaimer.
+  *     * Redistributions in binary form must reproduce the above copyright
+  *       notice, this list of conditions and the following disclaimer in
+  *       the documentation and/or other materials provided
+  *       with the distribution.
+  *     * Neither the name of Hobu, Inc. nor the names of its
+  *       contributors may be used to endorse or promote products derived
+  *       from this software without specific prior written permission.
+  *
+  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
+  * OF SUCH DAMAGE.
+  ****************************************************************************/
+
+package io.pdal
+
+abstract class PipelineException(msg: String) extends Exception(msg)
+
+case class InitializationException(msg: String) extends PipelineException(msg)
+case class ExecutionException(msg: String) extends PipelineException(msg)

core/src/test/scala/io/pdal/PipelineSpec.scala

@@ -173,5 +173,19 @@ class PipelineSpec extends TestEnvironmentSpec {
       pv.dispose()
       pvi.dispose()
     }
+
+    it("should fail with InitializationException") {
+      intercept[InitializationException] { Pipeline(null) }
+    }
+
+    it("should fail with ExecutionException") {
+      val pipeline = Pipeline("{")
+      intercept[ExecutionException] { pipeline.execute() }
+      intercept[ExecutionException] { pipeline.getPointViews() }
+      intercept[ExecutionException] { pipeline.getMetadata() }
+      intercept[ExecutionException] { pipeline.getSchema() }
+
+      pipeline.dispose()
+    }
   }
 }

native/src/include/io_pdal_Pipeline.h

@@ -49,13 +49,42 @@ using pdal::PointViewLess;
 using pdal::PointViewPtr;
 using pdal::pdal_error;
 
-JNIEXPORT void JNICALL Java_io_pdal_Pipeline_initialise
+jstring throwInitializationException(JNIEnv *env, const char *message)
+{
+    jclass Exception = env->FindClass("io/pdal/InitializationException");
+    env->ThrowNew(Exception, message);
+    return env->NewStringUTF(message);
+}
+
+jstring throwExecutionException(JNIEnv *env, const char *message)
+{
+    jclass Exception = env->FindClass("io/pdal/ExecutionException");
+    env->ThrowNew(Exception, message);
+    return env->NewStringUTF(message);
+}
+
+JNIEXPORT void JNICALL Java_io_pdal_Pipeline_initialize
   (JNIEnv *env, jobject obj)
 {
     jclass c = env->GetObjectClass(obj);
     jfieldID fid = env->GetFieldID(c, "json", "Ljava/lang/String;");
     jstring jstr = reinterpret_cast<jstring>(env->GetObjectField(obj, fid));
-    setHandle(env, obj, new Pipeline(std::string(env->GetStringUTFChars(jstr, 0))));
+
+    if(jstr == NULL)
+    {
+        throwInitializationException(env, "Null string passed into the Pipeline constructor.");
+    }
+    else
+    {
+        try
+        {
+            setHandle(env, obj, new Pipeline(std::string(env->GetStringUTFChars(jstr, 0))));
+        }
+        catch (const pdal_error &pe)
+        {
+            throwInitializationException(env, pe.what());
+        }
+    }
 }
 
 JNIEXPORT void JNICALL Java_io_pdal_Pipeline_dispose
@@ -70,21 +99,42 @@ JNIEXPORT void JNICALL Java_io_pdal_Pipeline_execute
   (JNIEnv *env, jobject obj)
 {
     Pipeline *p = getHandle<Pipeline>(env, obj);
-    p->execute();
+    try
+    {
+        p->execute();
+    }
+    catch(const pdal_error &pe)
+    {
+        throwExecutionException(env, pe.what());
+    }
 }
 
 JNIEXPORT jstring JNICALL Java_io_pdal_Pipeline_getMetadata
   (JNIEnv *env, jobject obj)
 {
-    Pipeline *p = getHandle<Pipeline>(env, obj);
-    return env->NewStringUTF(p->getMetadata().c_str());
+    try
+    {
+        Pipeline *p = getHandle<Pipeline>(env, obj);
+        return env->NewStringUTF(p->getMetadata().c_str());
+    }
+    catch(const pdal_error &pe)
+    {
+        return throwExecutionException(env, pe.what());
+    }
 }
 
 JNIEXPORT jstring JNICALL Java_io_pdal_Pipeline_getSchema
   (JNIEnv *env, jobject obj)
 {
-    Pipeline *p = getHandle<Pipeline>(env, obj);
-    return env->NewStringUTF(p->getSchema().c_str());
+    try
+    {
+        Pipeline *p = getHandle<Pipeline>(env, obj);
+        return env->NewStringUTF(p->getSchema().c_str());
+    }
+    catch(const pdal_error &pe)
+    {
+        return throwExecutionException(env, pe.what());
+    }
 }
 
 JNIEXPORT jboolean JNICALL Java_io_pdal_Pipeline_validate
@@ -129,16 +179,23 @@ JNIEXPORT jstring JNICALL Java_io_pdal_Pipeline_getLog
 JNIEXPORT jobject JNICALL Java_io_pdal_Pipeline_getPointViews
   (JNIEnv *env, jobject obj)
 {
-    Pipeline *p = getHandle<Pipeline>(env, obj);
-    PointViewSet pvset = p->getPointViews();
+    try
+    {
+        Pipeline *p = getHandle<Pipeline>(env, obj);
+        PointViewSet pvset = p->getPointViews();
 
-    jclass pviClass = env->FindClass("io/pdal/PointViewIterator");
-    jmethodID pviCtor = env->GetMethodID(pviClass, "<init>", "()V");
-    jobject pvi = env->NewObject(pviClass, pviCtor);
+        jclass pviClass = env->FindClass("io/pdal/PointViewIterator");
+        jmethodID pviCtor = env->GetMethodID(pviClass, "<init>", "()V");
+        jobject pvi = env->NewObject(pviClass, pviCtor);
 
-    PointViewIterator *it = new PointViewIterator(pvset);
+        PointViewIterator *it = new PointViewIterator(pvset);
 
-    setHandle(env, pvi, it);
+        setHandle(env, pvi, it);
 
-    return pvi;
+        return pvi;
+    }
+    catch(const libpdaljava::java_error &je)
+    {
+        return throwExecutionException(env, je.what());
+    }
 }

native/src/io_pdal_Pipeline.cpp

@@ -17,11 +17,11 @@ done
 export PDAL_VERSION_SUFFIX=${PDAL_VERSION_SUFFIX-"-SNAPSHOT"}
 
 cd ./native/target
-rm -f ./pdal-native-1.8.3${PDAL_VERSION_SUFFIX}.jar
+rm -f ./pdal-native-1.8.4${PDAL_VERSION_SUFFIX}.jar
 rm -rf ./tmp; mkdir -p ./tmp
 
-cd tmp; jar -xf ../pdal-native-x86_64-darwin-1.8.3${PDAL_VERSION_SUFFIX}.jar; cd ~-
-cd tmp; jar -xf ../pdal-native-x86_64-linux-1.8.3${PDAL_VERSION_SUFFIX}.jar; cd ~-
+cd tmp; jar -xf ../pdal-native-x86_64-darwin-1.8.4${PDAL_VERSION_SUFFIX}.jar; cd ~-
+cd tmp; jar -xf ../pdal-native-x86_64-linux-1.8.4${PDAL_VERSION_SUFFIX}.jar; cd ~-
 
 jar -cvf pdal-native-1.8.0${PDAL_VERSION_SUFFIX}.jar -C tmp .