feat: allows store items to be read as JSON.

Author: outofcoffee

docs/stores.md

@@ -52,6 +52,15 @@ if (exampleStore.hasItemWithKey('example')) {
 }
 ```
 
+Read a store item as JSON:
+
+```js
+var json = exampleStore.loadAsJson('foo');
+
+// prints the 'foo' item as JSON
+console.log(json);
+```
+
 ## The Stores REST API
 
 You can also retrieve or save data to a store through the `/system/store` API. This can be useful for tests to verify what was sent to a mock:

store/common/src/main/java/io/gatehill/imposter/store/core/AbstractStore.kt

@@ -44,6 +44,7 @@ package io.gatehill.imposter.store.core
 
 import io.gatehill.imposter.http.ExchangePhase
 import io.gatehill.imposter.service.DeferredOperationService
+import io.gatehill.imposter.util.MapUtil
 import org.apache.logging.log4j.LogManager
 import org.apache.logging.log4j.Logger
 
@@ -55,6 +56,10 @@ abstract class AbstractStore(
 ) : Store {
     private val logger: Logger = LogManager.getLogger(AbstractStore::class.java)
 
+    override fun loadAsJson(key: String): String {
+        return MapUtil.jsonify(load(key))
+    }
+
     override fun save(key: String, value: Any?, phase: ExchangePhase) {
         if (phase == ExchangePhase.RESPONSE_SENT && isEphemeral) {
             throw IllegalStateException("Cannot use deferred persistence for ephemeral store: $storeName of type: $typeDescription")

store/common/src/main/java/io/gatehill/imposter/store/core/PrefixedKeyStore.kt

@@ -73,6 +73,10 @@ class PrefixedKeyStore(
 
     override fun <T> load(key: String): T? = delegate.load(buildKey(key))
 
+    override fun loadAsJson(key: String): String {
+        return delegate.loadAsJson(buildKey(key))
+    }
+
     override fun loadByKeyPrefix(keyPrefix: String): Map<String, Any?> = delegate.loadByKeyPrefix(keyPrefix)
 
     override fun delete(key: String) {

store/common/src/main/java/io/gatehill/imposter/store/core/Store.kt

@@ -58,6 +58,7 @@ interface Store {
         phase: ExchangePhase = ExchangePhase.REQUEST_RECEIVED,
     )
     fun <T> load(key: String): T?
+    fun loadAsJson(key: String): String
     fun delete(key: String)
     fun loadAll(): Map<String, Any?>
     fun loadByKeyPrefix(keyPrefix: String): Map<String, Any?>