Index: exposed Raw methods

Author: PLNech

algoliasearch/src/main/java/com/algolia/search/saas/BaseAPIClient.java

@@ -31,6 +31,7 @@
 import org.json.JSONObject;
 import org.json.JSONTokener;
 
+import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
@@ -292,7 +293,7 @@ protected JSONObject multipleQueries(List<IndexQuery> queries, String strategy)
      * Custom batch
      *
      * @param actions the array of actions
-     * @throws AlgoliaException
+     * @throws AlgoliaException if the response is not valid json
      */
     protected JSONObject batch(JSONArray actions) throws AlgoliaException {
         try {
@@ -308,6 +309,10 @@ private enum Method {
         GET, POST, PUT, DELETE
     }
 
+    protected byte[] getRequestRaw(String url, boolean search) throws AlgoliaException {
+        return _requestRaw(Method.GET, url, null, readHostsArray, httpConnectTimeoutMS, search ? httpSearchTimeoutMS : httpSocketTimeoutMS);
+    }
+
     protected JSONObject getRequest(String url, boolean search) throws AlgoliaException {
         return _request(Method.GET, url, null, readHostsArray, httpConnectTimeoutMS, search ? httpSearchTimeoutMS : httpSocketTimeoutMS);
     }
@@ -329,7 +334,7 @@ protected JSONObject putRequest(String url, String obj) throws AlgoliaException
      *
      * @param istream the InputStream to read
      * @return the stream's content
-     * @throws IOException
+     * @throws IOException if the stream can't be read or closed
      */
     private String _getAnswer(InputStream istream) throws IOException {
         InputStreamReader is = new InputStreamReader(istream, "UTF-8");
@@ -348,7 +353,11 @@ private JSONObject _getJSONObject(String input) throws JSONException {
         return new JSONObject(new JSONTokener(input));
     }
 
-    private JSONObject _getAnswerObject(InputStream istream) throws IOException, JSONException {
+    private JSONObject _getJSONObject(byte[] array) throws JSONException {
+        return new JSONObject(new JSONTokener(new String(array)));
+    }
+
+    private JSONObject _getAnswerJSONObject(InputStream istream) throws IOException, JSONException {
         return _getJSONObject(_getAnswer(istream));
     }
 
@@ -362,9 +371,29 @@ private JSONObject _getAnswerObject(InputStream istream) throws IOException, JSO
      * @param connectTimeout maximum wait time to open connection
      * @param readTimeout maximum time to read data on socket
      * @return a JSONObject containing the resulting data or error
-     * @throws AlgoliaException
+     * @throws AlgoliaException if the request data is not valid json
      */
     private synchronized JSONObject _request(Method m, String url, String json, List<String> hostsArray, int connectTimeout, int readTimeout) throws AlgoliaException {
+        try {
+            return _getJSONObject(_requestRaw(m, url, json, hostsArray, connectTimeout, readTimeout));
+        } catch (JSONException e) {
+            throw new AlgoliaException("JSON decode error:" + e.getMessage());
+        }
+    }
+
+    /**
+     * Send the query according to parameters and returns its result as a JSONObject
+     *
+     * @param m HTTP Method to use
+     * @param url endpoint URL
+     * @param json optional JSON Object to send
+     * @param hostsArray array of hosts to try successively
+     * @param connectTimeout maximum wait time to open connection
+     * @param readTimeout maximum time to read data on socket
+     * @return a JSONObject containing the resulting data or error
+     * @throws AlgoliaException in case of connection or data handling error
+     */
+    private synchronized byte[] _requestRaw(Method m, String url, String json, List<String> hostsArray, int connectTimeout, int readTimeout) throws AlgoliaException {
         String requestMethod;
         HashMap<String, String> errors = new HashMap<String, String>();
         // for each host
@@ -459,7 +488,7 @@ private synchronized JSONObject _request(Method m, String url, String json, List
             } else if (code / 100 == 4) {
                 String message = "Error detected in backend";
                 try {
-                    message = _getAnswerObject(stream).getString("message");
+                    message = _getAnswerJSONObject(stream).getString("message");
                 } catch (IOException e) {
                     addError(errors, host, e);
                     continue;
@@ -481,13 +510,11 @@ private synchronized JSONObject _request(Method m, String url, String json, List
             try {
                 String encoding = hostConnection.getContentEncoding();
                 if (encoding != null && encoding.contains("gzip")) {
-                    return _getAnswerObject(new GZIPInputStream(stream));
+                    return _toByteArray(new GZIPInputStream(stream));
                 }
                 else {
-                    return _getAnswerObject(stream);
+                    return _toByteArray(stream);
                 }
-            } catch (JSONException e) {
-                throw new AlgoliaException("JSON decode error:" + e.getMessage());
             } catch (IOException e) {
                 throw new AlgoliaException("Data decoding error:" + e.getMessage());
             }
@@ -504,6 +531,23 @@ private synchronized JSONObject _request(Method m, String url, String json, List
         throw new AlgoliaException(builder.toString());
     }
 
+    private byte[] _toByteArray(InputStream stream) throws AlgoliaException {
+        ByteArrayOutputStream out = new ByteArrayOutputStream();
+        int read;
+        byte[] buffer = new byte[1024];
+
+        try {
+            while ((read = stream.read(buffer, 0, buffer.length)) != -1) {
+                out.write(buffer, 0, read);
+            }
+
+            out.flush();
+            return out.toByteArray();
+        } catch (IOException e) {
+            throw new AlgoliaException("Error while reading stream: " + e.getMessage());
+        }
+    }
+
     private void addError(HashMap<String, String> errors, String host, IOException e) {
         errors.put(host, String.format("%s=%s", e.getClass().getName(), e.getMessage()));
     }

algoliasearch/src/main/java/com/algolia/search/saas/BaseIndex.java

@@ -74,8 +74,8 @@ protected JSONObject addObject(JSONObject obj) throws AlgoliaException {
     /**
      * Add an object in this index
      *
-     * @param obj the object to add. 
-     * @param objectID an objectID you want to attribute to this object 
+     * @param obj the object to add.
+     * @param objectID an objectID you want to attribute to this object
      * (if the attribute already exist the old object will be overwrite)
      * @throws AlgoliaException
      */
@@ -261,7 +261,7 @@ protected JSONObject saveObjects(JSONArray inputArray) throws AlgoliaException {
     }
 
     /**
-     * Delete an object from the index 
+     * Delete an object from the index
      *
      * @param objectID the unique identifier of object to delete
      * @throws AlgoliaException
@@ -330,7 +330,7 @@ protected void deleteByQuery(Query query) throws AlgoliaException {
 
     /**
      * Search inside the index
-     *
+     * @return a JSONObject containing search results
      * @throws AlgoliaException
      */
     protected JSONObject search(Query query) throws AlgoliaException {
@@ -342,7 +342,20 @@ protected JSONObject search(Query query) throws AlgoliaException {
     }
 
     /**
-     * Wait the publication of a task on the server. 
+     * Search inside the index
+     * @return a byte array containing search results
+     * @throws AlgoliaException
+     */
+    protected byte[] searchRaw(Query query) throws AlgoliaException {
+        String paramsString = query.getQueryString();
+        if (paramsString.length() > 0)
+            return client.getRequestRaw("/1/indexes/" + encodedIndexName + "?" + paramsString, true);
+        else
+            return client.getRequestRaw("/1/indexes/" + encodedIndexName, true);
+    }
+
+    /**
+     * Wait the publication of a task on the server.
      * All server task are asynchronous and you can check with this method that the task is published.
      *
      * @param taskID the id of the task returned by server