Package org.springframework.data.redis.connection

Interface RedisConfiguration

All Known Implementing Classes:

RedisClusterConfiguration, RedisSentinelConfiguration, RedisSocketConfiguration, RedisStandaloneConfiguration, RedisStaticMasterReplicaConfiguration

public interface RedisConfiguration

Marker interface for configuration classes related to Redis connection setup. As the setup scenarios are quite diverse instead of struggling with unifying those, RedisConfiguration provides means to identify configurations for the individual purposes.

Since:

2.1

Author:

Christoph Strobl, Luis De Bello, Vikas Garg

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	RedisConfiguration.ClusterConfiguration	Configuration interface suitable for Redis cluster environments.
static interface	RedisConfiguration.DomainSocketConfiguration	Configuration interface suitable for single node redis connections using local unix domain socket.
static interface	RedisConfiguration.SentinelConfiguration	Configuration interface suitable for Redis Sentinel environments.
static interface	RedisConfiguration.StaticMasterReplicaConfiguration	Configuration interface suitable for Redis master/replica environments with fixed hosts.
static interface	RedisConfiguration.WithAuthentication	RedisConfiguration part suitable for configurations that may use authentication when connecting.
static interface	RedisConfiguration.WithDatabaseIndex	RedisConfiguration part suitable for configurations that use a specific database.
static interface	RedisConfiguration.WithDomainSocket	RedisConfiguration part suitable for configurations that use native domain sockets for connecting.
static interface	RedisConfiguration.WithHostAndPort	RedisConfiguration part suitable for configurations that use host/port combinations for connecting.
static interface	RedisConfiguration.WithPassword	RedisConfiguration part suitable for configurations that may use authentication when connecting.

Method Summary

Modifier and Type	Method	Description
static Integer	getDatabaseOrElse(@Nullable RedisConfiguration configuration, Supplier<Integer> other)
default Integer	getDatabaseOrElse(Supplier<Integer> other)	Get the configured database index if the current RedisConfiguration is database aware or evaluate and return the value of the given Supplier.
static String	getHostOrElse(@Nullable RedisConfiguration configuration, Supplier<String> other)
static RedisPassword	getPasswordOrElse(@Nullable RedisConfiguration configuration, Supplier<RedisPassword> other)
default RedisPassword	getPasswordOrElse(Supplier<RedisPassword> other)	Get the configured RedisPassword if the current RedisConfiguration is password aware or evaluate and return the value of the given Supplier.
static int	getPortOrElse(@Nullable RedisConfiguration configuration, IntSupplier other)
static @Nullable String	getUsernameOrElse(@Nullable RedisConfiguration configuration, Supplier<@Nullable String> other)
static boolean	isAuthenticationAware(@Nullable RedisConfiguration configuration)
static boolean	isClusterConfiguration(@Nullable RedisConfiguration configuration)
static boolean	isDatabaseIndexAware(@Nullable RedisConfiguration configuration)
static boolean	isDomainSocketConfiguration(@Nullable RedisConfiguration configuration)
static boolean	isHostAndPortAware(@Nullable RedisConfiguration configuration)
static boolean	isSentinelConfiguration(@Nullable RedisConfiguration configuration)
static boolean	isStaticMasterReplicaConfiguration(@Nullable RedisConfiguration configuration)

Method Details

getDatabaseOrElse

default Integer getDatabaseOrElse(Supplier<Integer> other)

Get the configured database index if the current RedisConfiguration is database aware or evaluate and return the value of the given Supplier.

Parameters:

other - a Supplier whose result is returned if given RedisConfiguration is not database aware.

Returns:

never null.

Throws:

IllegalArgumentException - if other is null.

getPasswordOrElse

default RedisPassword getPasswordOrElse(Supplier<RedisPassword> other)

Get the configured RedisPassword if the current RedisConfiguration is password aware or evaluate and return the value of the given Supplier.

Parameters:

other - a Supplier whose result is returned if given RedisConfiguration is not password aware.

Returns:

never null.

Throws:

IllegalArgumentException - if other is null.

isAuthenticationAware

@Contract("null -> false")
static boolean isAuthenticationAware(@Nullable RedisConfiguration configuration)

Parameters:

configuration - can be null.

Returns:

true if given RedisConfiguration is instance of RedisConfiguration.WithPassword.

isDatabaseIndexAware

@Contract("null -> false")
static boolean isDatabaseIndexAware(@Nullable RedisConfiguration configuration)

Parameters:

configuration - can be null.

Returns:

true if given RedisConfiguration is instance of RedisConfiguration.WithDatabaseIndex.

isSentinelConfiguration

@Contract("null -> false")
static boolean isSentinelConfiguration(@Nullable RedisConfiguration configuration)

Parameters:

configuration - can be null.

Returns:

true if given RedisConfiguration is instance of RedisConfiguration.SentinelConfiguration.

isHostAndPortAware

@Contract("null -> false")
static boolean isHostAndPortAware(@Nullable RedisConfiguration configuration)

Parameters:

configuration - can be null.

Returns:

true if given RedisConfiguration is instance of RedisConfiguration.WithHostAndPort.

Since:

2.1.6

isClusterConfiguration

@Contract("null -> false")
static boolean isClusterConfiguration(@Nullable RedisConfiguration configuration)

Parameters:

configuration - can be null.

Returns:

true if given RedisConfiguration is instance of RedisConfiguration.ClusterConfiguration.

isStaticMasterReplicaConfiguration

@Contract("null -> false")
static boolean isStaticMasterReplicaConfiguration(@Nullable RedisConfiguration configuration)

Parameters:

configuration - can be null.

Returns:

true if given RedisConfiguration is instance of RedisConfiguration.StaticMasterReplicaConfiguration.

isDomainSocketConfiguration

@Contract("null -> false")
static boolean isDomainSocketConfiguration(@Nullable RedisConfiguration configuration)

Parameters:

configuration - can be null.

Returns:

true if given RedisConfiguration is instance of RedisConfiguration.DomainSocketConfiguration.

getDatabaseOrElse

static Integer getDatabaseOrElse(@Nullable RedisConfiguration configuration,
 Supplier<Integer> other)

Parameters:

configuration - can be null.

other - a Supplier whose result is returned if given RedisConfiguration is not database aware.

Returns:

never null.

Throws:

IllegalArgumentException - if other is null.

getUsernameOrElse

static @Nullable String getUsernameOrElse(@Nullable RedisConfiguration configuration,
 Supplier<@Nullable String> other)

Parameters:

configuration - can be null.

other - a Supplier whose result is returned if given RedisConfiguration is not password aware.

Returns:

can be null.

Throws:

IllegalArgumentException - if other is null.

getPasswordOrElse

static RedisPassword getPasswordOrElse(@Nullable RedisConfiguration configuration,
 Supplier<RedisPassword> other)

Parameters:

configuration - can be null.

other - a Supplier whose result is returned if given RedisConfiguration is not password aware.

Returns:

never null.

Throws:

IllegalArgumentException - if other is null.

getPortOrElse

static int getPortOrElse(@Nullable RedisConfiguration configuration,
 IntSupplier other)

Parameters:

configuration - can be null.

other - a Supplier whose result is returned if given RedisConfiguration is not port aware.

Returns:

never null.

Throws:

IllegalArgumentException - if other is null.

Since:

2.1.6

getHostOrElse

static String getHostOrElse(@Nullable RedisConfiguration configuration,
 Supplier<String> other)

Parameters:

configuration - can be null.

other - a Supplier whose result is returned if given RedisConfiguration is not host aware.

Returns:

never null.

Throws:

IllegalArgumentException - if other is null.

Since:

2.1.6