io.lettuce.core

Class DriverInfo

java.lang.Object

io.lettuce.core.DriverInfo

All Implemented Interfaces:

Serializable

public final class DriverInfo
extends Object
implements Serializable

Immutable class representing driver information for Redis client identification.

This class is used to identify the client library and any upstream drivers (such as Spring Data Redis or Spring Session) when connecting to Redis. The information is sent via the CLIENT SETINFO command.

The formatted name follows the pattern: name(driver1_vVersion1;driver2_vVersion2)

Since:

7.2

Author:

Viktoriya Kutsarova

See Also:

RedisURI.setDriverInfo(DriverInfo), RedisURI.getDriverInfo(), CLIENT SETINFO, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DriverInfo.Builder Builder for creating DriverInfo instances.

Method Summary

Modifier and Type	Method and Description
static DriverInfo.Builder	builder() Creates a new DriverInfo.Builder with default values.
static DriverInfo.Builder	builder(DriverInfo driverInfo) Creates a new DriverInfo.Builder initialized with values from an existing DriverInfo.
String	getFormattedName() Returns the formatted name including upstream drivers.
String	getName() Returns the base library name without upstream driver information.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static DriverInfo.Builder builder()

Creates a new DriverInfo.Builder with default values.

The default name is "Lettuce" (from LettuceVersion.getName()).

Returns:

a new builder instance

builder

public static DriverInfo.Builder builder(DriverInfo driverInfo)

Creates a new DriverInfo.Builder initialized with values from an existing DriverInfo.

Parameters:

driverInfo - the existing driver info to copy from, must not be null

Returns:

a new builder instance initialized with the existing values

Throws:

IllegalArgumentException - if driverInfo is null

getFormattedName

public String getFormattedName()

Returns the formatted name including upstream drivers.

If no upstream drivers are present, returns just the name. Otherwise, returns the name followed by upstream drivers in parentheses, separated by semicolons.

Examples:

• "Lettuce" - no upstream drivers
• "Lettuce(spring-data-redis_v3.2.0)" - one upstream driver
• "Lettuce(spring-session_v3.3.0;spring-data-redis_v3.2.0)" - multiple upstream drivers

Returns:

the formatted name for use in CLIENT SETINFO

getName

public String getName()

Returns the base library name without upstream driver information.

Returns:

the library name

toString

public String toString()

Overrides:

toString in class Object