org.redisson.api.RJsonStore Maven / Gradle / Ivy
Show all versions of redisson-all Show documentation
/**
* Copyright (c) 2013-2024 Nikita Koksharov
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.redisson.api;
import org.redisson.codec.JsonCodec;
import java.time.Duration;
import java.time.Instant;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* JSON Store which stores each entry as key and value. Both are POJO objects.
* Value is stored as JSON datatype in Redis.
*
* The implementation is available in Redisson PRO only.
*
* @author Nikita Koksharov
*
* @param the type of key
* @param the type of value
*
*/
public interface RJsonStore extends RExpirable, RJsonStoreAsync {
/**
* Gets value by specified key and JSONPath
*
* @param key entry key
* @param codec entry value codec
* @param paths JSON paths
* @return entry value
*
* @param the type of object
*/
T get(K key, JsonCodec codec, String... paths);
/**
* Sets value by specified key and JSONPath only if previous value is empty.
*
* @param key entry key
* @param path JSON path
* @param value entry value
* @return {@code true} if successful, or {@code false} if
* value was already set
*/
boolean setIfAbsent(K key, String path, Object value);
/**
* Sets value by specified key and JSONPath only if previous value is non-empty.
*
* @param key entry key
* @param path JSON path
* @param value object
* @return {@code true} if successful, or {@code false} if
* element wasn't set
*/
boolean setIfExists(K key, String path, Object value);
/**
* Atomically sets the value to the given updated value
* by specified key and JSONPath, only if serialized state of
* the current value equals to serialized state of the expected value.
*
* @param key entry key
* @param path JSON path
* @param expect the expected value
* @param update the new value
* @return {@code true} if successful; or {@code false} if the actual value
* was not equal to the expected value.
*/
boolean compareAndSet(K key, String path, Object expect, Object update);
/**
* Retrieves current value stored by specified key and JSONPath then
* replaces it with new value.
*
* @param key entry key
* @param codec entry value codec
* @param path JSON path
* @param newValue value to set
* @return previous value
*/
T getAndSet(K key, JsonCodec codec, String path, Object newValue);
/**
* Stores value by specified key and JSONPath.
*
* @param key entry key
* @param path JSON path
* @param value value to set
*/
void set(K key, String path, Object value);
/**
* Returns size of string data by specified key and JSONPath
*
* @param key entry key
* @param path JSON path
* @return size of string
*/
Long stringSize(K key, String path);
/**
* Returns list of string data size by specified key and JSONPath.
* Compatible only with enhanced syntax starting with '$' character.
*
* @param key entry key
* @param path JSON path
* @return list of string data sizes
*/
List stringSizeMulti(K key, String path);
/**
* Appends string data to element specified by specified key and JSONPath.
* Returns new size of string data.
*
* @param key entry key
* @param path JSON path
* @param value data
* @return size of string data
*/
long stringAppend(K key, String path, Object value);
/**
* Appends string data to elements specified by specified key and JSONPath.
* Returns new size of string data.
* Compatible only with enhanced syntax starting with '$' character.
*
* @param key entry key
* @param path JSON path
* @param value data
* @return list of string data sizes
*/
List stringAppendMulti(K key, String path, Object value);
/**
* Appends values to array by specified key and JSONPath.
* Returns new size of array.
*
* @param key entry key
* @param path JSON path
* @param values values to append
* @return size of array
*/
long arrayAppend(K key, String path, Object... values);
/**
* Appends values to arrays by specified key and JSONPath.
* Returns new size of arrays.
* Compatible only with enhanced syntax starting with '$' character.
*
* @param key entry key
* @param path JSON path
* @param values values to append
* @return list of arrays size
*/
List arrayAppendMulti(K key, String path, Object... values);
/**
* Returns index of object in array by specified key and JSONPath.
* -1 means object not found.
*
* @param key entry key
* @param path JSON path
* @param value value to search
* @return index in array
*/
long arrayIndex(K key, String path, Object value);
/**
* Returns index of object in arrays by specified key and JSONPath.
* -1 means object not found.
* Compatible only with enhanced syntax starting with '$' character.
*
* @param key entry key
* @param path JSON path
* @param value value to search
* @return list of index in arrays
*/
List arrayIndexMulti(K key, String path, Object value);
/**
* Returns index of object in array by specified key and JSONPath
* in range between start (inclusive) and end (exclusive) indexes.
* -1 means object not found.
*
* @param key entry key
* @param path JSON path
* @param value value to search
* @param start start index, inclusive
* @param end end index, exclusive
* @return index in array
*/
long arrayIndex(K key, String path, Object value, long start, long end);
/**
* Returns index of object in arrays by specified key and JSONPath
* in range between start (inclusive) and end (exclusive) indexes.
* -1 means object not found.
* Compatible only with enhanced syntax starting with '$' character.
*
* @param key entry key
* @param path JSON path
* @param value value to search
* @param start start index, inclusive
* @param end end index, exclusive
* @return list of index in arrays
*/
List arrayIndexMulti(K key, String path, Object value, long start, long end);
/**
* Inserts values into array by specified key and JSONPath.
* Values are inserted at defined index.
*
* @param key entry key
* @param path JSON path
* @param index array index at which values are inserted
* @param values values to insert
* @return size of array
*/
long arrayInsert(K key, String path, long index, Object... values);
/**
* Inserts values into arrays by specified key and JSONPath.
* Values are inserted at defined index.
* Compatible only with enhanced syntax starting with '$' character.
*
* @param key entry key
* @param path JSON path
* @param index array index at which values are inserted
* @param values values to insert
* @return list of arrays size
*/
List arrayInsertMulti(K key, String path, long index, Object... values);
/**
* Returns size of array by specified key and JSONPath.
*
* @param key entry key
* @param path JSON path
* @return size of array
*/
long arraySize(K key, String path);
/**
* Returns size of arrays by specified key and JSONPath.
* Compatible only with enhanced syntax starting with '$' character.
*
* @param key entry key
* @param path JSON path
* @return list of arrays size
*/
List arraySizeMulti(K key, String path);
/**
* Polls last element of array by specified key and JSONPath.
*
* @param key entry key
* @param codec object codec
* @param path JSON path
* @return last element
*
* @param the type of object
*/
T arrayPollLast(K key, JsonCodec codec, String path);
/**
* Polls last element of arrays by specified key and JSONPath.
* Compatible only with enhanced syntax starting with '$' character.
*
* @param key entry key
* @param codec object codec
* @param path JSON path
* @return list of last elements
*
* @param the type of object
*/
List arrayPollLastMulti(K key, JsonCodec codec, String path);
/**
* Polls first element of array by specified key and JSONPath.
*
* @param key entry key
* @param codec object codec
* @param path JSON path
* @return first element
*
* @param the type of object
*/
T arrayPollFirst(K key, JsonCodec codec, String path);
/**
* Polls first element of arrays by specified key and JSONPath.
* Compatible only with enhanced syntax starting with '$' character.
*
* @param key entry key
* @param codec object codec
* @param path JSON path
* @return list of first elements
*
* @param the type of object
*/
List arrayPollFirstMulti(K key, JsonCodec codec, String path);
/**
* Pops element located at index of array by specified key and JSONPath.
*
* @param key entry key
* @param codec object codec
* @param path JSON path
* @param index array index
* @return element
*
* @param the type of object
*/
T arrayPop(K key, JsonCodec codec, String path, long index);
/**
* Pops elements located at index of arrays by specified key and JSONPath.
* Compatible only with enhanced syntax starting with '$' character.
*
* @param key entry key
* @param codec object codec
* @param path JSON path
* @param index array index
* @return list of elements
*
* @param the type of object
*/
List arrayPopMulti(K key, JsonCodec codec, String path, long index);
/**
* Trims array by specified key and JSONPath in range
* between start (inclusive) and end (inclusive) indexes.
*
* @param key entry key
* @param path JSON path
* @param start start index, inclusive
* @param end end index, inclusive
* @return length of array
*/
long arrayTrim(K key, String path, long start, long end);
/**
* Trims arrays by specified key and JSONPath in range
* between start (inclusive) and end (inclusive) indexes.
* Compatible only with enhanced syntax starting with '$' character.
*
* @param key entry key
* @param path JSON path
* @param start start index, inclusive
* @param end end index, inclusive
* @return length of array
*/
List arrayTrimMulti(K key, String path, long start, long end);
/**
* Clears value by specified key
*
* @param key entry key
* @return {@code true} if successful, or {@code false} if
* entry doesn't exist
*/
boolean clear(K key);
/**
* Clears json containers by specified keys.
*
* @param keys entry keys
* @return number of cleared containers
*/
long clear(Set keys);
/**
* Clears json container by specified keys and JSONPath.
* Compatible only with enhanced syntax starting with '$' character.
*
* @param path JSON path
* @param keys entry keys
* @return number of cleared containers
*/
long clear(String path, Set keys);
/**
* Increments the current value specified by key and JSONPath.
*
* @param key entry key
* @param path JSON path
* @param delta increment value
* @return the updated value
*/
T incrementAndGet(K key, String path, T delta);
/**
* Increments the current values specified by key and JSONPath.
* Compatible only with enhanced syntax starting with '$' character.
*
* @param key entry key
* @param path JSON path
* @param delta increment value
* @return list of updated value
*/
List incrementAndGetMulti(K key, String path, T delta);
/**
* Merges value into element by the specified key and JSONPath.
*
* @param key entry key
* @param path JSON path
* @param value value to merge
*/
void merge(K key, String path, Object value);
/**
* Returns keys amount in JSON container by specified key
*
* @param key entry key
* @return keys amount
*/
long countKeys(K key);
/**
* Returns keys amount in JSON container specified by key and JSONPath
*
* @param key entry key
* @param path JSON path
* @return keys amount
*/
long countKeys(K key, String path);
/**
* Returns list of keys amount in JSON containers specified by key and JSONPath
*
* @param key entry key
* @param path JSON path
* @return list of keys amount
*/
List countKeysMulti(K key, String path);
/**
* Returns list of keys in JSON container by specified key
*
* @return list of keys
*/
List getKeys(K key);
/**
* Returns list of keys in JSON container by specified key and JSONPath
*
* @param path JSON path
* @return list of keys
*/
List getKeys(K key, String path);
/**
* Returns list of keys in JSON containers by specified key and JSONPath
*
* @param path JSON path
* @return list of keys
*/
List> getKeysMulti(K key, String path);
/**
* Toggle boolean value by specified key and JSONPath
*
* @param path JSON path
* @return new boolean value
*/
boolean toggle(K key, String path);
/**
* Toggle boolean values by specified key and JSONPath
*
* @param path JSON path
* @return list of boolean values
*/
List toggleMulti(K key, String path);
/**
* Returns type of value
*
* @return type of element
*/
JsonType getType(K key);
/**
* Returns type of element specified by key and JSONPath
*
* @param path JSON path
* @return type of element
*/
JsonType getType(K key, String path);
/**
* Deletes entry by specified key
*
* @param key entry key
* @return {@code true} if successful, or {@code false} if
* entry doesn't exist
*/
boolean delete(K key);
/**
* Deletes entries by specified keys
*
* @param keys entry keys
* @return number of deleted elements
*/
long delete(Set keys);
/**
* Deletes JSON elements specified by keys and JSONPath
*
* @param path JSON path
* @param keys entry keys
* @return number of deleted elements
*/
long delete(String path, Set keys);
/**
* Returns size of entry in bytes specified by key.
*
* @param key entry key
* @return entry size
*/
long sizeInMemory(K key);
/**
* Retrieves value by specified key.
*
* @param key entry key
* @return element
*/
V get(K key);
/**
* Retrieves values by specified keys.
*
* @param keys entry keys
* @return map with entries where value mapped by key
*/
Map get(Set keys);
/**
* Retrieves values by specified keys and JSONPath.
*
* @param path JSON path
* @param keys entry keys
* @return map with entries where value mapped by key
*/
Map get(String path, Set keys);
/**
* Retrieves entry value by specified key and removes it.
*
* @param key entry key
* @return element
*/
V getAndDelete(K key);
/**
* Sets value only if entry doesn't exist.
*
* @param key entry key
* @param value value to set
* @return {@code true} if successful, or {@code false} if
* element was already set
*/
boolean setIfAbsent(K key, V value);
/**
* Sets value with defined duration only if entry doesn't exist.
*
* @param key entry key
* @param value value to set
* @param duration expiration duration
* @return {@code true} if successful, or {@code false} if
* element was already set
*/
boolean setIfAbsent(K key, V value, Duration duration);
/**
* Sets value only if entry already exists.
*
* @param key entry key
* @param value value to set
* @return {@code true} if successful, or {@code false} if
* element wasn't set
*/
boolean setIfExists(K key, V value);
/**
* Sets value with expiration duration only if entry already exists.
*
* @param key entry key
* @param value value to set
* @param duration expiration duration
* @return {@code true} if successful, or {@code false} if
* element wasn't set
*/
boolean setIfExists(K key, V value, Duration duration);
/**
* Atomically sets the value to the given updated value
* by specified key only if serialized state of the current value equals
* to serialized state of the expected value.
*
* @param key entry key
* @param expect the expected value
* @param update the new value
* @return {@code true} if successful; or {@code false} if the actual value
* was not equal to the expected value.
*/
boolean compareAndSet(K key, V expect, V update);
/**
* Retrieves current value by specified key and replaces it with new value.
*
* @param key entry key
* @param newValue value to set
* @return previous value
*/
V getAndSet(K key, V newValue);
/**
* Retrieves current value by specified key and replaces it
* with value and defines expiration duration.
*
* @param key entry key
* @param value value to set
* @param duration expiration duration
* @return previous value
*/
V getAndSet(K key, V value, Duration duration);
/**
* Retrieves current value by specified key and sets an expiration duration for it.
*
* Requires Redis 6.2.0 and higher.
*
* @param key entry key
* @param duration of object time to live interval
* @return value
*/
V getAndExpire(K key, Duration duration);
/**
* Retrieves current value by specified key and sets an expiration date for it.
*
* Requires Redis 6.2.0 and higher.
*
* @param key entry key
* @param time of exact object expiration moment
* @return value
*/
V getAndExpire(K key, Instant time);
/**
* Retrieves current value by specified key and clears expiration date set before.
*
* Requires Redis 6.2.0 and higher.
*
* @param key entry key
* @return value
*/
V getAndClearExpire(K key);
/**
* Stores value by specified key.
*
* @param key entry key
* @param value value to set
*/
void set(K key, V value);
/**
* Stores values by specified keys.
*
* @param entries entries to store
*/
void set(Map entries);
/**
* Stores values by specified keys and JSONPath.
*
* @param path JSONPath
* @param entries entries to store
*/
void set(String path, Map entries);
/**
* Stores value by specified key with defined expiration duration.
*
* @param key entry key
* @param value value to set
* @param duration expiration duration
*/
void set(K key, V value, Duration duration);
/**
* Stores values by specified keys with defined expiration duration.
*
* @param entries entries to store
* @param duration expiration duration
*/
void set(Map entries, Duration duration);
/**
* Sets value by specified key and keep existing TTL.
*
* Requires Redis 6.0.0 and higher.
*
* @param value value to set
*/
void setAndKeepTTL(K key, V value);
/**
* Adds object event listener
*
* @see org.redisson.api.ExpiredObjectListener
* @see org.redisson.api.DeletedObjectListener
* @see org.redisson.api.listener.SetObjectListener
*
* @param listener object event listener
* @return listener id
*/
int addListener(ObjectListener listener);
/**
* Remaining time to live of map entry associated with a key.
*
* @param key - map key
* @return time in milliseconds
* -2 if the key does not exist.
* -1 if the key exists but has no associated expire.
*/
long remainTimeToLive(K key);
/**
* Returns key set of this map.
* Keys are loaded in batch. Batch size is 10.
*
* @see #readAllKeySet()
*
* @return key set
*/
Set keySet();
/**
* Returns key set of this map.
* Keys are loaded in batch. Batch size is defined by count param.
*
* @see #readAllKeySet()
*
* @param count - size of keys batch
* @return key set
*/
Set keySet(int count);
/**
* Returns key set of this map.
* If pattern is not null then only keys match this pattern are loaded.
* Keys are loaded in batch. Batch size is defined by count param.
*
* Use org.redisson.client.codec.StringCodec for Map keys.
*
*
* Supported glob-style patterns:
*
* h?llo subscribes to hello, hallo and hxllo
*
* h*llo subscribes to hllo and heeeello
*
* h[ae]llo subscribes to hello and hallo, but not hillo
*
* @see #readAllKeySet()
*
* @param pattern - key pattern
* @param count - size of keys batch
* @return key set
*/
Set keySet(String pattern, int count);
/**
* Returns key set of this map.
* If pattern is not null then only keys match this pattern are loaded.
*
* Use org.redisson.client.codec.StringCodec for Map keys.
*
*
* Supported glob-style patterns:
*
* h?llo subscribes to hello, hallo and hxllo
*
* h*llo subscribes to hllo and heeeello
*
* h[ae]llo subscribes to hello and hallo, but not hillo
*
* @see #readAllKeySet()
*
* @param pattern - key pattern
* @return key set
*/
Set keySet(String pattern);
/**
* Returns true if this map contains map entry
* mapped by specified key, otherwise false
*
* @param key - map key
* @return true if this map contains map entry
* mapped by specified key, otherwise false
*/
boolean containsKey(Object key);
/**
* Read all keys at once
*
* @return keys
*/
Set readAllKeySet();
/**
* Returns entries amount in store
*
* @return entries amount
*/
int size();
/**
* Returns RCountDownLatch instance associated with key
*
* @param key - map key
* @return countdownlatch
*/
RCountDownLatch getCountDownLatch(K key);
/**
* Returns RPermitExpirableSemaphore instance associated with key
*
* @param key - map key
* @return permitExpirableSemaphore
*/
RPermitExpirableSemaphore getPermitExpirableSemaphore(K key);
/**
* Returns RSemaphore instance associated with key
*
* @param key - map key
* @return semaphore
*/
RSemaphore getSemaphore(K key);
/**
* Returns RLock instance associated with key
*
* @param key - map key
* @return fairlock
*/
RLock getFairLock(K key);
/**
* Returns RReadWriteLock instance associated with key
*
* @param key - map key
* @return readWriteLock
*/
RReadWriteLock getReadWriteLock(K key);
/**
* Returns RLock instance associated with key
*
* @param key - map key
* @return lock
*/
RLock getLock(K key);
}