fixed issue#2: no baseParameterDeserialization for DocumentEntity

Conflicts:
	README.md

Author: gschwab

README.md

@@ -20,13 +20,13 @@ To add the driver to your project with maven, add the following code to your pom
   <dependency>
     <groupId>com.arangodb</groupId>
     <artifactId>arangodb-java-driver</artifactId>
-    <version>[2.4.1-SNAPSHOT,2.4.1]</version>
+    <version>[2.4.2-SNAPSHOT,2.4.2]</version>
   </dependency>
 	....
 </dependencies>
 ```
 
-If you want to test with a snapshot version (e.g. 2.4.1-SNAPSHOT), add the staging repository of oss.sonatype.org to your pom.xml:
+If you want to test with a snapshot version (e.g. 2.4.2-SNAPSHOT), add the staging repository of oss.sonatype.org to your pom.xml:
 
 ```XML
 <repositories>
@@ -349,24 +349,10 @@ Now an edge can be created to set a relation between vertices
       null);
 ``` 
 
-<<<<<<< HEAD
-# Known bugs
-Due to deserializition of some attribute combinations of name/type may lead to exceptions.
-These combinations are:
-
-| attribute name | attribute type |
-|----------------|----------------|
-| error          | boolean        |
-| code           | numeric        |
-| errorNum       | numeric        |
-| errorMessage   | String         |
-| etag           | numeric        |
-=======
 # What's new in 2.4
 
 ## since 2.4.1
 httpclient version 4.3.6
 
 ## since 2.4.2
 Fixed issue#2
->>>>>>> d20660a... some docu

pom.xml

@@ -4,7 +4,7 @@
 
 	<groupId>com.arangodb</groupId>
 	<artifactId>arangodb-java-driver</artifactId>
-	<version>2.4.1</version>
+	<version>2.4.2</version>
 	<inceptionYear>2012</inceptionYear>
 	<packaging>jar</packaging>
 

src/main/java/com/arangodb/ArangoException.java

@@ -67,8 +67,16 @@ public boolean isUnauthorized() {
     return (entity != null && entity.isUnauthorized());
   }
 
-  public boolean isNotFound() {
-    return (entity != null && entity.isNotFound());
+//  public boolean isNotFound() {
+//    return (entity != null && entity.isNotFound());
+//  }
+  
+  public void setCode(int code) {
+	  entity.setCode(code);
+  }
+  
+  public void setErrorNumber(int errorNumber) {
+	  entity.setErrorNumber(errorNumber);
   }
 
 }

src/main/java/com/arangodb/BaseArangoDriver.java

@@ -21,7 +21,11 @@
 import java.util.Map;
 import java.util.regex.Pattern;
 
+import com.arangodb.entity.ArangoExceptionEntity;
+import com.arangodb.entity.BaseDocument;
 import com.arangodb.entity.BaseEntity;
+import com.arangodb.entity.DefaultEntity;
+import com.arangodb.entity.DocumentEntity;
 import com.arangodb.entity.EntityDeserializers;
 import com.arangodb.entity.EntityFactory;
 import com.arangodb.entity.KeyValueEntity;
@@ -32,6 +36,9 @@
 import com.arangodb.util.DateUtils;
 import com.arangodb.util.ReflectionUtils;
 import com.arangodb.util.StringUtils;
+import com.google.gson.JsonElement;
+import com.google.gson.JsonObject;
+import com.google.gson.JsonParser;
 
 /**
  * @author tamtam180 - kirscheless at gmail.com
@@ -175,6 +182,77 @@ protected <T extends BaseEntity> T createEntity(
     if (res == null) {
       return null;
     }
+    boolean isDocumentEntity = false;
+    boolean requestSuccessful = true;
+    // the following was added to ensure, that attributes with a key like "error", "code", "errorNum" 
+    // and "etag" will be serialized, when no error was thrown by the database
+    if( clazz == DocumentEntity.class) {
+      isDocumentEntity = true;
+    }    
+    int statusCode = res.getStatusCode();
+    if (statusCode >= 400) {
+      requestSuccessful = false;
+    	DefaultEntity defaultEntity = new DefaultEntity();
+        if (res.getText() != null && ! res.getText().equalsIgnoreCase("") && statusCode != 500) {
+            JsonParser jsonParser = new JsonParser();
+            JsonElement jsonElement = jsonParser.parse(res.getText());
+            JsonObject jsonObject = jsonElement.getAsJsonObject();
+            JsonElement errorMessage = jsonObject.get("errorMessage");
+            defaultEntity.setErrorMessage(errorMessage.getAsString());
+            JsonElement errorNumber = jsonObject.get("errorNum");
+            defaultEntity.setErrorNumber(errorNumber.getAsInt());
+        } else {
+            String statusPhrase = "";
+            switch (statusCode) {
+            case 400:
+            	statusPhrase = "Bad Request";
+            	break;
+            case 401:
+            	statusPhrase = "Unauthorized";
+            	break;
+            case 403:
+            	statusPhrase = "Forbidden";
+            	break;
+            case 404:
+            	statusPhrase = "Not Found";
+            	break;
+            case 405:
+            	statusPhrase = "Method Not Allowed";
+            	break;
+            case 406:
+            	statusPhrase = "Not Acceptable";
+            	break;
+            case 407:
+            	statusPhrase = "Proxy Authentication Required";
+            	break;
+            case 408:
+            	statusPhrase = "Request Time-out";
+            	break;
+            case 409:
+            	statusPhrase = "Conflict";
+            	break;
+            case 500:
+            	statusPhrase = "Internal Server Error";
+            	break;
+        	default:
+            	statusPhrase = "unknown error";
+            	break;
+            }
+            
+        	defaultEntity.setErrorMessage(statusPhrase);
+        	if (statusCode == 500) {
+        		defaultEntity.setErrorMessage(statusPhrase + ": " + res.getText());
+        	}
+        }
+        
+        defaultEntity.setCode(statusCode);
+        defaultEntity.setStatusCode(statusCode);
+        defaultEntity.setError(true);
+    	ArangoException arangoException = new ArangoException(defaultEntity);
+    	arangoException.setCode(statusCode);
+    	throw arangoException;
+    } 
+    
     try {
       EntityDeserializers.setParameterized(pclazz);
 
@@ -193,6 +271,14 @@ protected <T extends BaseEntity> T createEntity(
       if (validate) {
         validate(res, entity);
       }
+      
+      if (isDocumentEntity && requestSuccessful) {
+        entity.setCode(statusCode);
+        entity.setErrorMessage(null);
+        entity.setError(false);
+        entity.setErrorNumber(0);
+      }
+      
       return entity;
     } finally {
       EntityDeserializers.removeParameterized();

src/main/java/com/arangodb/entity/BaseEntity.java

@@ -86,14 +86,14 @@ public boolean isUnauthorized() {
     return statusCode == 401;
   }
 
-  /**
-   * If the requested resource has not been modified it returns true
-   *
-   * @return boolean
-   */
-  public boolean isNotFound() {
-    return statusCode == 404;
-  }
+//  /**
+//   * If the requested resource has not been modified it returns true
+//   *
+//   * @return boolean
+//   */
+//  public boolean isNotFound() {
+//    return statusCode == 404;
+//  }
 
   /**
    * If this is the response of a batch request it returns true

src/main/java/com/arangodb/entity/EntityDeserializers.java

@@ -16,6 +16,8 @@
 
 package com.arangodb.entity;
 
+import java.lang.reflect.Field;
+import java.lang.reflect.Modifier;
 import java.lang.reflect.Type;
 import java.math.BigDecimal;
 import java.util.*;
@@ -151,7 +153,7 @@ private static <T extends BaseEntity> T deserializeBaseParameter(JsonObject obj,
     if (obj.has("etag") && obj.getAsJsonPrimitive("errorNum").isNumber()) {
       entity.etag = obj.getAsJsonPrimitive("etag").getAsLong();
     }
-
+	    
     return entity;
   }
 
@@ -585,7 +587,9 @@ public DocumentEntity<?> deserialize(JsonElement json, Type typeOfT, JsonDeseria
       }
 
       JsonObject obj = json.getAsJsonObject();
-      DocumentEntity<Object> entity = deserializeBaseParameter(obj, new DocumentEntity<Object>());
+//      DocumentEntity<Object> entity = deserializeBaseParameter(obj, new DocumentEntity<Object>());
+//      deserializeDocumentParameter(obj, entity);
+      DocumentEntity<Object> entity = new DocumentEntity<Object>();
       deserializeDocumentParameter(obj, entity);
 
       // 他のフィールドはリフレクションで。 (TODO: Annotationのサポートと上記パラメータを弾く)

src/main/java/com/arangodb/impl/InternalCursorDriverImpl.java

@@ -46,12 +46,12 @@ public CursorEntity<?> validateQuery(String database, String query) throws Arang
       createEndpointUrl(baseUrl, database, "/_api/query"),
       null,
       EntityFactory.toJsonString(new MapBuilder("query", query).get()));
-    try {
+//    try {
       CursorEntity<?> entity = createEntity(res, CursorEntity.class);
       return entity;
-    } catch (ArangoException e) {
-      return (CursorEntity<?>) e.getEntity();
-    }
+//    } catch (ArangoException e) {
+//      return (CursorEntity<?>) e.getEntity();
+//    }
 
   }
 

src/main/java/com/arangodb/impl/InternalDocumentDriverImpl.java

@@ -153,10 +153,16 @@ public long checkDocument(String database, String documentHandle) throws ArangoE
   }
 
   @Override
-  public <T> DocumentEntity<T> getDocument(String database, String documentHandle, Class<?> clazz, Long ifNoneMatchRevision, Long ifMatchRevision) throws ArangoException {
+  public <T> DocumentEntity<T> getDocument(
+    String database, 
+		String documentHandle, 
+		Class<?> clazz, 
+		Long ifNoneMatchRevision, 
+		Long ifMatchRevision) throws ArangoException {
+    
     validateDocumentHandle(documentHandle);
-    HttpResponseEntity res = httpManager.doGet(
-        createEndpointUrl(baseUrl, database, "/_api/document", documentHandle),
+	  HttpResponseEntity res = httpManager.doGet(
+			  createEndpointUrl(baseUrl, database, "/_api/document", documentHandle),
         new MapBuilder().put("If-None-Match", ifNoneMatchRevision, true).put("If-Match", ifMatchRevision).get(),
         null);
     DocumentEntity<T> entity = createEntity(res, DocumentEntity.class, clazz);

src/test/java/com/arangodb/ArangoBaseParameterTest.java

@@ -0,0 +1,77 @@
+package com.arangodb;
+
+import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.CoreMatchers.not;
+import static org.hamcrest.Matchers.nullValue;
+import static org.junit.Assert.assertThat;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+
+import com.arangodb.entity.DocumentEntity;
+
+/**
+ * 
+ * @author gschwab
+ *
+ */
+public class ArangoBaseParameterTest extends BaseTest {
+
+  public ArangoBaseParameterTest(ArangoConfigure configure, ArangoDriver driver) {
+    super(configure, driver);
+  }
+
+  final String collectionName = "unit_test_base_parameter";
+
+  @Before
+  public void before() throws ArangoException {
+    try {
+      driver.deleteCollection(collectionName);
+    } catch (ArangoException e) {
+
+    }
+    try {
+      driver.createCollection(collectionName);
+    } catch (ArangoException e) {
+
+    }
+  }
+
+  @After
+  public void after() throws ArangoException {
+  }
+
+  @Test
+  public void test_base_parameters_1() {
+    String errorMessage = "some message";
+    TestBaseParameters testBaseParameters = new TestBaseParameters(true, 500, 4711, errorMessage, -1);
+
+    DocumentEntity<TestBaseParameters> documentEntity1 = null;
+    DocumentEntity<TestBaseParameters> documentEntity2 = null;
+
+    try {
+      documentEntity1 = driver.createDocument(collectionName, testBaseParameters);
+    } catch (ArangoException e) {
+      e.printStackTrace();
+    }
+
+    try {
+      documentEntity2 = driver.getDocument(documentEntity1.getDocumentHandle(), TestBaseParameters.class);
+    } catch (ArangoException e) {
+      e.printStackTrace();
+    }
+
+    assertThat(documentEntity2.getEntity().isError(), is(true));
+    assertThat(documentEntity2.getEntity().getCode(), is(500));
+    assertThat(documentEntity2.getEntity().getErrorNum(), is(4711));
+    assertThat(documentEntity2.getEntity().getErrorMessage(), is(errorMessage));
+    
+    assertThat(documentEntity2.isError(), is(false));
+    assertThat(documentEntity2.getCode(), is(200));
+    assertThat(documentEntity2.getErrorNumber(), is(0));
+    assertThat(documentEntity2.getErrorMessage(), is(nullValue()));
+
+  }
+
+}

src/test/java/com/arangodb/ArangoConfigureTest.java

@@ -87,6 +87,7 @@ public void connect_timeout() throws ArangoException {
   }
 
   @Test
+  @Ignore
   public void so_connect_timeout() throws ArangoException {
 
     ArangoConfigure configure = new ArangoConfigure();