Merge pull request #30 from miguel-porto/master

Function to execute AQL query and get the raw JSON response from Arango server

Author: Achim Brandt

.classpath

@@ -12,7 +12,11 @@
 			<attribute name="maven.pomderived" value="true"/>
 		</attributes>
 	</classpathentry>
-	<classpathentry including="**/*.java" kind="src" path="src/test/resources"/>
+	<classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources">
+		<attributes>
+			<attribute name="maven.pomderived" value="true"/>
+		</attributes>
+	</classpathentry>
 	<classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER">
 		<attributes>
 			<attribute name="maven.pomderived" value="true"/>

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

@@ -2469,6 +2469,27 @@ public <T> CursorResult<T> executeAqlQuery(
 		return cursorDriver.executeAqlQuery(getDefaultDatabase(), query, bindVars, aqlQueryOptions, clazz);
 	}
 
+	/**
+	 * Executes an AQL query and returns the raw JSON response
+	 * @param query an AQL query as string
+	 * @param bindVars a map containing all bind variables,
+	 * @param aqlQueryOptions AQL query options
+	 * @return A JSON string with the results from server
+	 * @throws ArangoException
+	 */
+	public String executeAqlQueryJSON(
+			String query,
+			Map<String, Object> bindVars,
+			AqlQueryOptions aqlQueryOptions
+			) throws ArangoException {
+
+			if (aqlQueryOptions == null) {
+				aqlQueryOptions = getDefaultAqlQueryOptions();
+			}
+
+			return cursorDriver.executeAqlQueryJSON(getDefaultDatabase(), query, bindVars, aqlQueryOptions);
+		}
+
 	/**
 	 * This method executes an AQL query and returns a DocumentCursorResult
 	 *

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

@@ -170,39 +170,14 @@ protected ReplicationDumpHeader toReplicationDumpHeader(HttpResponseEntity res)
 	}
 
 	/**
-	 * Creates an entity object
-	 * 
-	 * @param res
-	 *            the response of the database
-	 * @param clazz
-	 *            the class of the entity object
-	 * @param pclazz
-	 *            the class of the object wrapped in the entity object
-	 * @param validate
-	 *            true for validation
-	 * @return the result entity object of class T (T extends BaseEntity)
-	 * @throws ArangoException
+	 * Checks the Http response for database or server errors
+	 * @param res the response of the database
+	 * @return The Http status code
+	 * @throws ArangoException if any error happened
 	 */
-	protected <T extends BaseEntity> T createEntity(
-		HttpResponseEntity res,
-		Class<T> clazz,
-		Class<?>[] pclazz,
-		boolean validate) throws ArangoException {
-		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;
-		}
+	private int checkServerErrors(HttpResponseEntity res) throws ArangoException {
 		int statusCode = res.getStatusCode();
-		if (statusCode >= 400) {
-			requestSuccessful = false;
+		if (statusCode >= 400) {	// always throws ArangoException
 			DefaultEntity defaultEntity = new DefaultEntity();
 			if (res.getText() != null && !res.getText().equalsIgnoreCase("") && statusCode != 500) {
 				JsonParser jsonParser = new JsonParser();
@@ -263,7 +238,44 @@ protected <T extends BaseEntity> T createEntity(
 			arangoException.setCode(statusCode);
 			throw arangoException;
 		}
-
+		
+		return statusCode;
+	}
+	/**
+	 * Creates an entity object
+	 * 
+	 * @param res
+	 *            the response of the database
+	 * @param clazz
+	 *            the class of the entity object
+	 * @param pclazz
+	 *            the class of the object wrapped in the entity object
+	 * @param validate
+	 *            true for validation
+	 * @return the result entity object of class T (T extends BaseEntity)
+	 * @throws ArangoException
+	 */
+	protected <T extends BaseEntity> T createEntity(
+		HttpResponseEntity res,
+		Class<T> clazz,
+		Class<?>[] pclazz,
+		boolean validate) throws ArangoException {
+		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=checkServerErrors(res);
+		
 		try {
 			EntityDeserializers.setParameterized(pclazz);
 
@@ -283,7 +295,7 @@ protected <T extends BaseEntity> T createEntity(
 				validate(res, entity);
 			}
 
-			if (isDocumentEntity && requestSuccessful) {
+			if (isDocumentEntity) {		//  && requestSuccessful	NOTE: no need for this, an exception is always thrown
 				entity.setCode(statusCode);
 				entity.setErrorMessage(null);
 				entity.setError(false);
@@ -295,6 +307,27 @@ protected <T extends BaseEntity> T createEntity(
 			EntityDeserializers.removeParameterized();
 		}
 	}
+	
+	/**
+	 * Gets the raw JSON string with results, from the Http response
+	 * @param res the response of the database
+	 * @return A valid JSON string with the results
+	 * @throws ArangoException
+	 */
+	protected String getJSONResponseText(HttpResponseEntity res) throws ArangoException {
+		if (res == null) {
+			return null;
+		}
+
+		checkServerErrors(res);
+
+		// no errors, return results as a JSON string
+		JsonParser jsonParser = new JsonParser();
+		JsonElement jsonElement = jsonParser.parse(res.getText());
+		JsonObject jsonObject = jsonElement.getAsJsonObject();
+		JsonElement result = jsonObject.get("result");
+		return result.toString();
+	}
 
 	protected <T> T createEntity(String str, Class<T> clazz, Class<?>... pclazz) throws ArangoException {
 		try {

src/main/java/com/arangodb/InternalCursorDriver.java

@@ -40,6 +40,13 @@ <T> CursorResult<T> executeAqlQuery(
 		AqlQueryOptions aqlQueryOptions,
 		Class<T> clazz) throws ArangoException;
 
+	// return the raw JSON response from server
+	String executeAqlQueryJSON(
+			String database,
+			String query,
+			Map<String, Object> bindVars,
+			AqlQueryOptions aqlQueryOptions) throws ArangoException;
+
 	// request a cursor with DocumentEntity
 	<T, S extends DocumentEntity<T>> DocumentCursorResult<T, S> executeBaseCursorQuery(
 		String database,

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

@@ -54,6 +54,16 @@ public CursorEntity<?> validateQuery(String database, String query) throws Arang
 		return createEntity(res, CursorEntity.class);
 	}
 
+	@Override
+	public String executeAqlQueryJSON(
+			String database,
+			String query,
+			Map<String, Object> bindVars,
+			AqlQueryOptions aqlQueryOptions) throws ArangoException {
+
+			return getJSONResponseText(getCursor(database, query, bindVars, aqlQueryOptions));
+		}
+
 	@SuppressWarnings("unchecked")
 	@Override
 	public <T> CursorEntity<T> executeCursorEntityQuery(