Add Index controller

.travis.yml

@@ -31,7 +31,6 @@ jobs:
       script:
         - docker-compose -f .ci/doc/docker-compose.yml run doc-tests index
 
-
     - stage: Deployment Doc Dev
       name: Deploy next-docs.kuzzle.io
       if: type = push AND branch =~ /^[0-9]+-dev$/

doc/3/controllers/index/create/index.md

@@ -0,0 +1,25 @@
+---
+code: true
+type: page
+title: create
+description: Creates an index.
+---
+
+# create
+
+Creates a new index in Kuzzle
+
+## Arguments
+
+```java
+CompletableFuture<Void> create(final String index) 
+  throws NotConnectedException, InternalException
+```
+
+| Argument | Type              | Description |
+|----------|-------------------|-------------|
+| `index`  | <pre>String</pre> | Index name  |
+
+## Usage
+
+<<< ./snippets/create.java

doc/3/controllers/index/create/snippets/create.java

@@ -0,0 +1 @@
+kuzzle.getIndexController().create("nyc-open-data").get();

doc/3/controllers/index/create/snippets/create.test.yml

@@ -0,0 +1,8 @@
+---
+name: Index#CreateAsync
+description: Creates a new index.
+hooks:
+  before: curl -X DELETE kuzzle:7512/nyc-open-data
+  after:
+template: default
+expected: Success

doc/3/controllers/index/delete/index.md

@@ -0,0 +1,25 @@
+---
+code: true
+type: page
+title: delete
+description: Deletes an index.
+---
+
+# delete
+
+Deletes an entire index from Kuzzle.
+
+## Arguments
+
+```java
+CompletableFuture<Void> delete(final String index)
+  throws NotConnectedException, InternalException
+```
+
+| Argument | Type              | Description |
+|----------|-------------------|-------------|
+| `index`  | <pre>String</pre> | Index name  |
+
+## Usage
+
+<<< ./snippets/delete.java

doc/3/controllers/index/delete/snippets/delete.java

@@ -0,0 +1 @@
+kuzzle.getIndexController().delete("nyc-open-data").get();

doc/3/controllers/index/delete/snippets/delete.test.yml

@@ -0,0 +1,8 @@
+---
+name: Index#Delete
+description: Delete an index.
+hooks:
+  before: curl -X POST kuzzle:7512/nyc-open-data/_create
+  after:
+template: default
+expected: Success

doc/3/controllers/index/exists/index.md

@@ -0,0 +1,29 @@
+---
+code: true
+type: page
+title: exists
+description: Check for index existence.
+---
+
+# exists
+
+Checks if the given index exists in Kuzzle.
+
+## Arguments
+
+```java
+CompletableFuture<Boolean> exists(final String index) 
+  throws NotConnectedException, InternalException
+```
+
+| Argument | Type              | Description |
+|----------|-------------------|-------------|
+| `index`  | <pre>String</pre> | Index name  |
+
+## Return
+
+Returns a `boolean` that indicates whether the index exists or not.
+
+## Usage
+
+<<< ./snippets/exists.java

doc/3/controllers/index/exists/snippets/exists.java

@@ -0,0 +1 @@
+Boolean result = kuzzle.getIndexController().exists("nyc-open-data").get();

doc/3/controllers/index/exists/snippets/exists.test.yml

@@ -0,0 +1,8 @@
+---
+name: Index#ExistsAsync
+description: Test if an index exists.
+hooks:
+  before: curl -X POST kuzzle:7512/nyc-open-data/_create
+  after:
+template: print-result
+expected: true

doc/3/controllers/index/index.md

@@ -0,0 +1,8 @@
+---
+code: true
+type: branch
+title: Index
+description: Index Controller
+---
+
+# Index Controller

doc/3/controllers/index/list/index.md

@@ -0,0 +1,25 @@
+---
+code: true
+type: page
+title: list
+description: Lists the indexes.
+---
+
+# list
+
+Gets the complete list of indexes handled by Kuzzle.
+
+## Arguments
+
+```java
+CompletableFuture<ArrayList<String>> list() 
+  throws NotConnectedException, InternalException
+```
+
+## Return
+
+Returns an `ArrayList<String>` containing the list of index names handled by Kuzzle.
+
+## Usage
+
+<<< ./snippets/list.java

doc/3/controllers/index/list/snippets/list.java

@@ -0,0 +1 @@
+ArrayList<String> result = kuzzle.getIndexController().list().get();

doc/3/controllers/index/list/snippets/list.test.yml

@@ -0,0 +1,10 @@
+---
+name: Index#ListAsync
+description: List indexes handled by Kuzzle.
+hooks:
+  before: |
+    curl -X POST kuzzle:7512/admin/_resetDatabase 
+    curl -X POST kuzzle:7512/nyc-open-data/_create
+  after:
+template: print-result
+expected: ["nyc-open-data"]

doc/3/controllers/index/m-delete/index.md

@@ -0,0 +1,29 @@
+---
+code: true
+type: page
+title: mDelete
+description: Deletes multiple indexes.
+---
+
+# mDelete
+
+Deletes multiple indexes.
+
+## Arguments
+
+```java
+CompletableFuture<ArrayList<String>> mDelete(final ArrayList<String> indexes) 
+  throws NotConnectedException, InternalException
+```
+
+| Argument  | Type              | Description           |
+|-----------|-------------------|-----------------------|
+| `indexes` | <pre>ArrayList<String></pre> | List of indexes names |
+
+## Return
+
+Returns an `ArrayList<String>` containing the list of indexes names deleted.
+
+## Usage
+
+<<< ./snippets/mDelete.java

doc/3/controllers/index/m-delete/snippets/mDelete.java

@@ -0,0 +1,3 @@
+ArrayList<String> indexes = new ArrayList<>();
+    indexes.add("nyc-open-data");
+ArrayList<String> result = kuzzle.getIndexController().mDelete(indexes).get();

doc/3/controllers/index/m-delete/snippets/mDelete.test.yml

@@ -0,0 +1,8 @@
+---
+name: Index#MDeleteAsync
+description: Delete multiple indexes.
+hooks:
+  before: curl -X POST kuzzle:7512/nyc-open-data/_create ; curl -X POST kuzzle:7512/mtp-open-data/_create
+  after:
+template: print-result
+expected: ["nyc-open-data"]

src/main/java/io/kuzzle/sdk/API/Controllers/IndexController.java

@@ -0,0 +1,98 @@
+package io.kuzzle.sdk.API.Controllers;
+
+import io.kuzzle.sdk.CoreClasses.Maps.KuzzleMap;
+import io.kuzzle.sdk.Exceptions.InternalException;
+import io.kuzzle.sdk.Exceptions.NotConnectedException;
+import io.kuzzle.sdk.Kuzzle;
+
+import java.util.ArrayList;
+import java.util.concurrent.CompletableFuture;
+
+public class IndexController extends BaseController {
+  public IndexController(final Kuzzle kuzzle) {
+    super(kuzzle);
+  }
+
+  /**
+   * Creates a new index in Kuzzle via the persistence engine.
+   *
+   * @param index
+   * @return A CompletableFuture
+   * @throws NotConnectedException
+   * @throws InternalException
+   */
+  public CompletableFuture<Void> create(final String index) throws NotConnectedException, InternalException {
+    return kuzzle
+        .query(new KuzzleMap()
+            .put("controller", "index")
+            .put("action", "create")
+            .put("index", index))
+        .thenApplyAsync((response) -> null);
+  }
+
+  /**
+   * Deletes an index in Kuzzle via the persistence engine.
+   *
+   * @param index
+   * @return A CompletableFuture
+   * @throws NotConnectedException
+   * @throws InternalException
+   */
+  public CompletableFuture<Void> delete(final String index) throws NotConnectedException, InternalException {
+    return kuzzle
+        .query(new KuzzleMap()
+            .put("controller", "index")
+            .put("action", "delete")
+            .put("index", index))
+        .thenApplyAsync((response) -> null);
+  }
+
+  /**
+   * Checks if an index exists in the Kuzzle persistence engine.
+   *
+   * @param index
+   * @return A CompletableFuture<Boolean>
+   * @throws NotConnectedException
+   * @throws InternalException
+   */
+  public CompletableFuture<Boolean> exists(final String index) throws NotConnectedException, InternalException {
+    return kuzzle
+        .query(new KuzzleMap()
+            .put("controller", "index")
+            .put("action", "exists")
+            .put("index", index))
+        .thenApplyAsync((response) -> (Boolean) response.result);
+  }
+
+  /**
+   * Lists indexes from the Kuzzle persistence engine.
+   *
+   * @return A CompletableFuture<ArrayList<String>>
+   * @throws NotConnectedException
+   * @throws InternalException
+   */
+  public CompletableFuture<ArrayList<String>> list() throws NotConnectedException, InternalException {
+    return kuzzle
+        .query(new KuzzleMap()
+            .put("controller", "index")
+            .put("action", "list"))
+        .thenApplyAsync((response) -> (((KuzzleMap) response.result).getArrayList("indexes")));
+  }
+
+  /**
+   * Deletes multiple indexes from the Kuzzle persistence engine.
+   *
+   * @param indexes
+   * @return A CompletableFuture<ArrayList<String>>
+   * @throws NotConnectedException
+   * @throws InternalException
+   */
+  public CompletableFuture<ArrayList<String>> mDelete(final ArrayList<String> indexes) throws NotConnectedException, InternalException {
+    return kuzzle
+        .query(new KuzzleMap()
+            .put("controller", "index")
+            .put("action", "mDelete")
+            .put("body", new KuzzleMap().put("indexes", indexes)))
+        .thenApplyAsync((response) -> (((KuzzleMap) response.result).getArrayList("deleted")));
+  }
+}

src/main/java/io/kuzzle/sdk/Exceptions/KuzzleExceptionCode.java

@@ -2,7 +2,7 @@
 
 public enum KuzzleExceptionCode {
   MISSING_REQUESTID(0, "Missing field requestId"),
-  MSSING_QUERY(400, "You must provide a query"),
+  MISSING_QUERY(400, "You must provide a query"),
   NOT_CONNECTED(500, "Not connected."),
   CONNECTION_LOST(500, "Connection lost"),
   WRONG_VOLATILE_TYPE(

src/main/java/io/kuzzle/sdk/Kuzzle.java

@@ -1,5 +1,6 @@
 package io.kuzzle.sdk;
 
+import io.kuzzle.sdk.API.Controllers.IndexController;
 import io.kuzzle.sdk.API.Controllers.RealtimeController;
 import io.kuzzle.sdk.CoreClasses.Json.JsonSerializer;
 import io.kuzzle.sdk.CoreClasses.Maps.KuzzleMap;
@@ -69,10 +70,20 @@ public Kuzzle(final AbstractProtocol networkProtocol)
     this(networkProtocol, new KuzzleOptions());
   }
 
+  /**
+   * @return The AuthController
+   */
   public AuthController getAuthController() {
     return new AuthController(this);
   }
 
+  /**
+   * @return The IndexController
+   */
+  public IndexController getIndexController() {
+    return new IndexController(this);
+  }
+
   /**
    * @return RealtimeController
    */
@@ -200,7 +211,7 @@ public CompletableFuture<Response> query(
       final ConcurrentHashMap<String, Object> query)
       throws InternalException, NotConnectedException {
     if (query == null) {
-      throw new InternalException(KuzzleExceptionCode.MSSING_QUERY);
+      throw new InternalException(KuzzleExceptionCode.MISSING_QUERY);
     }
 
     if (networkProtocol.getState() == ProtocolState.CLOSE) {