io.lettuce.core

Class RedisURI.Builder

java.lang.Object

io.lettuce.core.RedisURI.Builder

Enclosing class:

RedisURI

public static class RedisURI.Builder
extends Object

Builder for Redis URI.

Method Summary

Modifier and Type	Method and Description
RedisURI	build()
static RedisURI.Builder	redis(String host) Set Redis host.
static RedisURI.Builder	redis(String host, int port) Set Redis host and port.
static RedisURI.Builder	sentinel(String host) Set Sentinel host.
static RedisURI.Builder	sentinel(String host, int port) Set Sentinel host and port.
static RedisURI.Builder	sentinel(String host, int port, String masterId) Set Sentinel host, port and master id.
static RedisURI.Builder	sentinel(String host, String masterId) Set Sentinel host and master id.
static RedisURI.Builder	socket(String socket) Set Redis socket.
RedisURI.Builder	withClientName(String clientName) Configures a client name.
RedisURI.Builder	withDatabase(int database) Configures the database number.
RedisURI.Builder	withHost(String host) Adds host information to the builder.
RedisURI.Builder	withPassword(char[] password) Configures authentication.
RedisURI.Builder	withPassword(String password) Configures authentication.
RedisURI.Builder	withPort(int port) Adds port information to the builder.
RedisURI.Builder	withSentinel(String host) Add a withSentinel host to the existing builder.
RedisURI.Builder	withSentinel(String host, int port) Add a withSentinel host/port to the existing builder.
RedisURI.Builder	withSentinelMasterId(String sentinelMasterId) Configures a sentinel master Id.
RedisURI.Builder	withSsl(boolean ssl) Adds ssl information to the builder.
RedisURI.Builder	withStartTls(boolean startTls) Enables/disables StartTLS when using SSL.
RedisURI.Builder	withTimeout(Duration timeout) Configures a timeout.
RedisURI.Builder	withTimeout(long timeout, TimeUnit unit) Deprecated. since 5.0, use withTimeout(Duration).
RedisURI.Builder	withVerifyPeer(boolean verifyPeer) Enables/disables peer verification.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

socket

public static RedisURI.Builder socket(String socket)

Set Redis socket. Creates a new builder.

Parameters:

socket - the host name

Returns:

New builder with Redis socket.

redis

public static RedisURI.Builder redis(String host)

Set Redis host. Creates a new builder.

Parameters:

host - the host name

Returns:

New builder with Redis host/port.

redis

public static RedisURI.Builder redis(String host,
                                     int port)

Set Redis host and port. Creates a new builder

Parameters:

host - the host name

port - the port

Returns:

New builder with Redis host/port.

sentinel

public static RedisURI.Builder sentinel(String host)

Set Sentinel host. Creates a new builder.

Parameters:

host - the host name

Returns:

New builder with Sentinel host/port.

sentinel

public static RedisURI.Builder sentinel(String host,
                                        int port)

Set Sentinel host and port. Creates a new builder.

Parameters:

host - the host name

port - the port

Returns:

New builder with Sentinel host/port.

sentinel

public static RedisURI.Builder sentinel(String host,
                                        String masterId)

Set Sentinel host and master id. Creates a new builder.

Parameters:

host - the host name

masterId - sentinel master id

Returns:

New builder with Sentinel host/port.

sentinel

public static RedisURI.Builder sentinel(String host,
                                        int port,
                                        String masterId)

Set Sentinel host, port and master id. Creates a new builder.

Parameters:

host - the host name

port - the port

masterId - sentinel master id

Returns:

New builder with Sentinel host/port.

withSentinel

public RedisURI.Builder withSentinel(String host)

Add a withSentinel host to the existing builder.

Parameters:

host - the host name

Returns:

the builder

withSentinel

public RedisURI.Builder withSentinel(String host,
                                     int port)

Add a withSentinel host/port to the existing builder.

Parameters:

host - the host name

port - the port

Returns:

the builder

withHost

public RedisURI.Builder withHost(String host)

Adds host information to the builder. Does only affect Redis URI, cannot be used with Sentinel connections.

Parameters:

host - the port

Returns:

the builder

withPort

public RedisURI.Builder withPort(int port)

Adds port information to the builder. Does only affect Redis URI, cannot be used with Sentinel connections.

Parameters:

port - the port

Returns:

the builder

withSsl

public RedisURI.Builder withSsl(boolean ssl)

Adds ssl information to the builder. Does only affect Redis URI, cannot be used with Sentinel connections.

Parameters:

ssl - true if use SSL

Returns:

the builder

withStartTls

public RedisURI.Builder withStartTls(boolean startTls)

Enables/disables StartTLS when using SSL. Does only affect Redis URI, cannot be used with Sentinel connections.

Parameters:

startTls - true if use StartTLS

Returns:

the builder

withVerifyPeer

public RedisURI.Builder withVerifyPeer(boolean verifyPeer)

Enables/disables peer verification. Does only affect Redis URI, cannot be used with Sentinel connections.

Parameters:

verifyPeer - true to verify hosts when using SSL

Returns:

the builder

withDatabase

public RedisURI.Builder withDatabase(int database)

Configures the database number.

Parameters:

database - the database number

Returns:

the builder

withClientName

public RedisURI.Builder withClientName(String clientName)

Configures a client name.

Parameters:

clientName - the client name

Returns:

the builder

withPassword

public RedisURI.Builder withPassword(String password)

Configures authentication.

Parameters:

password - the password

Returns:

the builder

withPassword

public RedisURI.Builder withPassword(char[] password)

Configures authentication.

Parameters:

password - the password

Returns:

the builder

Since:

4.4

withTimeout

public RedisURI.Builder withTimeout(Duration timeout)

Configures a timeout.

Parameters:

timeout - must not be null or negative.

Returns:

the builder

withTimeout

@Deprecated
public RedisURI.Builder withTimeout(long timeout,
                                                TimeUnit unit)

Deprecated. since 5.0, use withTimeout(Duration).

Configures a timeout.

Parameters:

timeout - must be greater or equal 0.

unit - the timeout time unit.

Returns:

the builder

withSentinelMasterId

public RedisURI.Builder withSentinelMasterId(String sentinelMasterId)

Configures a sentinel master Id.

Parameters:

sentinelMasterId - sentinel master id, must not be empty or null

Returns:

the builder

build

public RedisURI build()

Returns:

the RedisURI.