Package dev.voidframework.redis

Interface Redis

All Known Implementing Classes:
DefaultRedis
public interface Redis
Redis service give access to methods to easily use a Redis database.
Since:
1.1.0

  • Method Summary

    Modifier and Type
    Method
    Description
    <T> long
    addInList(String key, com.fasterxml.jackson.core.type.TypeReference<T> typeReference, Object value)
    Adds a value in a list.
    <T> long
    addInList(String key, com.fasterxml.jackson.core.type.TypeReference<T> typeReference, Object value, int maxItem)
    Adds a value in a list.
    long
    addInList(String key, com.fasterxml.jackson.databind.JavaType javaType, Object value)
    Adds a value in a list.
    long
    addInList(String key, com.fasterxml.jackson.databind.JavaType javaType, Object value, int maxItem)
    Adds a value in a list.
    <T> long
    addInList(String key, Class<T> clazz, T value)
    Adds a value in a list.
    <T> long
    addInList(String key, Class<T> clazz, T value, int maxItem)
    Adds a value in a list.
    long
    decrement(String key)
    Decrements a number value.
    long
    decrement(String key, int expiration)
    Decrements a number value.
    boolean
    exists(String key)
    Checks if key is present on Redis database.
    <T> T
    get(String key, com.fasterxml.jackson.core.type.TypeReference<T> typeReference)
    Retrieves an object by key.
    <T> T
    get(String key, com.fasterxml.jackson.databind.JavaType javaType)
    Retrieves an object by key.
    <T> T
    get(String key, Class<T> clazz)
    Retrieves an object by key.
    redis.clients.jedis.Jedis
    getConnection()
    Gets a Redis connection from the pool.
    redis.clients.jedis.Jedis
    getConnection(int db)
    Gets a Redis connection from the pool pre-configured with the right database.
    <T> List<T>
    getFromList(String key, com.fasterxml.jackson.core.type.TypeReference<T> typeReference)
    Gets values from a list.
    <T> List<T>
    getFromList(String key, com.fasterxml.jackson.core.type.TypeReference<T> typeReference, int offset, int count)
    Gets values from a list.
    <T> List<T>
    getFromList(String key, com.fasterxml.jackson.databind.JavaType javaType)
    Gets values from a list.
    <T> List<T>
    getFromList(String key, com.fasterxml.jackson.databind.JavaType javaType, int offset, int count)
    Gets values from a list.
    <T> List<T>
    getFromList(String key, Class<T> clazz)
    Gets values from a list.
    <T> List<T>
    getFromList(String key, Class<T> clazz, int offset, int count)
    Gets values from a list.
    <T> T
    getOrElse(String key, com.fasterxml.jackson.core.type.TypeReference<T> typeReference, Callable<T> block)
    Retrieves a value from the cache, or set it from a default Callable function.
    <T> T
    getOrElse(String key, com.fasterxml.jackson.core.type.TypeReference<T> typeReference, Callable<T> block, int expiration)
    Retrieves a value from the cache, or set it from a default Callable function.
    <T> T
    getOrElse(String key, com.fasterxml.jackson.databind.JavaType javaType, Callable<T> block)
    Retrieves a value from the cache, or set it from a default Callable function.
    <T> T
    getOrElse(String key, com.fasterxml.jackson.databind.JavaType javaType, Callable<T> block, int expiration)
    Retrieves a value from the cache, or set it from a default Callable function.
    <T> T
    getOrElse(String key, Class<T> clazz, Callable<T> block)
    Retrieves a value from the cache, or set it from a default Callable function.
    <T> T
    getOrElse(String key, Class<T> clazz, Callable<T> block, int expiration)
    Retrieves a value from the cache, or set it from a default Callable function.
    long
    increment(String key)
    Increments an integer value.
    long
    increment(String key, int expiration)
    Increments a number value.
    void
    remove(String key)
    Removes a value from the cache.
    void
    remove(String... keys)
    Removes a value from the cache.
    <T> void
    set(String key, com.fasterxml.jackson.core.type.TypeReference<T> typeReference, T value)
    Sets a value without expiration.
    <T> void
    set(String key, com.fasterxml.jackson.core.type.TypeReference<T> typeReference, T value, int expiration)
    Sets a value with expiration.
    void
    set(String key, com.fasterxml.jackson.databind.JavaType javaType, Object value)
    Sets a value without expiration.
    void
    set(String key, com.fasterxml.jackson.databind.JavaType javaType, Object value, int expiration)
    Sets a value with expiration.
    <T> void
    set(String key, Class<T> clazz, T value)
    Sets a value without expiration.
    <T> void
    set(String key, Class<T> clazz, T value, int expiration)
    Sets a value with expiration.
    boolean
    tryLock(String key, int expiration)
    Tries to acquire a lock.

  • Method Details

    • getConnection

      redis.clients.jedis.Jedis getConnection()
      Gets a Redis connection from the pool.
      Returns:
      A Redis connection
      Since:
      1.1.0

    • getConnection

      redis.clients.jedis.Jedis getConnection(int db)
      Gets a Redis connection from the pool pre-configured with the right database. If the database number is under zero, the database "zero" will be selected.
      Parameters:
      db - The database number to use
      Returns:
      A Redis connection
      Since:
      1.1.0

    • get

      <T> T get(String key, com.fasterxml.jackson.core.type.TypeReference<T> typeReference)
      Retrieves an object by key.
      Type Parameters:
      T - Generic type of something
      Parameters:
      key - Item key
      typeReference - The object type reference
      Returns:
      object or null
      Since:
      1.1.0

    • get

      <T> T get(String key, Class<T> clazz)
      Retrieves an object by key.
      Type Parameters:
      T - Generic type of something
      Parameters:
      key - Item key
      clazz - The object class
      Returns:
      object or null
      Since:
      1.1.0

    • get

      <T> T get(String key, com.fasterxml.jackson.databind.JavaType javaType)
      Retrieves an object by key.
      Type Parameters:
      T - Generic type of something
      Parameters:
      key - Item key
      javaType - The object java type
      Returns:
      object or null
      Since:
      1.1.0

    • set

      <T> void set(String key, com.fasterxml.jackson.core.type.TypeReference<T> typeReference, T value)
      Sets a value without expiration.
      Type Parameters:
      T - Generic type of something
      Parameters:
      key - Item key
      typeReference - The object type reference
      value - The value to set
      Since:
      1.1.0

    • set

      <T> void set(String key, com.fasterxml.jackson.core.type.TypeReference<T> typeReference, T value, int expiration)
      Sets a value with expiration.
      Type Parameters:
      T - Generic type of something
      Parameters:
      key - Item key
      typeReference - The object type reference
      value - The value to set
      expiration - expiration in seconds
      Since:
      1.1.0

    • set

      <T> void set(String key, Class<T> clazz, T value)
      Sets a value without expiration.
      Type Parameters:
      T - Generic type of something
      Parameters:
      key - Item key
      clazz - The object class
      value - The value to set
      Since:
      1.1.0

    • set

      <T> void set(String key, Class<T> clazz, T value, int expiration)
      Sets a value with expiration.
      Type Parameters:
      T - Generic type of something
      Parameters:
      key - Item key
      clazz - The object class
      value - The value to set
      expiration - expiration in seconds
      Since:
      1.1.0

    • set

      void set(String key, com.fasterxml.jackson.databind.JavaType javaType, Object value)
      Sets a value without expiration.
      Parameters:
      key - Item key
      javaType - The object java type
      value - The value to set
      Since:
      1.1.0

    • set

      void set(String key, com.fasterxml.jackson.databind.JavaType javaType, Object value, int expiration)
      Sets a value with expiration.
      Parameters:
      key - Item key
      javaType - The object java type
      value - The value to set
      expiration - expiration in seconds
      Since:
      1.1.0

    • getOrElse

      <T> T getOrElse(String key, com.fasterxml.jackson.core.type.TypeReference<T> typeReference, Callable<T> block)
      Retrieves a value from the cache, or set it from a default Callable function. The value has no expiration.
      Type Parameters:
      T - Generic type of something
      Parameters:
      key - Item key
      typeReference - The object type reference
      block - block returning value to set if key does not exist
      Returns:
      value
      Since:
      1.1.0

    • getOrElse

      <T> T getOrElse(String key, com.fasterxml.jackson.core.type.TypeReference<T> typeReference, Callable<T> block, int expiration)
      Retrieves a value from the cache, or set it from a default Callable function.
      Type Parameters:
      T - Generic type of something implementing java.io.Serializable
      Parameters:
      key - Item key
      typeReference - The object type reference
      block - block returning value to set if key does not exist
      expiration - expiration period in seconds
      Returns:
      value
      Since:
      1.1.0

    • getOrElse

      <T> T getOrElse(String key, Class<T> clazz, Callable<T> block)
      Retrieves a value from the cache, or set it from a default Callable function. The value has no expiration.
      Type Parameters:
      T - Generic type of something
      Parameters:
      key - Item key
      clazz - The object class
      block - block returning value to set if key does not exist
      Returns:
      value
      Since:
      1.1.0

    • getOrElse

      <T> T getOrElse(String key, Class<T> clazz, Callable<T> block, int expiration)
      Retrieves a value from the cache, or set it from a default Callable function.
      Type Parameters:
      T - Generic type of something implementing java.io.Serializable
      Parameters:
      key - Item key
      clazz - The object class
      block - block returning value to set if key does not exist
      expiration - expiration period in seconds
      Returns:
      value
      Since:
      1.1.0

    • getOrElse

      <T> T getOrElse(String key, com.fasterxml.jackson.databind.JavaType javaType, Callable<T> block)
      Retrieves a value from the cache, or set it from a default Callable function. The value has no expiration.
      Type Parameters:
      T - Generic type of something
      Parameters:
      key - Item key
      javaType - The object java type
      block - block returning value to set if key does not exist
      Returns:
      value
      Since:
      1.1.0

    • getOrElse

      <T> T getOrElse(String key, com.fasterxml.jackson.databind.JavaType javaType, Callable<T> block, int expiration)
      Retrieves a value from the cache, or set it from a default Callable function.
      Type Parameters:
      T - Generic type of something implementing java.io.Serializable
      Parameters:
      key - Item key
      javaType - The object java type
      block - block returning value to set if key does not exist
      expiration - expiration period in seconds
      Returns:
      value
      Since:
      1.1.0

    • remove

      void remove(String key)
      Removes a value from the cache.
      Parameters:
      key - The key to remove the value for
      Since:
      1.1.0

    • remove

      void remove(String... keys)
      Removes a value from the cache.
      Parameters:
      keys - Keys to remove from redis
      Since:
      1.1.0

    • exists

      boolean exists(String key)
      Checks if key is present on Redis database.
      Parameters:
      key - The key to test
      Returns:
      true if the key is present on Redis database
      Since:
      1.1.0

    • addInList

      <T> long addInList(String key, com.fasterxml.jackson.core.type.TypeReference<T> typeReference, Object value)
      Adds a value in a list.
      Type Parameters:
      T - Generic type of something implementing java.io.Serializable
      Parameters:
      key - The list key
      typeReference - The object type reference
      value - The value to add in the list
      Returns:
      The list size
      Since:
      1.1.0

    • addInList

      <T> long addInList(String key, com.fasterxml.jackson.core.type.TypeReference<T> typeReference, Object value, int maxItem)
      Adds a value in a list.
      Type Parameters:
      T - Generic type of something implementing java.io.Serializable
      Parameters:
      key - The list key
      typeReference - The object type reference
      value - The value to add in the list
      maxItem - The number of entries to keep in list
      Returns:
      The list size
      Since:
      1.1.0

    • addInList

      <T> long addInList(String key, Class<T> clazz, T value)
      Adds a value in a list.
      Type Parameters:
      T - Generic type of something implementing java.io.Serializable
      Parameters:
      key - The list key
      clazz - The object class
      value - The value to add in the list
      Returns:
      The list size
      Since:
      1.1.0

    • addInList

      <T> long addInList(String key, Class<T> clazz, T value, int maxItem)
      Adds a value in a list.
      Type Parameters:
      T - Generic type of something implementing java.io.Serializable
      Parameters:
      key - The list key
      clazz - The object class
      value - The value to add in the list
      maxItem - The number of entries to keep in list
      Returns:
      The list size
      Since:
      1.1.0

    • addInList

      long addInList(String key, com.fasterxml.jackson.databind.JavaType javaType, Object value)
      Adds a value in a list.
      Parameters:
      key - The list key
      javaType - The object java type
      value - The value to add in the list
      Returns:
      The list size
      Since:
      1.1.0

    • addInList

      long addInList(String key, com.fasterxml.jackson.databind.JavaType javaType, Object value, int maxItem)
      Adds a value in a list.
      Parameters:
      key - The list key
      javaType - The object java type
      value - The value to add in the list
      maxItem - The number of entries to keep in list
      Returns:
      The list size
      Since:
      1.1.0

    • getFromList

      <T> List<T> getFromList(String key, com.fasterxml.jackson.core.type.TypeReference<T> typeReference)
      Gets values from a list.
      Type Parameters:
      T - Generic type of something implementing java.io.Serializable
      Parameters:
      key - The list key
      typeReference - The object type reference
      Returns:
      The values list
      Since:
      1.1.0

    • getFromList

      <T> List<T> getFromList(String key, com.fasterxml.jackson.core.type.TypeReference<T> typeReference, int offset, int count)
      Gets values from a list.
      Type Parameters:
      T - Generic type of something implementing java.io.Serializable
      Parameters:
      key - The list key
      typeReference - The object type reference
      offset - From where
      count - The number of items to retrieve
      Returns:
      The values list
      Since:
      1.1.0

    • getFromList

      <T> List<T> getFromList(String key, Class<T> clazz)
      Gets values from a list.
      Type Parameters:
      T - Generic type of something implementing java.io.Serializable
      Parameters:
      key - The list key
      clazz - The object class
      Returns:
      The values list
      Since:
      1.1.0

    • getFromList

      <T> List<T> getFromList(String key, Class<T> clazz, int offset, int count)
      Gets values from a list.
      Type Parameters:
      T - Generic type of something implementing java.io.Serializable
      Parameters:
      key - The list key
      clazz - The object class
      offset - From where
      count - The number of items to retrieve
      Returns:
      The values list
      Since:
      1.1.0

    • getFromList

      <T> List<T> getFromList(String key, com.fasterxml.jackson.databind.JavaType javaType)
      Gets values from a list.
      Type Parameters:
      T - Generic type of something implementing java.io.Serializable
      Parameters:
      key - The list key
      javaType - The object java type
      Returns:
      The values list
      Since:
      1.1.0

    • getFromList

      <T> List<T> getFromList(String key, com.fasterxml.jackson.databind.JavaType javaType, int offset, int count)
      Gets values from a list.
      Type Parameters:
      T - Generic type of something implementing java.io.Serializable
      Parameters:
      key - The list key
      javaType - The object java type
      offset - From where
      count - The number of items to retrieve
      Returns:
      The values list
      Since:
      1.1.0

    • tryLock

      boolean tryLock(String key, int expiration)
      Tries to acquire a lock. This method will return false if it can't acquire lock or can't connect to Redis server.
      Parameters:
      key - The lock key
      expiration - The lock TTL
      Returns:
      true in case of success, otherwise, false
      Since:
      1.1.0

    • decrement

      long decrement(String key, int expiration)
      Decrements a number value. If key does not exist, it will be created automatically. Expiration is set only when the key is created.
      Parameters:
      key - The value key
      expiration - The value TTL
      Returns:
      The decremented value
      Since:
      1.1.0

    • decrement

      long decrement(String key)
      Decrements a number value. If key does not exist, it will be created automatically.
      Parameters:
      key - The value key
      Returns:
      The decremented value
      Since:
      1.1.0

    • increment

      long increment(String key)
      Increments an integer value. If key does not exist, it will be created automatically.
      Parameters:
      key - The value key
      Returns:
      The incremented value
      Since:
      1.1.0

    • increment

      long increment(String key, int expiration)
      Increments a number value. If key does not exist, it will be created automatically. Expiration is set only when the key is created.
      Parameters:
      key - The value key
      expiration - The value TTL
      Returns:
      The incremented value
      Since:
      1.1.0