io.lettuce.core.failover.api

Class ImmutableRedisURI

java.lang.Object

io.lettuce.core.RedisURI

io.lettuce.core.failover.api.ImmutableRedisURI

All Implemented Interfaces:

ConnectionPoint, Serializable

@Experimental
public class ImmutableRedisURI
extends RedisURI

An immutable implementation of RedisURI that prevents any modifications after construction. All setter methods throw UnsupportedOperationException.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.lettuce.core.RedisURI

RedisURI.Builder

Field Summary

Fields inherited from class io.lettuce.core.RedisURI

CONVERTER_MAP, DEFAULT_REDIS_PORT, DEFAULT_SENTINEL_PORT, DEFAULT_TIMEOUT, DEFAULT_TIMEOUT_DURATION, PARAMETER_NAME_CLIENT_NAME, PARAMETER_NAME_DATABASE, PARAMETER_NAME_DATABASE_ALT, PARAMETER_NAME_LIBRARY_NAME, PARAMETER_NAME_LIBRARY_VERSION, PARAMETER_NAME_SENTINEL_MASTER_ID, PARAMETER_NAME_TIMEOUT, PARAMETER_NAME_VERIFY_PEER, URI_SCHEME_REDIS, URI_SCHEME_REDIS_SECURE, URI_SCHEME_REDIS_SECURE_ALT, URI_SCHEME_REDIS_SENTINEL, URI_SCHEME_REDIS_SENTINEL_SECURE, URI_SCHEME_REDIS_SOCKET, URI_SCHEME_REDIS_SOCKET_ALT, URI_SCHEME_REDIS_TLS_ALT

Constructor Summary

Constructors

Constructor and Description
ImmutableRedisURI(RedisURI redisURI)

Method Summary

Modifier and Type	Method and Description
void	applyAuthentication(RedisURI source) Apply authentication from another RedisURI.
void	applySsl(RedisURI source) Apply authentication from another RedisURI.
List<RedisURI>	getSentinels()
void	setAuthentication(char[] password) Sets the password to use to authenticate Redis connections.
void	setAuthentication(CharSequence password) Sets the password to use to authenticate Redis connections.
void	setAuthentication(String username, char[] password) Sets the username and password to use to authenticate Redis connections.
void	setAuthentication(String username, CharSequence password) Sets the username and password to use to authenticate Redis connections.
void	setClientName(String clientName) Sets the client name to be applied on Redis connections.
void	setCredentialsProvider(RedisCredentialsProvider credentialsProvider) Sets the RedisCredentialsProvider.
void	setDatabase(int database) Sets the Redis database number.
void	setDriverInfo(DriverInfo driverInfo) Sets the driver information containing the library name and upstream drivers.
void	setHost(String host) Sets the Redis host.
void	setLibraryName(String libraryName) Sets the library name to be applied on Redis connections.
void	setLibraryVersion(String libraryVersion) Sets the library version to be applied on Redis connections.
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.
void	setVerifyPeer(SslVerifyMode verifyMode) Sets how to verify peers when using SSL.

Methods inherited from class io.lettuce.core.RedisURI

builder, builder, create, create, create, equals, getClientName, getCredentialsProvider, getDatabase, getDriverInfo, getHost, getLibraryName, getLibraryVersion, getPort, getSentinelMasterId, getSocket, getTimeout, getVerifyMode, hashCode, isSsl, isStartTls, isVerifyPeer, toString, toURI

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ImmutableRedisURI

public ImmutableRedisURI(RedisURI redisURI)

Method Detail

setHost

public void setHost(String host)

Description copied from class: RedisURI

Sets the Redis host.

Overrides:

setHost in class RedisURI

Parameters:

host - the host

setSentinelMasterId

public void setSentinelMasterId(String sentinelMasterId)

Description copied from class: RedisURI

Sets the Sentinel Master Id.

Overrides:

setSentinelMasterId in class RedisURI

Parameters:

sentinelMasterId - the Sentinel Master Id.

setPort

public void setPort(int port)

Description copied from class: RedisURI

Sets the Redis port. Defaults to RedisURI.DEFAULT_REDIS_PORT.

Overrides:

setPort in class RedisURI

Parameters:

port - the Redis port

setSocket

public void setSocket(String socket)

Description copied from class: RedisURI

Sets the Unix Domain Socket path.

Overrides:

setSocket in class RedisURI

Parameters:

socket - the Unix Domain Socket path.

applyAuthentication

public void applyAuthentication(RedisURI source)

Description copied from class: RedisURI

Apply authentication from another RedisURI. The authentication settings of the source URI will be applied to this URI. That is in particular the RedisCredentialsProvider.

Overrides:

applyAuthentication in class RedisURI

Parameters:

source - must not be null.

setAuthentication

public void setAuthentication(CharSequence password)

Description copied from class: RedisURI

Sets the password to use to authenticate Redis connections.

This method effectively overwrites any existing RedisCredentialsProvider with a new one, containing an empty username and the provided password.

Overrides:

setAuthentication in class RedisURI

Parameters:

password - the password to use to authenticate Redis connections.

See Also:

RedisURI.setCredentialsProvider(RedisCredentialsProvider)

setAuthentication

public void setAuthentication(char[] password)

Description copied from class: RedisURI

Sets the password to use to authenticate Redis connections.

This method effectively overwrites any existing RedisCredentialsProvider with a new one, containing an empty username and the provided password.

Overrides:

setAuthentication in class RedisURI

Parameters:

password - the password to use to authenticate Redis connections.

See Also:

RedisURI.setCredentialsProvider(RedisCredentialsProvider)

setAuthentication

public void setAuthentication(String username,
                              char[] password)

Description copied from class: RedisURI

Sets the username and password to use to authenticate Redis connections.

This method effectively overwrites any existing RedisCredentialsProvider with a new one, containing the provided username and password.

Overrides:

setAuthentication in class RedisURI

Parameters:

username - the username to use to authenticate Redis connections.

password - the password to use to authenticate Redis connections.

See Also:

RedisURI.setCredentialsProvider(RedisCredentialsProvider)

setAuthentication

public void setAuthentication(String username,
                              CharSequence password)

Description copied from class: RedisURI

Sets the username and password to use to authenticate Redis connections.

This method effectively overwrites any existing RedisCredentialsProvider with a new one, containing the provided username and password.

Overrides:

setAuthentication in class RedisURI

Parameters:

username - the username to use to authenticate Redis connections.

password - the password to use to authenticate Redis connections.

See Also:

RedisURI.setCredentialsProvider(RedisCredentialsProvider)

setCredentialsProvider

public void setCredentialsProvider(RedisCredentialsProvider credentialsProvider)

Description copied from class: RedisURI

Sets the RedisCredentialsProvider. Configuring a credentials provider resets the configured static username/password.

Overrides:

setCredentialsProvider in class RedisURI

Parameters:

credentialsProvider - the credentials provider to use when authenticating a Redis connection.

setTimeout

public void setTimeout(Duration timeout)

Description copied from class: RedisURI

Sets the command timeout for synchronous command execution. A zero timeout value indicates to not time out.

Overrides:

setTimeout in class RedisURI

Parameters:

timeout - the command timeout for synchronous command execution.

setDatabase

public void setDatabase(int database)

Description copied from class: RedisURI

Sets the Redis database number. Databases are only available for Redis Standalone and Redis Master/Slave.

Overrides:

setDatabase in class RedisURI

Parameters:

database - the Redis database number.

setClientName

public void setClientName(String clientName)

Description copied from class: RedisURI

Sets the client name to be applied on Redis connections.

Overrides:

setClientName in class RedisURI

Parameters:

clientName - the client name.

setLibraryName

public void setLibraryName(String libraryName)

Description copied from class: RedisURI

Sets the library name to be applied on Redis connections.

This method creates a new DriverInfo with only the specified name, clearing any previously set upstream drivers. If you want to preserve upstream drivers, use RedisURI.setDriverInfo(DriverInfo) instead.

Overrides:

setLibraryName in class RedisURI

Parameters:

libraryName - the library name, must not contain spaces.

See Also:

RedisURI.setDriverInfo(DriverInfo)

setDriverInfo

public void setDriverInfo(DriverInfo driverInfo)

Description copied from class: RedisURI

Sets the driver information containing the library name and upstream drivers.

This method replaces any previously set driver information or library name. Use this method when you want structured control over the library identification sent via CLIENT SETINFO.

Overrides:

setDriverInfo in class RedisURI

Parameters:

driverInfo - the driver information to set

See Also:

DriverInfo, RedisURI.setLibraryName(String)

setLibraryVersion

public void setLibraryVersion(String libraryVersion)

Description copied from class: RedisURI

Sets the library version to be applied on Redis connections.

Overrides:

setLibraryVersion in class RedisURI

Parameters:

libraryVersion - the library version.

applySsl

public void applySsl(RedisURI source)

Description copied from class: RedisURI

Apply authentication from another RedisURI. The SSL settings of the source URI will be applied to this URI. That is in particular SSL usage, peer verification and StartTLS.

Overrides:

applySsl in class RedisURI

Parameters:

source - must not be null.

setSsl

public void setSsl(boolean ssl)

Description copied from class: RedisURI

Sets whether to use SSL. Sets SSL also for already configured Redis Sentinel nodes.

Overrides:

setSsl in class RedisURI

setVerifyPeer

public void setVerifyPeer(boolean verifyPeer)

Description copied from class: RedisURI

Sets whether to verify peers when using SSL. Sets peer verification also for already configured Redis Sentinel nodes.

Overrides:

setVerifyPeer in class RedisURI

Parameters:

verifyPeer - true to verify peers when using SSL.

setVerifyPeer

public void setVerifyPeer(SslVerifyMode verifyMode)

Description copied from class: RedisURI

Sets how to verify peers when using SSL. Sets peer verification also for already configured Redis Sentinel nodes.

Overrides:

setVerifyPeer in class RedisURI

Parameters:

verifyMode - verification mode to use when using SSL.

setStartTls

public void setStartTls(boolean startTls)

Description copied from class: RedisURI

Returns whether StartTLS is enabled. Sets StartTLS also for already configured Redis Sentinel nodes.

Overrides:

setStartTls in class RedisURI

Parameters:

startTls - true if StartTLS is enabled.

getSentinels

public List<RedisURI> getSentinels()

Overrides:

getSentinels in class RedisURI

Returns:

the list of Redis Sentinel URIs.