Merge remote-tracking branch 'origin/3.0'

Conflicts:
	README.md

Author: Mark

ChangeLog

@@ -1,3 +1,19 @@
+v3.0.4 (2016-XX-XX)
+---------------------------
+* fixed edges deserializer (issue #50)
+
+v3.0.3 (2016-09-12)
+---------------------------
+* added error handling in getBatchResponseByRequestId()
+* added function createPersistentIndex() (issue #48)
+* added deserializer for BaseDocument (issue #50) 
+
+v3.0.2 (2016-08-05)
+---------------------------
+* added profile flag to AqlQueryOptions (issue #47)
+* added getExtra() to DocumentCursor<> (issue #47)
+* added IndexType.PERSISTENT (issue #48)
+
 v3.0.1 (2016-07-08)
 ---------------------------
 * added flag complete and details in ImportOptions

README.md

@@ -1,5 +1,5 @@
 
-![ArangoDB-Logo](https://www.arangodb.com/wp-content/uploads/2012/10/logo_arangodb_transp.png)
+![ArangoDB-Logo](https://docs.arangodb.com/assets/arangodb_logo_2016_inverted.png)
 
 # arangodb-java-driver
 
@@ -33,7 +33,7 @@ ArangoDB 3.0.X
   <dependency>
     <groupId>com.arangodb</groupId>
     <artifactId>arangodb-java-driver</artifactId>
-    <version>3.0.0</version>
+    <version>3.0.3</version>
   </dependency>
 	....
 </dependencies>
@@ -387,10 +387,10 @@ Now an edge can be created to set a relation between vertices
 
 # Learn more
 * [ArangoDB](https://www.arangodb.com/)
-* [ChangeLog](https://github.com/arangodb/arangodb-java-driver/tree/master/ChangeLog)
-* [Examples](https://github.com/arangodb/arangodb-java-driver/tree/master/src/test/java/com/arangodb/example)
-* [Document examples](https://github.com/arangodb/arangodb-java-driver/tree/master/src/test/java/com/arangodb/example/document)
-* [Graph examples](https://github.com/arangodb/arangodb-java-driver/tree/master/src/test/java/com/arangodb/example/graph)
-* [HTTPS examples](https://github.com/arangodb/arangodb-java-driver/tree/master/src/test/java/com/arangodb/example/ssl)
+* [ChangeLog](ChangeLog)
+* [Examples](src/test/java/com/arangodb/example)
+* [Document examples](src/test/java/com/arangodb/example/document)
+* [Graph examples](src/test/java/com/arangodb/example/graph)
+* [HTTPS examples](src/test/java/com/arangodb/example/ssl)
 * [Tutorial](https://www.arangodb.com/tutorial-java/)
 

pom.xml

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

src/main/java/com/arangodb/ArangoDriver.java

@@ -73,6 +73,7 @@
 import com.arangodb.http.BatchHttpManager;
 import com.arangodb.http.BatchPart;
 import com.arangodb.http.HttpManager;
+import com.arangodb.http.HttpResponseEntity;
 import com.arangodb.http.InvocationHandlerImpl;
 import com.arangodb.impl.ImplFactory;
 import com.arangodb.impl.InternalBatchDriverImpl;
@@ -408,8 +409,21 @@ public <T> T getBatchResponseByRequestId(final String requestId) throws ArangoEx
 			this.httpManager.setPreDefinedResponse(null);
 			return result;
 		} catch (final InvocationTargetException e) {
-			final T result = (T) createEntity(batchResponseEntity.getHttpResponseEntity(), DefaultEntity.class);
 			this.httpManager.setPreDefinedResponse(null);
+
+			HttpResponseEntity httpResponse = batchResponseEntity.getHttpResponseEntity();
+			if (httpResponse.getStatusCode() >= 300) {
+				DefaultEntity de = new DefaultEntity();
+				de.setCode(httpResponse.getStatusCode());
+				de.setError(true);
+				if (httpResponse.getText() != null) {
+					de.setErrorMessage(httpResponse.getText().trim());
+				}
+				de.setErrorNumber(httpResponse.getStatusCode());
+				throw new ArangoException(de);
+			}
+
+			final T result = (T) createEntity(batchResponseEntity.getHttpResponseEntity(), DefaultEntity.class);
 			return result;
 		} catch (final Exception e) {
 			this.httpManager.setPreDefinedResponse(null);
@@ -2385,6 +2399,32 @@ public IndexEntity createSkipListIndex(
 			fields);
 	}
 
+	/**
+	 * It is possible to define a persistent index on one or more attributes (or
+	 * paths) of documents. The index is then used in queries to locate
+	 * documents within a given range. If the index is declared unique, then no
+	 * two documents are allowed to have the same set of attribute values.
+	 *
+	 * @param collectionName
+	 *            The collection name.
+	 * @param unique
+	 *            if set to true the index will be a unique index
+	 * @param sparse
+	 *            if set to true the index will be sparse
+	 * @param fields
+	 *            the fields (document attributes) the index is created on
+	 * @return IndexEntity
+	 * @throws ArangoException
+	 */
+	public IndexEntity createPersistentIndex(
+		final String collectionName,
+		final boolean unique,
+		final boolean sparse,
+		final String... fields) throws ArangoException {
+		return indexDriver.createIndex(getDefaultDatabase(), collectionName, IndexType.PERSISTENT, unique, sparse,
+			fields);
+	}
+
 	/**
 	 * This method creates a full text index for a collection.
 	 *

src/main/java/com/arangodb/BaseCursorProxy.java

@@ -2,6 +2,7 @@
 
 import java.util.Iterator;
 import java.util.List;
+import java.util.Map;
 
 import com.arangodb.entity.DocumentEntity;
 
@@ -115,7 +116,7 @@ public String getRequestId() {
 	 * @return true, if the cursor can load more data from the database
 	 */
 	public boolean hasMore() {
-		return baseCursor.getEntity().hasMore();
+		return baseCursor.hasMore();
 	}
 
 	/**
@@ -124,7 +125,7 @@ public boolean hasMore() {
 	 * @return the cursor identifier
 	 */
 	public Long getCursorId() {
-		return baseCursor.getEntity().getCursorId();
+		return baseCursor.getCursorId();
 	}
 
 	/**
@@ -137,7 +138,16 @@ public Long getCursorId() {
 	 * 
 	 */
 	public boolean isCached() {
-		return baseCursor.getEntity().isCached();
+		return baseCursor.isCached();
+	}
+
+	/**
+	 * A list of extra stats returned by the query
+	 * 
+	 * @return query stats
+	 */
+	public Map<String, Object> getExtra() {
+		return baseCursor.getExtra();
 	}
 
 }

src/main/java/com/arangodb/CursorResult.java

@@ -19,6 +19,7 @@
 import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.List;
+import java.util.Map;
 import java.util.NoSuchElementException;
 
 import com.arangodb.entity.CursorEntity;
@@ -175,6 +176,37 @@ public void remove() {
 
 	}
 
+	/**
+	 * Returns true if the cursor can load more data from the database
+	 * 
+	 * @return true, if the cursor can load more data from the database
+	 */
+	public boolean hasMore() {
+		return entity.hasMore();
+	}
+
+	/**
+	 * Returns the cursor identifier
+	 * 
+	 * @return the cursor identifier
+	 */
+	public Long getCursorId() {
+		return entity.getCursorId();
+	}
+
+	/**
+	 * a boolean flag indicating whether the query result was served from the
+	 * query cache or not. If the query result is served from the query cache,
+	 * the extra return attribute will not contain any stats sub-attribute and
+	 * no profile sub-attribute. (since ArangoDB 2.7)
+	 * 
+	 * @return true, if the result is cached
+	 * 
+	 */
+	public boolean isCached() {
+		return entity.isCached();
+	}
+
 	/**
 	 * Returns true, if there are AQL warnings
 	 * 
@@ -193,4 +225,13 @@ public List<WarningEntity> getWarnings() {
 		return entity.getWarnings();
 	}
 
+	/**
+	 * A list of extra stats returned by the query
+	 * 
+	 * @return query stats
+	 */
+	public Map<String, Object> getExtra() {
+		return entity.getExtra();
+	}
+
 }

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

@@ -2090,6 +2090,28 @@ public GraphsEntity deserialize(
 		}
 	}
 
+	public static class BaseDocumentDeserializer implements JsonDeserializer<BaseDocument> {
+		@Override
+		public BaseDocument deserialize(
+			final JsonElement json,
+			final Type typeOfT,
+			final JsonDeserializationContext context) {
+
+			if (json.isJsonNull()) {
+				return null;
+			}
+
+			final JsonObject obj = json.getAsJsonObject();
+			final BaseDocument entity = deserializeDocumentParameter(obj, new BaseDocument());
+
+			if (entity instanceof BaseDocument) {
+				entity.setProperties(DeserializeSingleEntry.deserializeJsonObject(obj));
+			}
+
+			return entity;
+		}
+	}
+
 	public static class DeleteEntityDeserializer implements JsonDeserializer<DeletedEntity> {
 		@Override
 		public DeletedEntity deserialize(
@@ -2491,13 +2513,7 @@ private static List<EdgeEntity<Object>> getEdges(
 		if (edges != null) {
 			for (int i = 0, imax = edges.size(); i < imax; i++) {
 				final JsonObject edge = edges.get(i).getAsJsonObject();
-				final EdgeEntity<Object> ve = deserializeBaseParameter(edge, new EdgeEntity<Object>());
-				deserializeDocumentParameter(edge, ve);
-				if (edgeClazz != null) {
-					ve.setEntity(context.deserialize(edge, edgeClazz));
-				} else {
-					ve.setEntity(context.deserialize(edge, Object.class));
-				}
+				final EdgeEntity<Object> ve = context.deserialize(edge, EdgeEntity.class);
 				list.add(ve);
 			}
 		}

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

@@ -112,6 +112,7 @@ public static GsonBuilder getGsonBuilder() {
 					new EntityDeserializers.ReplicationLoggerStateEntityDeserializer())
 				.registerTypeAdapter(ReplicationLoggerStateEntity.Client.class,
 					new EntityDeserializers.ReplicationLoggerStateEntityClientDeserializer())
+				.registerTypeAdapter(BaseDocument.class, new EntityDeserializers.BaseDocumentDeserializer())
 				.registerTypeAdapter(GraphEntity.class, new EntityDeserializers.GraphEntityDeserializer())
 				.registerTypeAdapter(GraphsEntity.class, new EntityDeserializers.GraphsEntityDeserializer())
 				.registerTypeAdapter(DeletedEntity.class, new EntityDeserializers.DeleteEntityDeserializer())
@@ -136,13 +137,10 @@ public static GsonBuilder getGsonBuilder() {
 	 * Configures instances of Gson used by this factory.
 	 * 
 	 * @param builders
-	 *            one or two GsonBuilder instances. If only one is provided it
-	 *            will be used for initializing both <code>gson</code> and
-	 *            <code>gsonNull</code> fields (latter with
-	 *            <code>serializeNulls()</code> called prior to creating). If
-	 *            two are given - first initializes <code>gson</code> field,
-	 *            second initializes <code>gsonNull</code> (used when
-	 *            serialization of nulls is requested).
+	 *            one or two GsonBuilder instances. If only one is provided it will be used for initializing both
+	 *            <code>gson</code> and <code>gsonNull</code> fields (latter with <code>serializeNulls()</code> called
+	 *            prior to creating). If two are given - first initializes <code>gson</code> field, second initializes
+	 *            <code>gsonNull</code> (used when serialization of nulls is requested).
 	 */
 	public static void configure(GsonBuilder... builders) {
 		if (builders.length < 1) {

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

@@ -20,9 +20,8 @@
  * Index Type.
  * 
  * @author tamtam180 - kirscheless at gmail.com
- * @see <a href=
- *      "http://www.arangodb.com/manuals/current/HttpIndex.html#HttpIndexIntro">
- *      HttpIndexIntro</a>
+ * @see <a https://docs.arangodb.com/current/HTTP/Indexes/index.html">
+ *      Indexes</a>
  */
 public enum IndexType {
 	/** Primary Index */
@@ -36,5 +35,7 @@ public enum IndexType {
 	/** Skiplist Index */
 	SKIPLIST,
 	/** Fulltext Inex */
-	FULLTEXT
+	FULLTEXT,
+	/** Persistent Index */
+	PERSISTENT
 }

src/main/java/com/arangodb/http/HttpManager.java

@@ -485,7 +485,11 @@ private HttpResponseEntity buildHttpResponseEntity(
 		// // TODO etag特殊処理は削除する。
 		final Header etagHeader = response.getLastHeader("etag");
 		if (etagHeader != null) {
-			responseEntity.etag = Long.parseLong(etagHeader.getValue().replace("\"", ""));
+			try {
+				responseEntity.etag = Long.parseLong(etagHeader.getValue().replace("\"", ""));
+			} catch (NumberFormatException e) {
+				responseEntity.etag = 0;
+			}
 		}
 		// ヘッダをMapに変換する
 		responseEntity.headers = new TreeMap<String, String>();

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

@@ -389,6 +389,7 @@ public <T> VertexEntity<T> createVertex(
 		if (isInBatchMode()) {
 			result = new VertexEntity<T>();
 			result.setEntity(vertex);
+			result.setRequestId(res.getRequestId());
 		} else {
 			if (vertex != null) {
 				result = createEntity(res, VertexEntity.class, vertex.getClass());

src/main/java/com/arangodb/util/AqlQueryOptions.java

@@ -9,6 +9,7 @@ public class AqlQueryOptions implements OptionsInterface {
 	private Boolean fullCount;
 	private Boolean cache;
 	private Integer ttl;
+	private Boolean profile;
 
 	/**
 	 * boolean flag that indicates whether the number of documents in the result
@@ -67,6 +68,31 @@ public AqlQueryOptions setBatchSize(Integer batchSize) {
 		return this;
 	}
 
+	/**
+	 * if set to true, then the additional query profiling information will be
+	 * returned in the extra.stats return attribute if the query result is not
+	 * served from the query cache.
+	 * 
+	 * @return boolean flag
+	 */
+	public Boolean getProfile() {
+		return profile;
+	}
+
+	/**
+	 * if set to true, then the additional query profiling information will be
+	 * returned in the extra.stats return attribute if the query result is not
+	 * served from the query cache.
+	 * 
+	 * @param profile
+	 *            boolean flag
+	 * @return this
+	 */
+	public AqlQueryOptions setProfile(Boolean profile) {
+		this.profile = profile;
+		return this;
+	}
+
 	/**
 	 * if set to true and the query contains a LIMIT clause, then the result
 	 * will contain an extra attribute extra with a sub-attribute fullCount.
@@ -174,6 +200,10 @@ public Map<String, Object> toMap() {
 			optionsMp.put("fullCount", fullCount);
 		}
 
+		if (profile != null) {
+			optionsMp.put("profile", profile);
+		}
+
 		// TODO add maxPlans
 
 		// TODO add optimizer.rules