RedisURI (Lettuce 5.3.4.RELEASE API)

java.lang.Object
- io.lettuce.core.RedisURI

All Implemented Interfaces:

ConnectionPoint, Serializable
```
public class RedisURI
extends Object
implements Serializable, ConnectionPoint
```
Redis URI. Contains connection details for the Redis/Sentinel connections. You can provide the database, client name, password and timeouts within the RedisURI. You have the following possibilities to create a RedisURI:
- Use an URI:
  RedisURI.create("redis://localhost/");
  See create(String) for more options
- Use the Builder:
  RedisURI.Builder.redis("localhost", 6379).withPassword("password").withDatabase(1).build();
  See RedisURI.Builder.redis(String) and RedisURI.Builder.sentinel(String) for more options.
- Construct your own instance:
  new RedisURI("localhost", 6379, 60, TimeUnit.SECONDS);
  or
  RedisURI uri = new RedisURI(); uri.setHost("localhost");
URI syntax
Redis Standalone
redis://[[email protected]]host [: port][/database][? [timeout=timeout[d|h|m|s|ms|us|ns]] [ &database=database] [&clientName=clientName]]
Redis Standalone (SSL)
rediss://[[email protected]]host [: port][/database][? [timeout=timeout[d|h|m|s|ms|us|ns]] [ &database=database] [&clientName=clientName]]
Redis Standalone (Unix Domain Sockets)
redis-socket:// [[email protected]]path[ ?[timeout=timeout[d|h|m|s|ms|us|ns]][&database=database] [&clientName=clientName]]
Redis Sentinel
redis-sentinel://[[email protected]]host1 [: port1][, host2 [:port2]][, hostN [:portN]][/ database][? [timeout=timeout[d|h|m|s|ms|us|ns]] [ &sentinelMasterId=sentinelMasterId] [&database=database] [&clientName=clientName]]

Note: When using Redis Sentinel, the password from the URI applies to the data nodes only. Sentinel authentication must be configured for each sentinel node.

Schemes
- redis Redis Standalone
- rediss Redis Standalone SSL
- redis-socket Redis Standalone Unix Domain Socket
- redis-sentinel Redis Sentinel
- rediss-sentinel Redis Sentinel SSL
Timeout units
- d Days
- h Hours
- m Minutes
- s Seconds
- ms Milliseconds
- us Microseconds
- ns Nanoseconds
Hint: The database parameter within the query part has higher precedence than the database in the path.
RedisURI supports Redis Standalone, Redis Sentinel and Redis Cluster with plain, SSL, TLS and unix domain socket connections.
Since:

3.0

Author:

Mark Paluch

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RedisURI.Builder
Builder for Redis URI.

Nested Classes
Modifier and Type	Class and Description
`static class`	`RedisURI.Builder` Builder for Redis URI.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_REDIS_PORT` The default redis port.
`static int`	`DEFAULT_SENTINEL_PORT` The default sentinel port.
`static long`	`DEFAULT_TIMEOUT` Default timeout: 60 sec
`static Duration`	`DEFAULT_TIMEOUT_DURATION`
`static TimeUnit`	`DEFAULT_TIMEOUT_UNIT`
`static String`	`PARAMETER_NAME_CLIENT_NAME`
`static String`	`PARAMETER_NAME_DATABASE`
`static String`	`PARAMETER_NAME_DATABASE_ALT`
`static String`	`PARAMETER_NAME_SENTINEL_MASTER_ID`
`static String`	`PARAMETER_NAME_TIMEOUT`
`static Map<String,TimeUnit>`	`TIME_UNIT_MAP`
`static String`	`URI_SCHEME_REDIS`
`static String`	`URI_SCHEME_REDIS_SECURE`
`static String`	`URI_SCHEME_REDIS_SECURE_ALT`
`static String`	`URI_SCHEME_REDIS_SENTINEL`
`static String`	`URI_SCHEME_REDIS_SENTINEL_SECURE`
`static String`	`URI_SCHEME_REDIS_SOCKET`
`static String`	`URI_SCHEME_REDIS_SOCKET_ALT`
`static String`	`URI_SCHEME_REDIS_TLS_ALT`

Constructor Summary

Constructors
Constructor and Description
`RedisURI()` Default empty constructor.
`RedisURI(String host, int port, Duration timeout)` Constructor with host/port and timeout.
`RedisURI(String host, int port, long timeout, TimeUnit unit)` Deprecated. since 5.0, use `RedisURI(String, int, Duration)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static RedisURI.Builder`	`builder()` Returns a new `RedisURI.Builder` to construct a `RedisURI`.
`static RedisURI`	`create(String uri)` Create a Redis URI from an URI string.
`static RedisURI`	`create(String host, int port)` Create a Redis URI from host and port.
`static RedisURI`	`create(URI uri)` Create a Redis URI from an URI string: The uri must follow conventions of `URI`
`boolean`	`equals(Object o)`
`String`	`getClientName()` Returns the client name.
`int`	`getDatabase()` Returns the Redis database number.
`String`	`getHost()` Returns the host.
`char[]`	`getPassword()` Returns the password.
`int`	`getPort()` Returns the Redis port.
`SocketAddress`	`getResolvedAddress()` Deprecated. since 5.2. Will be removed with 6.0. Use `SocketAddressResolver.resolve(RedisURI)`.
`String`	`getSentinelMasterId()` Returns the Sentinel Master Id.
`List<RedisURI>`	`getSentinels()`
`String`	`getSocket()` Returns the Unix Domain Socket path.
`Duration`	`getTimeout()` Returns the command timeout for synchronous command execution.
`int`	`hashCode()`
`boolean`	`isSsl()` Returns `true` if SSL mode is enabled.
`boolean`	`isStartTls()` Returns `true` if StartTLS is enabled.
`boolean`	`isVerifyPeer()` Sets whether to verify peers when using `SSL`.
`void`	`setClientName(String clientName)` Sets the client name to be applied on Redis connections.
`void`	`setDatabase(int database)` Sets the Redis database number.
`void`	`setHost(String host)` Sets the Redis host.
`void`	`setPassword(char[] password)` Sets the password.
`void`	`setPassword(CharSequence password)` Sets the password.
`void`	`setPassword(String password)` Sets the password.
`void`	`setPort(int port)` Sets the Redis port.
`void`	`setSentinelMasterId(String sentinelMasterId)` Sets the Sentinel Master Id.
`void`	`setSocket(String socket)` Sets the Unix Domain Socket path.
`void`	`setSsl(boolean ssl)` Sets whether to use SSL.
`void`	`setStartTls(boolean startTls)` Returns whether StartTLS is enabled.
`void`	`setTimeout(Duration timeout)` Sets the command timeout for synchronous command execution.
`void`	`setVerifyPeer(boolean verifyPeer)` Sets whether to verify peers when using `SSL`.
`String`	`toString()`
`URI`	`toURI()` Creates an URI based on the RedisURI.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - URI_SCHEME_REDIS_SENTINEL
```
public static final String URI_SCHEME_REDIS_SENTINEL
```
    See Also:
    
    Constant Field Values
  - URI_SCHEME_REDIS_SENTINEL_SECURE
```
public static final String URI_SCHEME_REDIS_SENTINEL_SECURE
```
    See Also:
    
    Constant Field Values
  - URI_SCHEME_REDIS
```
public static final String URI_SCHEME_REDIS
```
    See Also:
    
    Constant Field Values
  - URI_SCHEME_REDIS_SECURE
```
public static final String URI_SCHEME_REDIS_SECURE
```
    See Also:
    
    Constant Field Values
  - URI_SCHEME_REDIS_SECURE_ALT
```
public static final String URI_SCHEME_REDIS_SECURE_ALT
```
    See Also:
    
    Constant Field Values
  - URI_SCHEME_REDIS_TLS_ALT
```
public static final String URI_SCHEME_REDIS_TLS_ALT
```
    See Also:
    
    Constant Field Values
  - URI_SCHEME_REDIS_SOCKET
```
public static final String URI_SCHEME_REDIS_SOCKET
```
    See Also:
    
    Constant Field Values
  - URI_SCHEME_REDIS_SOCKET_ALT
```
public static final String URI_SCHEME_REDIS_SOCKET_ALT
```
    See Also:
    
    Constant Field Values
  - PARAMETER_NAME_TIMEOUT
```
public static final String PARAMETER_NAME_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - PARAMETER_NAME_DATABASE
```
public static final String PARAMETER_NAME_DATABASE
```
    See Also:
    
    Constant Field Values
  - PARAMETER_NAME_DATABASE_ALT
```
public static final String PARAMETER_NAME_DATABASE_ALT
```
    See Also:
    
    Constant Field Values
  - PARAMETER_NAME_SENTINEL_MASTER_ID
```
public static final String PARAMETER_NAME_SENTINEL_MASTER_ID
```
    See Also:
    
    Constant Field Values
  - PARAMETER_NAME_CLIENT_NAME
```
public static final String PARAMETER_NAME_CLIENT_NAME
```
    See Also:
    
    Constant Field Values
  - TIME_UNIT_MAP
```
public static final Map<String,TimeUnit> TIME_UNIT_MAP
```
  - DEFAULT_SENTINEL_PORT
```
public static final int DEFAULT_SENTINEL_PORT
```
    The default sentinel port.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_REDIS_PORT
```
public static final int DEFAULT_REDIS_PORT
```
    The default redis port.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TIMEOUT
```
public static final long DEFAULT_TIMEOUT
```
    Default timeout: 60 sec
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TIMEOUT_UNIT
```
public static final TimeUnit DEFAULT_TIMEOUT_UNIT
```
  - DEFAULT_TIMEOUT_DURATION
```
public static final Duration DEFAULT_TIMEOUT_DURATION
```
- Constructor Detail
  - RedisURI
```
public RedisURI()
```
    Default empty constructor.
  - RedisURI
```
public RedisURI(String host,
                int port,
                Duration timeout)
```
    Constructor with host/port and timeout.
    
    Parameters:
    
    host - the host
    
    port - the port
    
    timeout - timeout value
    
    timeout - unit of the timeout value
  - RedisURI
```
@Deprecated
public RedisURI(String host,
                            int port,
                            long timeout,
                            TimeUnit unit)
```
    Deprecated. since 5.0, use RedisURI(String, int, Duration)
    
    Constructor with host/port and timeout.
    
    Parameters:
    
    host - the host
    
    port - the port
    
    timeout - timeout value
    
    unit - unit of the timeout value
- Method Detail
  - builder
```
public static RedisURI.Builder builder()
```
    Returns a new RedisURI.Builder to construct a RedisURI.
    
    Returns:
    
    a new RedisURI.Builder to construct a RedisURI.
  - create
```
public static RedisURI create(String host,
                              int port)
```
    Create a Redis URI from host and port.
    
    Parameters:
    
    host - the host.
    
    port - the port.
    
    Returns:
    
    An instance of RedisURI containing details from the host and port.
  - create
```
public static RedisURI create(String uri)
```
    Create a Redis URI from an URI string. The uri must follow conventions of URI
    
    Parameters:
    
    uri - The URI string.
    
    Returns:
    
    An instance of RedisURI containing details from the URI.
  - create
```
public static RedisURI create(URI uri)
```
    Create a Redis URI from an URI string: The uri must follow conventions of URI
    
    Parameters:
    
    uri - The URI.
    
    Returns:
    
    An instance of RedisURI containing details from the URI.
  - getHost
```
public String getHost()
```
    Returns the host.
    
    Specified by:
    
    getHost in interface ConnectionPoint
    
    Returns:
    
    the host.
  - setHost
```
public void setHost(String host)
```
    Sets the Redis host.
    
    Parameters:
    
    host - the host.
  - getSentinelMasterId
```
public String getSentinelMasterId()
```
    Returns the Sentinel Master Id.
    
    Returns:
    
    the Sentinel Master Id.
  - setSentinelMasterId
```
public void setSentinelMasterId(String sentinelMasterId)
```
    Sets the Sentinel Master Id.
    
    Parameters:
    
    sentinelMasterId - the Sentinel Master Id.
  - getPort
```
public int getPort()
```
    Returns the Redis port.
    
    Specified by:
    
    getPort in interface ConnectionPoint
    
    Returns:
    
    the Redis port.
  - setPort
```
public void setPort(int port)
```
    Sets the Redis port. Defaults to DEFAULT_REDIS_PORT.
    
    Parameters:
    
    port - the Redis port.
  - getSocket
```
public String getSocket()
```
    Returns the Unix Domain Socket path.
    
    Specified by:
    
    getSocket in interface ConnectionPoint
    
    Returns:
    
    the Unix Domain Socket path.
  - setSocket
```
public void setSocket(String socket)
```
    Sets the Unix Domain Socket path.
    
    Parameters:
    
    socket - the Unix Domain Socket path.
  - getPassword
```
public char[] getPassword()
```
    Returns the password.
    
    Returns:
    
    the password.
  - setPassword
```
public void setPassword(String password)
```
    Sets the password. Use empty string to skip authentication.
    
    Parameters:
    
    password - the password, must not be null.
  - setPassword
```
public void setPassword(CharSequence password)
```
    Sets the password. Use empty string to skip authentication.
    
    Parameters:
    
    password - the password, must not be null.
    
    Since:
    
    5.2
  - setPassword
```
public void setPassword(char[] password)
```
    Sets the password. Use empty char array to skip authentication.
    
    Parameters:
    
    password - the password, must not be null.
    
    Since:
    
    4.4
  - getTimeout
```
public Duration getTimeout()
```
    Returns the command timeout for synchronous command execution.
    
    Returns:
    
    the Timeout.
    
    Since:
    
    5.0
  - setTimeout
```
public void setTimeout(Duration timeout)
```
    Sets the command timeout for synchronous command execution. A zero timeout value indicates to not time out.
    
    Parameters:
    
    timeout - the command timeout for synchronous command execution.
    
    Since:
    
    5.0
  - getDatabase
```
public int getDatabase()
```
    Returns the Redis database number. Databases are only available for Redis Standalone and Redis Master/Slave.
    
    Returns:
  - setDatabase
```
public void setDatabase(int database)
```
    Sets the Redis database number. Databases are only available for Redis Standalone and Redis Master/Slave.
    
    Parameters:
    
    database - the Redis database number.
  - getClientName
```
public String getClientName()
```
    Returns the client name.
    
    Returns:
    
    Since:
    
    4.4
  - setClientName
```
public void setClientName(String clientName)
```
    Sets the client name to be applied on Redis connections.
    
    Parameters:
    
    clientName - the client name.
    
    Since:
    
    4.4
  - isSsl
```
public boolean isSsl()
```
    Returns true if SSL mode is enabled.
    
    Returns:
    
    true if SSL mode is enabled.
  - setSsl
```
public void setSsl(boolean ssl)
```
    Sets whether to use SSL. Sets SSL also for already configured Redis Sentinel nodes.
    
    Parameters:
    
    ssl -
  - isVerifyPeer
```
public boolean isVerifyPeer()
```
    Sets whether to verify peers when using SSL.
    
    Returns:
    
    true to verify peers when using SSL.
  - setVerifyPeer
```
public void setVerifyPeer(boolean verifyPeer)
```
    Sets whether to verify peers when using SSL. Sets peer verification also for already configured Redis Sentinel nodes.
    
    Parameters:
    
    verifyPeer - true to verify peers when using SSL.
  - isStartTls
```
public boolean isStartTls()
```
    Returns true if StartTLS is enabled.
    
    Returns:
    
    true if StartTLS is enabled.
  - setStartTls
```
public void setStartTls(boolean startTls)
```
    Returns whether StartTLS is enabled. Sets StartTLS also for already configured Redis Sentinel nodes.
    
    Parameters:
    
    startTls - true if StartTLS is enabled.
  - getSentinels
```
public List<RedisURI> getSentinels()
```
    Returns:
    
    the list of Redis Sentinel URIs.
  - toURI
```
public URI toURI()
```
    Creates an URI based on the RedisURI.
    
    Returns:
    
    URI based on the RedisURI.
  - getResolvedAddress
```
@Deprecated
public SocketAddress getResolvedAddress()
```
    Deprecated. since 5.2. Will be removed with 6.0. Use SocketAddressResolver.resolve(RedisURI).
    
    Returns:
    
    the resolved SocketAddress based either on host/port or the socket.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class RedisURI

URI syntax

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

URI_SCHEME_REDIS_SENTINEL

URI_SCHEME_REDIS_SENTINEL_SECURE

URI_SCHEME_REDIS

URI_SCHEME_REDIS_SECURE

URI_SCHEME_REDIS_SECURE_ALT

URI_SCHEME_REDIS_TLS_ALT

URI_SCHEME_REDIS_SOCKET

URI_SCHEME_REDIS_SOCKET_ALT

PARAMETER_NAME_TIMEOUT

PARAMETER_NAME_DATABASE

PARAMETER_NAME_DATABASE_ALT

PARAMETER_NAME_SENTINEL_MASTER_ID

PARAMETER_NAME_CLIENT_NAME

TIME_UNIT_MAP

DEFAULT_SENTINEL_PORT

DEFAULT_REDIS_PORT

DEFAULT_TIMEOUT

DEFAULT_TIMEOUT_UNIT

DEFAULT_TIMEOUT_DURATION

Constructor Detail

RedisURI

RedisURI

RedisURI

Method Detail

builder

create

create

create

getHost

setHost

getSentinelMasterId

setSentinelMasterId

getPort

setPort

getSocket

setSocket

getPassword

setPassword

setPassword

setPassword

getTimeout

setTimeout

getDatabase

setDatabase

getClientName

setClientName

isSsl

setSsl

isVerifyPeer

setVerifyPeer

isStartTls

setStartTls

getSentinels

toURI

getResolvedAddress

toString

equals

hashCode