New API controller: server

.ci/doc/templates/print-result.tpl.java

@@ -1,5 +1,6 @@
 import io.kuzzle.sdk.Kuzzle;
 import io.kuzzle.sdk.protocol.WebSocket;
+import java.util.Date;
 import io.kuzzle.sdk.coreClasses.responses.Response;
 
 import java.util.concurrent.ConcurrentHashMap;

.ci/doc/templates/print-result.tpl.kt

@@ -1,5 +1,6 @@
 import io.kuzzle.sdk.Kuzzle
 import io.kuzzle.sdk.protocol.WebSocket
+import java.util.Date
 import java.util.concurrent.ConcurrentHashMap
 import java.util.concurrent.ExecutionException
 import io.kuzzle.sdk.coreClasses.responses.Response

doc/1/controllers/auth/update-self/snippets/update-self-java.test.yml

@@ -4,4 +4,4 @@ hooks:
   before: curl -X POST kuzzle:7512/users/foo/_create -H "Content-Type:application/json" --data '{"content":{"profileIds":["default"]},"credentials":{"local":{"username":"foo","password":"bar"}}}'
   after: curl -X DELETE kuzzle:7512/users/foo
 template: print-result
-expected: ^{_source={profileIds=\[default\],\ _kuzzle_info={createdAt=[0-9]+,\ author=-1},\ age=42},\ _id=foo}$
+expected: ^{_source={profileIds=\[default\],\ _kuzzle_info={updatedAt=[0-9]+,\ updater=foo},\ age=42},\ _id=foo}$

doc/1/controllers/auth/update-self/snippets/update-self-kotlin.test.yml

@@ -4,4 +4,4 @@ hooks:
   before: curl -X POST kuzzle:7512/users/foo/_create -H "Content-Type:application/json" --data '{"content":{"profileIds":["default"]},"credentials":{"local":{"username":"foo","password":"bar"}}}'
   after: curl -X DELETE kuzzle:7512/users/foo
 template: print-result
-expected: ^{_source={profileIds=\[default\],\ _kuzzle_info={createdAt=[0-9]+,\ author=-1},\ age=42},\ _id=foo}$
+expected: ^{_source={profileIds=\[default\],\ _kuzzle_info={updatedAt=[0-9]+,\ updater=foo},\ age=42},\ _id=foo}$

doc/1/controllers/server/admin-exists/index.md

@@ -0,0 +1,40 @@
+---
+code: true
+type: page
+title: adminExists
+description: Checks that an administrator account exists.
+---
+
+# adminExists
+
+Checks that an administrator account exists.
+
+:::: tabs
+::: tab Java
+
+```java
+CompletableFuture<Boolean> adminExists()
+```
+
+## Return
+
+A boolean indicating whether an admin user exists or not.
+
+## Usage
+
+<<< ./snippets/adminExists-java.java
+
+:::: tabs
+::: tab Kotlin
+
+```kotlin
+fun adminExists(): CompletableFuture<Boolean>
+```
+
+## Return
+
+A boolean indicating whether an admin user exists or not.
+
+## Usage
+
+<<< ./snippets/adminExists-kotlin.kotlin

doc/1/controllers/server/admin-exists/snippets/admin-exists-java.java

@@ -0,0 +1 @@
+Boolean result = kuzzle.getServerController().adminExists().get();

doc/1/controllers/server/admin-exists/snippets/admin-exists-java.test.yml

@@ -0,0 +1,7 @@
+name: java-Server#AdminExistsAsync
+description: Checks that an administrator account exists.
+hooks:
+  before:
+  after:
+template: print-result
+expected: false

doc/1/controllers/server/admin-exists/snippets/admin-exists-kotlin.kt

@@ -0,0 +1,2 @@
+val result: Boolean =
+    kuzzle.serverController.adminExists().get()

doc/1/controllers/server/admin-exists/snippets/admin-exists-kotlin.test.yml

@@ -0,0 +1,7 @@
+name: kotlin-Server#AdminExistsAsync
+description: Checks that an administrator account exists.
+hooks:
+  before: 
+  after:
+template: print-result
+expected: false

doc/1/controllers/server/get-all-stats/index.md

@@ -0,0 +1,47 @@
+---
+code: true
+type: page
+title: getAllStats
+description: Gets all stored internal statistic snapshots.
+---
+
+# getAllStats
+
+Gets all stored internal statistic snapshots.
+By default, snapshots are made every 10 seconds and they are stored for 1 hour.
+
+These statistics include:
+
+- the number of connected users per protocol (not available for all protocols)
+- the number of ongoing requests
+- the number of completed requests since the last frame
+- the number of failed requests since the last frame
+
+:::: tabs
+::: tab Java
+
+```java
+CompletableFuture<ConcurrentHashMap<String, Object>> getAllStats()
+```
+
+## Return
+
+Returns a `ConcurrentHashMap<String, Object>` containing all stored internal statistic snapshots.
+
+## Usage
+
+<<< ./snippets/get-all-stats-java.java
+
+::: tab Kotlin
+
+```kotlin
+fun getAllStats(): CompletableFuture<ConcurrentHashMap<String, Any?>>
+```
+
+## Return
+
+Returns a `ConcurrentHashMap<String, Any?>` containing all stored internal statistic snapshots.
+
+## Usage
+
+<<< ./snippets/get-all-stats-kotlin.kt

doc/1/controllers/server/get-all-stats/snippets/get-all-stats-java.java

@@ -0,0 +1,4 @@
+ConcurrentHashMap<String, Object> result = kuzzle
+    .getServerController()
+    .getAllStats()
+    .get();

doc/1/controllers/server/get-all-stats/snippets/get-all-stats-java.test.yml

@@ -0,0 +1,7 @@
+name: java-server#getAllStats
+description: Gets all stored internal statistic snapshots.
+hooks:
+  before:
+  after:
+template: print-result
+expected: ongoingRequests

doc/1/controllers/server/get-all-stats/snippets/get-all-stats-kotlin.kt

@@ -0,0 +1,4 @@
+val result: ConcurrentHashMap<String, Any?> = kuzzle
+    .serverController
+    .getAllStats()
+    .get()

doc/1/controllers/server/get-all-stats/snippets/get-all-stats-kotlin.test.yml

@@ -0,0 +1,7 @@
+name: kotlin-server#getAllStats
+description: Gets all stored internal statistic snapshots.
+hooks:
+  before:
+  after:
+template: print-result
+expected: ongoingRequests

doc/1/controllers/server/get-config/index.md

@@ -0,0 +1,43 @@
+---
+code: true
+type: page
+title: getConfig
+description: Returns the current Kuzzle configuration.
+---
+
+# getConfig
+
+Returns the current Kuzzle configuration.
+
+:::warning
+This route should only be accessible to administrators, as it might return sensitive information about the backend.
+:::
+
+:::: tabs
+::: tab Java
+
+```java
+CompletableFuture<ConcurrentHashMap<String, Object>> getConfig()
+```
+
+## Return
+
+Returns a `ConcurrentHashMap<String, Object>` containing server configuration.
+
+## Usage
+
+<<< ./snippets/get-config-java.java
+
+::: tab Kotlin
+
+```kotlin
+fun getConfig(): CompletableFuture<ConcurrentHashMap<String, Any?>>
+```
+
+## Return
+
+Returns a `ConcurrentHashMap<String, Any?>` containing server configuration.
+
+## Usage
+
+<<< ./snippets/get-config-kotlin.kt

doc/1/controllers/server/get-config/snippets/get-config-java.java

@@ -0,0 +1,4 @@
+ConcurrentHashMap<String, Object> result = kuzzle
+    .getServerController()
+    .getConfig()
+    .get();

doc/1/controllers/server/get-config/snippets/get-config-java.test.yml

@@ -0,0 +1,7 @@
+name: java-server#getConfig
+description: Returns the current Kuzzle configuration.
+hooks:
+  before:
+  after:
+template: print-result
+expected: ^{server={.*}$

doc/1/controllers/server/get-config/snippets/get-config-kotlin.kt

@@ -0,0 +1,4 @@
+val result: ConcurrentHashMap<String, Any?> = kuzzle
+    .serverController
+    .getConfig()
+    .get()

doc/1/controllers/server/get-config/snippets/get-config-kotlin.test.yml

@@ -0,0 +1,7 @@
+name: kotlin-server#getConfig
+description: Returns the current Kuzzle configuration.
+hooks:
+  before:
+  after:
+template: print-result
+expected: ^{server={.*}$

doc/1/controllers/server/get-last-stats/index.md

@@ -0,0 +1,48 @@
+---
+code: true
+type: page
+title: getLastStats
+description: Returns the most recent statistics snapshot.
+---
+
+# getLastStats
+
+Returns the most recent statistics snapshot.
+
+By default, snapshots are made every 10 seconds and they are stored for 1 hour.
+
+These statistics include:
+
+- the number of connected users per protocol (not available for all protocols)
+- the number of ongoing requests
+- the number of completed requests since the last frame
+- the number of failed requests since the last frame
+
+:::: tabs
+::: tab Java
+
+```java
+CompletableFuture<ConcurrentHashMap<String, Object>> getLastStats()
+```
+
+## Return
+
+Returns an `ConcurrentHashMap<String, Object>` containing the most recent statistics snapshot.
+
+## Usage
+
+<<< ./snippets/get-last-stats-java.java
+
+::: tab Kotlin
+
+```kotlin
+fun getConfig(): CompletableFuture<ConcurrentHashMap<String, Any?>>
+```
+
+## Return
+
+Returns an `ConcurrentHashMap<String, Any?>` containing the most recent statistics snapshot.
+
+## Usage
+
+<<< ./snippets/get-last-stats-kotlin.kt

doc/1/controllers/server/get-last-stats/snippets/get-last-stats-java.java

@@ -0,0 +1,4 @@
+ConcurrentHashMap<String, Object> result = kuzzle
+    .getServerController()
+    .getLastStats()
+    .get();

doc/1/controllers/server/get-last-stats/snippets/get-last-stats-java.test.yml

@@ -0,0 +1,7 @@
+name: java-server#getLastStats
+description: Gets all stored internal statistic snapshots.
+hooks:
+  before:
+  after:
+template: print-result
+expected: ongoingRequests

doc/1/controllers/server/get-last-stats/snippets/get-last-stats-kotlin.kt

@@ -0,0 +1,4 @@
+val result: ConcurrentHashMap<String, Any?> = kuzzle
+    .serverController
+    .getLastStats()
+    .get()

doc/1/controllers/server/get-last-stats/snippets/get-last-stats-kotlin.test.yml

@@ -0,0 +1,7 @@
+name: kotlin-server#getLastStats
+description: Gets all stored internal statistic snapshots.
+hooks:
+  before:
+  after:
+template: print-result
+expected: ongoingRequests

doc/1/controllers/server/get-stats/index.md

@@ -0,0 +1,62 @@
+---
+code: true
+type: page
+title: getStats
+description: Returns statistics snapshots within a provided timestamp range.
+---
+
+# getStats
+
+Returns statistics snapshots within a provided timestamp range.
+By default, snapshots are made every 10 seconds and they are stored for 1 hour.
+
+These statistics include:
+
+- the number of connected users per protocol (not available for all protocols)
+- the number of ongoing requests
+- the number of completed requests since the last frame
+- the number of failed requests since the last frame
+
+:::: tabs
+::: tab Java
+
+```java
+CompletableFuture<ConcurrentHashMap<String, Object>> getStats(
+      Date startTime, Date stopTime)
+```
+
+<br/>
+
+| Arguments   | Type                      | Description                                                     |
+| ----------- | ------------------------- | --------------------------------------------------------------- |
+| `startTime` | <pre>Date</pre> | Beginning of statistics frame set |
+| `stopTime`  | <pre>Date</pre> | End of statistics frame set |
+
+## Return
+
+Returns a `ConcurrentHashMap<String, Object>` containing statistics snapshots within the provided range.
+
+## Usage
+
+<<< ./snippets/get-stats-java.java
+
+::: tab Kotlin
+
+```kotlin
+fun getStats(startTime: Date, stopTime: Date): CompletableFuture<ConcurrentHashMap<String, Any?>>
+```
+
+<br/>
+
+| Arguments   | Type                      | Description                                                     |
+| ----------- | ------------------------- | --------------------------------------------------------------- |
+| `startTime` | <pre>Date</pre> | Beginning of statistics frame set |
+| `stopTime`  | <pre>Date</pre> | End of statistics frame set |
+
+## Return
+
+Returns a `ConcurrentHashMap<String, Any?>` containing statistics snapshots within the provided range.
+
+## Usage
+
+<<< ./snippets/get-stats-kotlin.kt

doc/1/controllers/server/get-stats/snippets/get-stats-java.java

@@ -0,0 +1,7 @@
+Date startTime = new Date(1234567890);
+Date stopTime = new Date(1541426610);
+
+ConcurrentHashMap<String, Object> result = kuzzle
+    .getServerController()
+    .getStats(startTime, stopTime)
+    .get();