Class EmbeddedJsonCache

java.lang.Object
org.infinispan.server.resp.json.EmbeddedJsonCache
public class EmbeddedJsonCache extends Object
A cache implementation for JSON data, providing various methods for interacting with and manipulating JSON objects, arrays, and values. This class includes methods for setting, retrieving, and querying JSON data in an embedded cache.

Note: The implementation provides a set of functionalities for handling JSON objects, including operations like recursively extracting values, checking types, and working with specific paths.

Since:
15.2
Author:
Vittorio Rigamonti, Katia Aresti

  • Field Details

  • Constructor Details

    • EmbeddedJsonCache

      public EmbeddedJsonCache(Cache<byte[], JsonBucket> cache)

  • Method Details

    • get

      public CompletionStage<byte[]> get(byte[] key, List<byte[]> paths, byte[] space, byte[] newline, byte[] indent)
      Retrieves the JSON value at the specified paths within the given key. The resulting JSON content can be formatted with the provided spacing, newline, and indentation settings.
      Parameters:
      key - The key from which the JSON value will be retrieved, represented as a byte array.
      paths - A list of JSON paths used to access specific values within the JSON, each represented as a byte array.
      space - The byte array used to represent spaces for formatting the JSON output.
      newline - The byte array used to represent newline characters for formatting the JSON output.
      indent - The byte array used to represent indentation characters for formatting the JSON output.
      Returns:
      A CompletionStage containing the formatted JSON content as a byte array.

    • set

      public CompletionStage<String> set(byte[] key, byte[] value, byte[] path, boolean nx, boolean xx)
      Sets a JSON value at the specified path in the given key.
      Parameters:
      key - The key in which the JSON value should be stored, represented as a byte array.
      value - The JSON value to set, represented as a byte array.
      path - The JSON path where the value should be inserted, represented as a byte array.
      nx - If true, the operation will only succeed if the key does not already exist (NX - "Not Exists").
      xx - If true, the operation will only succeed if the key already exists (XX - "Exists").
      Returns:
      A CompletionStage containing the result of the operation as a String.

    • arrLen

      public CompletionStage<List<Long>> arrLen(byte[] key, byte[] path)
      Retrieves the length of an array at the specified JSON path.

      If the value at the path is an array, it returns the number of elements. Returns null if the value is not an array.

      Parameters:
      key - the key identifying the JSON document
      path - the JSON path to evaluate
      Returns:
      a CompletionStage resolving to a List of array lengths, or null if the value is not an array

    • srtLen

      public CompletionStage<List<Long>> srtLen(byte[] key, byte[] path)
      Retrieves the length of a string at the specified JSON path.

      If the value at the path is a string, it returns the number of characters. Returns null if the value is not a string.

      Parameters:
      key - the key identifying the JSON document
      path - the JSON path to evaluate
      Returns:
      a CompletionStage resolving to a List of string lengths, or null if the value is not a string

    • objLen

      public CompletionStage<List<Long>> objLen(byte[] key, byte[] path)
      Retrieves the number of key-value pairs in an object at the specified JSON path.

      If the value at the path is an object, it returns the number of keys. Returns null if the value is not an object.

      Parameters:
      key - the key identifying the JSON document
      path - the JSON path to evaluate
      Returns:
      a CompletionStage resolving to a List of object sizes, or null if the value is not an object

    • type

      public CompletionStage<List<String>> type(byte[] key, byte[] path)
      Reports the type of the JSON value at the specified path within the given JSON. The result will indicate the type of the value at each path in the list.
      Parameters:
      key - The key representing the JSON document, provided as a byte array.
      path - The JSON path at which the type of the value should be determined, provided as a byte array.
      Returns:
      A CompletionStage containing a List of type strings, representing the type of the JSON value at each path (e.g., "object", "array", "string", etc.).

    • del

      public CompletionStage<Long> del(byte[] key, byte[] path)
      Deletes the value at the given path in the JSON document.
      Parameters:
      key - the key of the JSON document
      path - the path to the value to be deleted
      Returns:
      a CompletionStage of the number of bytes deleted

    • arrAppend

      public CompletionStage<List<Long>> arrAppend(byte[] key, byte[] path, List<byte[]> values)
      Appends the given values to the array at the specified paths in the JSON document associated with the specified key. If the paths does not refer to an array, no changes are made to the document.
      Parameters:
      key - The key of the JSON document to update.
      path - The JSON path of the array to append to.
      values - The values to append to the array.
      Returns:
      A CompletionStage that will complete with the returning a list of the new lengths of the changed arrays. Null is returned for the matching paths that are not arrays.

    • strAppend

      public CompletionStage<List<Long>> strAppend(byte[] key, byte[] path, byte[] value)
      Appends the given value to the string at the specified paths in the JSON document associated with the specified key. If the path exists but is not a string, no changes are made. IllegalArgumentException is thrown.
      Parameters:
      key - the key identifying the JSON document
      path - the path to the array in the JSON document
      value - the value to append to the array
      Returns:
      A CompletionStage that will complete with the returning a list of the new lengths of the changed string. Null is returned for the matching paths that are not string.

    • toggle

      public CompletionStage<List<Integer>> toggle(byte[] key, byte[] path)
      Toggles the boolean value at the specified JSON path in the stored JSON document. If the value is `true`, it becomes `false`, and vice versa. Non-boolean values result in `null`.
      Parameters:
      key - The key identifying the JSON document in the Infinispan cache.
      path - The JSON path where the boolean value should be toggled.
      Returns:
      A CompletionStage with a List<Integer> of results:
      • 1 if toggled to true
      • 0 if toggled to false
      • null if the value is not a boolean

    • objKeys

      public CompletionStage<List<List<byte[]>>> objKeys(byte[] key, byte[] path)
      Retrieves the keys of the JSON object at the specified path within the given JSON document.
      Parameters:
      key - The key representing the JSON document, provided as a byte array.
      path - The JSON path at which the keys should be retrieved, provided as a byte array.
      Returns:
      A CompletionStage containing a List of list of byte arrays, each representing a key in the JSON object or null if object is not a json object.

    • numIncBy

      public CompletionStage<List<Number>> numIncBy(byte[] key, byte[] path, byte[] value)
      Increments the number at the specified JSON path by the given value.
      Parameters:
      key - the key identifying the JSON document
      path - the JSON path to the number to be incremented
      value - the value to operate by
      Returns:
      a CompletionStage resolving to a list of updated numbers

    • numMultBy

      public CompletionStage<List<Number>> numMultBy(byte[] key, byte[] path, byte[] value)
      Multiply the number at the specified JSON path by the given value.
      Parameters:
      key - the key identifying the JSON document
      path - the JSON path to the number to be multiplied
      value - the value to operate by
      Returns:
      a CompletionStage resolving to a list of updated numbers

    • clear

      public CompletionStage<Integer> clear(byte[] key, byte[] path)
      Clears container values (arrays/objects) and sets numeric values to 0 at the specified JSON path for the given key.
      Parameters:
      key - The key identifying the data.
      path - The JSON path of the data to clear.
      Returns:
      A CompletionStage indicating the result of the operation.

    • arrIndex

      public CompletionStage<List<Integer>> arrIndex(byte[] key, byte[] jsonPath, byte[] value, int start, int stop, boolean isLegacy)
      Finds the first index of the specified value in the JSON array at the given path. The search is performed within the specified range [start, stop].
      Parameters:
      key - The key identifying the JSON document.
      jsonPath - The JSON path to the array in which to search for the value.
      value - The value to search for in the array.
      start - The starting index of the range to search within.
      stop - The ending index of the range to search within.
      isLegacy - A boolean indicating whether to use legacy behavior.
      Returns:
      A CompletionStage that will complete with a list of indices where the value is found. If the value is not found, the list will contain -1.

    • arrInsert

      public CompletionStage<List<Integer>> arrInsert(byte[] key, byte[] jsonPath, int index, List<byte[]> values)
      Inserts the given values into the array at the specified index in the JSON document identified by the given key.
      Parameters:
      key - The key identifying the JSON document.
      jsonPath - The JSON path specifying the array.
      index - The index at which to insert the values.
      values - The values to insert.
      Returns:
      A CompletionStage that will complete with the list of the new lengths of the changed arrays. Null is returned for the matching paths that are not arrays.

    • arrTrim

      public CompletionStage<List<Integer>> arrTrim(byte[] key, byte[] jsonPath, int start, int stop)
      Trims the elements in an array out of the specified range.
      Parameters:
      key - The key of the array to trim.
      jsonPath - The JSON path of the array to trim.
      start - The starting index of the range to keep (inclusive).
      stop - The ending index of the range to keep (inclusive).
      Returns:
      A CompletionStage that will complete with a list of length of the trimmed array.

    • arrpop

      public CompletionStage<List<byte[]>> arrpop(byte[] key, byte[] jsonPath, int index)
      Removes the element at the specified index from the array at the specified JSON path in the document associated with the specified key.
      Parameters:
      key - The key of the document.
      jsonPath - The JSON path to the array.
      index - The index of the element to remove.
      Returns:
      A CompletionStage that will complete with the remove elements of all the matching paths.

    • merge

      public CompletionStage<String> merge(byte[] key, byte[] jsonPath, byte[] value)
      Merges the given JSON value into the JSON document at the given JSON path in the map entry with the given key. Merge is performed recursively (deep merge).
      Parameters:
      key - the key of the map entry
      jsonPath - the JSON path of the field to merge the value into
      value - the value to merge into the JSON document
      Returns:
      a CompletionStage that completes with OK if the merge is successful

    • resp

      public CompletionStage<List<Object>> resp(byte[] key, byte[] jsonPath)
      Returns a RESP representation of the json objects matching the jsonPath
      Parameters:
      key - The key of the document.
      jsonPath - The JSON path.
      Returns:
      A CompletionStage that will complete with the RESP representation