RedisFacade (session-replacement 0.4.7 API)

```
public interface RedisFacade
```
This interface offers subset of redis.clients.jedis.BinaryJedisCommands. The subset offers commands used by redis session repository implementation.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`RedisFacade.RedisPubSub` Used to implement PUBSUB mechanism.
`static interface`	`RedisFacade.ResponseFacade<T>` Used to wrap implementation's response for transactions.
`static interface`	`RedisFacade.TransactionFacade` Used to encapsulate redis library's transaction (MULTI) processing.
`static interface`	`RedisFacade.TransactionRunner<T>` Implementation of this interface can be run within a redis transaction.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()` Closes connections to redis.
`Long`	`del(byte[]... keys)` See redis.clients.jedis.BinaryJedisCommands#del(byte[]...)
`Boolean`	`exists(byte[] key)` See redis.clients.jedis.BinaryJedisCommands#exists(byte[])
`Long`	`expire(byte[] key, int value)` See redis.clients.jedis.BinaryJedisCommands#expire(byte[], int)
`Long`	`expireAt(byte[] key, long unixTime)` See redis.clients.jedis.BinaryJedisCommands#expireAt(byte[], long)
`byte[]`	`get(byte[] key)` See redis.clients.jedis.BinaryJedisCommands#get(byte[])
`Long`	`hdel(byte[] key, byte[]... fields)` See redis.clients.jedis.BinaryJedisCommands#hdel(byte[], byte[]...)
`Set<byte[]>`	`hkeys(byte[] key)` See redis.clients.jedis.BinaryJedisCommands#hkeys(byte[])
`List<byte[]>`	`hmget(byte[] key, byte[]... fields)` See redis.clients.jedis.BinaryJedisCommands#hmget(byte[], byte[]...)
`String`	`hmset(byte[] key, Map<byte[],byte[]> hash)` See redis.clients.jedis.BinaryJedisCommands#hmset(byte[], Map)
`Long`	`hset(byte[] key, byte[] field, byte[] value)` See redis.clients.jedis.BinaryJedisCommands#hset(byte[], byte[], byte[])
`Long`	`hsetnx(byte[] key, byte[] field, byte[] value)` See redis.clients.jedis.BinaryJedisCommands#hsetnx(byte[], byte[], byte[])
`String`	`info(String section)` Returns information about server
`boolean`	`isRedisException(Exception e)` Returns `true` if exception was thrown by redis library
`Long`	`persist(byte[] key)` See redis.clients.jedis.BinaryJedisCommands#persist(byte[])
`void`	`psubscribe(RedisFacade.RedisPubSub listener, String pattern)` See BinaryJedisCommands#psubscribe(BinaryJedisPubSub, byte[]...)
`Long`	`publish(byte[] channel, byte[] message)` See redis.clients.jedis.BinaryJedisCommands#publish(byte[], byte[])
`void`	`punsubscribe(RedisFacade.RedisPubSub expirationListener, byte[] pattern)` See BinaryJedisPubSub#punsubscribe(byte[]...)
`String`	`rename(byte[] oldkey, byte[] newkey)` See redis.clients.jedis.BinaryJedisCommands#rename(byte[], byte[])
`void`	`requestFinished()` Dissociates jedis connection from the current thread and returns it to the pool.
`Long`	`sadd(byte[] key, byte[]... member)` See redis.clients.jedis.BinaryJedisCommands#sadd(byte[], byte[]...)
`String`	`set(byte[] key, byte[] value)` See redis.clients.jedis.BinaryJedisCommands#set(byte[], byte[])
`String`	`setex(byte[] key, int expiry, byte[] value)` See redis.clients.jedis.BinaryJedisCommands#setx(byte[], int, byte[])
`Set<byte[]>`	`smembers(byte[] key)` See redis.clients.jedis.BinaryJedisCommands#smembers(byte[])
`Set<byte[]>`	`spop(byte[] key, long count)` See redis.clients.jedis.BinaryJedisCommands#spop(byte[], long)
`void`	`srem(byte[] key, byte[]... member)` See redis.clients.jedis.BinaryJedisCommands#srem(byte[], byte[]...)
`void`	`startMonitoring(com.codahale.metrics.MetricRegistry metrics)` Starts monitoring Redis interaction.
`boolean`	`supportsMultiSpop()` Returns true if redis implementation supports SPOP that returns multiple elements (http://redis.io/commands/spop).
`<T> RedisFacade.ResponseFacade<T>`	`transaction(byte[] key, RedisFacade.TransactionRunner<T> transaction)` Executes redis transaction associated to a key.
`Long`	`zadd(byte[] key, double score, byte[] elem)` See redis.clients.jedis.BinaryJedisCommands#zadd(byte[], byte[]...)
`Set<byte[]>`	`zrange(byte[] key, long start, long end)` See redis.clients.jedis.BinaryJedisCommands#zrange(byte[], long, long)
`Set<byte[]>`	`zrangeByScore(byte[] key, double start, double end)` See redis.clients.jedis.BinaryJedisCommands#zrangeByScore(byte[], double, double)
`Long`	`zrem(byte[] key, byte[]... fields)` See redis.clients.jedis.BinaryJedisCommands#zrem(byte[], byte[]...)

- Method Detail
  - psubscribe
```
void psubscribe(RedisFacade.RedisPubSub listener,
                String pattern)
```
    See BinaryJedisCommands#psubscribe(BinaryJedisPubSub, byte[]...)
    
    Parameters:
    
    listener -
    
    pattern -
  - punsubscribe
```
void punsubscribe(RedisFacade.RedisPubSub expirationListener,
                  byte[] pattern)
```
    See BinaryJedisPubSub#punsubscribe(byte[]...)
    
    Parameters:
    
    expirationListener -
    
    pattern -
  - hdel
```
Long hdel(byte[] key,
          byte[]... fields)
```
    See redis.clients.jedis.BinaryJedisCommands#hdel(byte[], byte[]...)
    
    Parameters:
    
    key - key as byte array
    
    fields -
    
    Returns:
    
    If the field was present in the hash it is deleted and 1 is returned, otherwise 0 is returned and no operation is performed.
  - hmget
```
List<byte[]> hmget(byte[] key,
                   byte[]... fields)
```
    See redis.clients.jedis.BinaryJedisCommands#hmget(byte[], byte[]...)
    
    Parameters:
    
    key - key as byte array
    
    fields -
    
    Returns:
    
    list of retrieved values
  - hmset
```
String hmset(byte[] key,
             Map<byte[],byte[]> hash)
```
    See redis.clients.jedis.BinaryJedisCommands#hmset(byte[], Map)
    
    Parameters:
    
    key - key as byte array
    
    hash - map of fields to modify
    
    Returns:
    
    status of the operation
  - hsetnx
```
Long hsetnx(byte[] key,
            byte[] field,
            byte[] value)
```
    See redis.clients.jedis.BinaryJedisCommands#hsetnx(byte[], byte[], byte[])
    
    Parameters:
    
    key - key as byte array
    
    field - field to modify
    
    value - value of the field
    
    Returns:
    
    status of the operation
  - hset
```
Long hset(byte[] key,
          byte[] field,
          byte[] value)
```
    See redis.clients.jedis.BinaryJedisCommands#hset(byte[], byte[], byte[])
    
    Parameters:
    
    key - key as byte array
    
    field -
    
    value -
    
    Returns:
    
    status of the operation
  - hkeys
```
Set<byte[]> hkeys(byte[] key)
```
    See redis.clients.jedis.BinaryJedisCommands#hkeys(byte[])
    
    Parameters:
    
    key - key as byte array
    
    Returns:
  - set
```
String set(byte[] key,
           byte[] value)
```
    See redis.clients.jedis.BinaryJedisCommands#set(byte[], byte[])
    
    Parameters:
    
    key - key as byte array
    
    value -
    
    Returns:
  - setex
```
String setex(byte[] key,
             int expiry,
             byte[] value)
```
    See redis.clients.jedis.BinaryJedisCommands#setx(byte[], int, byte[])
    
    Parameters:
    
    key - key as byte array
    
    expiry -
    
    value -
    
    Returns:
  - expire
```
Long expire(byte[] key,
            int value)
```
    See redis.clients.jedis.BinaryJedisCommands#expire(byte[], int)
    
    Parameters:
    
    key - key as byte array
    
    value -
    
    Returns:
  - srem
```
void srem(byte[] key,
          byte[]... member)
```
    See redis.clients.jedis.BinaryJedisCommands#srem(byte[], byte[]...)
    
    Parameters:
    
    key - key as byte array
    
    member -
  - sadd
```
Long sadd(byte[] key,
          byte[]... member)
```
    See redis.clients.jedis.BinaryJedisCommands#sadd(byte[], byte[]...)
    
    Parameters:
    
    key - key as byte array
    
    member -
    
    Returns:
  - del
```
Long del(byte[]... keys)
```
    See redis.clients.jedis.BinaryJedisCommands#del(byte[]...)
    
    Parameters:
    
    keys - key as byte arrays
    
    Returns:
  - exists
```
Boolean exists(byte[] key)
```
    See redis.clients.jedis.BinaryJedisCommands#exists(byte[])
    
    Parameters:
    
    key - key as byte array
    
    Returns:
  - smembers
```
Set<byte[]> smembers(byte[] key)
```
    See redis.clients.jedis.BinaryJedisCommands#smembers(byte[])
    
    Parameters:
    
    key - key as byte array
    
    Returns:
  - spop
```
Set<byte[]> spop(byte[] key,
                 long count)
```
    See redis.clients.jedis.BinaryJedisCommands#spop(byte[], long)
    
    Parameters:
    
    key - key as byte array
    
    count -
    
    Returns:
  - expireAt
```
Long expireAt(byte[] key,
              long unixTime)
```
    See redis.clients.jedis.BinaryJedisCommands#expireAt(byte[], long)
    
    Parameters:
    
    key - key as byte array
    
    unixTime -
    
    Returns:
  - zadd
```
Long zadd(byte[] key,
          double score,
          byte[] elem)
```
    See redis.clients.jedis.BinaryJedisCommands#zadd(byte[], byte[]...)
    
    Parameters:
    
    key - key as byte array
    
    score -
    
    elem -
    
    Returns:
  - zrem
```
Long zrem(byte[] key,
          byte[]... fields)
```
    See redis.clients.jedis.BinaryJedisCommands#zrem(byte[], byte[]...)
    
    Parameters:
    
    key - key as byte array
    
    fields -
    
    Returns:
  - zrangeByScore
```
Set<byte[]> zrangeByScore(byte[] key,
                          double start,
                          double end)
```
    See redis.clients.jedis.BinaryJedisCommands#zrangeByScore(byte[], double, double)
    
    Parameters:
    
    key - key as byte array
    
    start -
    
    end -
    
    Returns:
  - zrange
```
Set<byte[]> zrange(byte[] key,
                   long start,
                   long end)
```
    See redis.clients.jedis.BinaryJedisCommands#zrange(byte[], long, long)
    
    Parameters:
    
    key - key as byte array
    
    start -
    
    end -
    
    Returns:
  - persist
```
Long persist(byte[] key)
```
    See redis.clients.jedis.BinaryJedisCommands#persist(byte[])
    
    Parameters:
    
    key - key as byte array
    
    Returns:
  - rename
```
String rename(byte[] oldkey,
              byte[] newkey)
```
    See redis.clients.jedis.BinaryJedisCommands#rename(byte[], byte[])
    
    Parameters:
    
    oldkey -
    
    newkey -
    
    Returns:
  - info
```
String info(String section)
```
    Returns information about server
    
    Parameters:
    
    section -
    
    Returns:
  - supportsMultiSpop
```
boolean supportsMultiSpop()
```
    Returns true if redis implementation supports SPOP that returns multiple elements (http://redis.io/commands/spop). This is command is supported in redis v3.2 and later.
    
    Returns:
    
    true if SPOP with multiple results is supported
  - requestFinished
```
void requestFinished()
```
    Dissociates jedis connection from the current thread and returns it to the pool.
  - close
```
void close()
```
    Closes connections to redis.
  - get
```
byte[] get(byte[] key)
```
    See redis.clients.jedis.BinaryJedisCommands#get(byte[])
    
    Parameters:
    
    key - key as byte array
    
    Returns:
  - publish
```
Long publish(byte[] channel,
             byte[] message)
```
    See redis.clients.jedis.BinaryJedisCommands#publish(byte[], byte[])
    
    Parameters:
    
    channel -
    
    message -
    
    Returns:
  - startMonitoring
```
void startMonitoring(com.codahale.metrics.MetricRegistry metrics)
```
    Starts monitoring Redis interaction. This method can be used to add metrics to metric registry.
    
    Parameters:
    
    metrics -
  - isRedisException
```
boolean isRedisException(Exception e)
```
    Returns true if exception was thrown by redis library
    
    Parameters:
    
    e - the exception to check
    
    Returns:
    
    true if exception was thrown by redis library
  - transaction
```
<T> RedisFacade.ResponseFacade<T> transaction(byte[] key,
                                              RedisFacade.TransactionRunner<T> transaction)
```
    Executes redis transaction associated to a key. When using cluster, key must be provided as the transaction is linked to a single slot.
    
    Parameters:
    
    key - key as byte array used when performing transaction on cluster to fix the node where transaction occurs.
    
    transaction - the implementation of transaction
    
    Returns:
    
    result of transaction

Interface RedisFacade

Nested Class Summary

Method Summary

Method Detail

psubscribe

punsubscribe

hdel

hmget

hmset

hsetnx

hset

hkeys

set

setex

expire

srem

sadd

del

exists

smembers

spop

expireAt

zadd

zrem

zrangeByScore

zrange

persist

rename

info

supportsMultiSpop

requestFinished

close

get

publish

startMonitoring

isRedisException

transaction