redis.clients.jedis

Class ClientSetInfoConfig

java.lang.Object

redis.clients.jedis.ClientSetInfoConfig

public final class ClientSetInfoConfig
extends java.lang.Object

Configuration for CLIENT SETINFO command behaviour.

This class supports two modes of operation:

• Advanced mode: Using withLibNameSuffix(String) for advanced suffix customization, where the provided string is already preformatted according to the rules of the `CLIENT SETINFO` command
• Simple mode: Using ClientSetInfoConfig(DriverInfo) used when the command parameter will be built by the driver based on the DriverInfo provided

For backward compatibility, getUpstreamDrivers() returns the upstream drivers string when using driver info mode.

See Also:

DriverInfo, CLIENT SETINFO

Field Summary

Fields

Modifier and Type	Field and Description
static ClientSetInfoConfig	DEFAULT Default configuration that uses the Jedis library name without any upstream drivers.
static ClientSetInfoConfig	DISABLED Configuration that disables CLIENT SETINFO command.

Constructor Summary

Constructors

Constructor and Description
ClientSetInfoConfig() Creates a new ClientSetInfoConfig with default settings.
ClientSetInfoConfig(boolean disabled) Creates a new ClientSetInfoConfig with the specified disabled state.
ClientSetInfoConfig(DriverInfo driverInfo) Creates a new ClientSetInfoConfig with the specified driver information.
ClientSetInfoConfig(java.lang.String libNameSuffix) Creates a new ClientSetInfoConfig with a library name suffix.

Method Summary

Modifier and Type	Method and Description
DriverInfo	getDriverInfo()
java.lang.String	getUpstreamDrivers() Returns the formatted upstream drivers string.
boolean	isDisabled()
static ClientSetInfoConfig	withLibNameSuffix(java.lang.String suffix) Creates a new ClientSetInfoConfig with a library name suffix.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final ClientSetInfoConfig DEFAULT

Default configuration that uses the Jedis library name without any upstream drivers.

DISABLED

public static final ClientSetInfoConfig DISABLED

Configuration that disables CLIENT SETINFO command.

Constructor Detail

ClientSetInfoConfig

public ClientSetInfoConfig()

Creates a new ClientSetInfoConfig with default settings.

The default configuration uses the "jedis" library name without any upstream drivers.

ClientSetInfoConfig

public ClientSetInfoConfig(boolean disabled)

Creates a new ClientSetInfoConfig with the specified disabled state.

When disabled, the CLIENT SETINFO command will not be sent to Redis.

Parameters:

disabled - true to disable CLIENT SETINFO, false otherwise

ClientSetInfoConfig

public ClientSetInfoConfig(java.lang.String libNameSuffix)

Creates a new ClientSetInfoConfig with a library name suffix.

This constructor is for legacy compatibility. The suffix will be appended to "jedis" in parentheses, resulting in a format like: jedis(suffix).

For adding upstream driver information, use ClientSetInfoConfig(DriverInfo) with a DriverInfo that has upstream drivers.

Parameters:

libNameSuffix - the suffix to append to "jedis" (will be placed in parentheses)

Throws:

JedisValidationException - if libNameSuffix contains braces

ClientSetInfoConfig

public ClientSetInfoConfig(DriverInfo driverInfo)

Creates a new ClientSetInfoConfig with the specified driver information.

This is the recommended constructor for setting up driver information with upstream drivers. The driver information can optionally override the library name completely.

Parameters:

driverInfo - the driver information, must not be null

Throws:

JedisValidationException - if driverInfo is null

Method Detail

isDisabled

public boolean isDisabled()

Returns:

true if CLIENT SETINFO is disabled, false otherwise

getDriverInfo

public DriverInfo getDriverInfo()

Returns:

the driver information

getUpstreamDrivers

public java.lang.String getUpstreamDrivers()

Returns the formatted upstream drivers string.

Multiple drivers are separated by semicolons, with the most recently added driver appearing first.

Examples:

• "spring-data-redis_v3.2.0" - single upstream driver
• "lettuce-core_v6.4.1;spring-data-redis_v3.2.0" - multiple upstream drivers

Returns:

the formatted upstream drivers string, or null if no upstream drivers are set

withLibNameSuffix

public static ClientSetInfoConfig withLibNameSuffix(java.lang.String suffix)

Creates a new ClientSetInfoConfig with a library name suffix.

This is the legacy method for simple name customization. The provided suffix will be appended to "jedis" in parentheses, resulting in a format like: jedis(suffix). For adding upstream driver information, use ClientSetInfoConfig(DriverInfo) with a * DriverInfo that has upstream drivers.

Parameters:

suffix - the suffix to append to "jedis" (will be placed in parentheses)

Returns:

a new ClientSetInfoConfig with the library name suffix