Class RedisConfig

java.lang.Object

net.blockhost.commons.database.redis.RedisConfig

public class RedisConfig
extends Object

ConfigLib-compatible Redis configuration class.

This class can be embedded in your plugin's configuration to provide Redis connection settings. It uses ConfigLib annotations for YAML serialization with helpful comments.

Example usage in a plugin configuration:

@Configuration
public class PluginConfig {
    @Comment("Redis connection settings")
    private RedisConfig redis = new RedisConfig();

    public RedisConfig redis() {
        return redis;
    }
}

See Also:

• RedisManager

Constructor Summary

Constructors

Constructor	Description
RedisConfig()
RedisConfig(String host, int port, String password, int database, int connectionTimeoutMs, int socketTimeoutMs, int maxPoolSize, int maxIdle, int minIdle, boolean ssl)

Method Summary

Modifier and Type	Method	Description
final int	connectionTimeoutMs()
final int	database()
final String	host()
final int	maxIdle()
final int	maxPoolSize()
final int	minIdle()
final String	password()
final int	port()
boolean	requiresAuth()	Checks if authentication is required.
final int	socketTimeoutMs()
final boolean	ssl()
final @NonNull RedisConfig	withConnectionTimeoutMs(int connectionTimeoutMs)
final @NonNull RedisConfig	withDatabase(int database)
final @NonNull RedisConfig	withHost(String host)
final @NonNull RedisConfig	withMaxIdle(int maxIdle)
final @NonNull RedisConfig	withMaxPoolSize(int maxPoolSize)
final @NonNull RedisConfig	withMinIdle(int minIdle)
final @NonNull RedisConfig	withPassword(String password)
final @NonNull RedisConfig	withPort(int port)
final @NonNull RedisConfig	withSocketTimeoutMs(int socketTimeoutMs)
final @NonNull RedisConfig	withSsl(boolean ssl)

Methods inherited from class Object

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

Constructor Details

RedisConfig

public RedisConfig()

RedisConfig

public RedisConfig(String host,
 int port,
 String password,
 int database,
 int connectionTimeoutMs,
 int socketTimeoutMs,
 int maxPoolSize,
 int maxIdle,
 int minIdle,
 boolean ssl)

Method Details

requiresAuth

public boolean requiresAuth()

Checks if authentication is required.

Returns:

true if a password is set

host

public final String host()

port

public final int port()

password

public final String password()

database

public final int database()

connectionTimeoutMs

public final int connectionTimeoutMs()

socketTimeoutMs

public final int socketTimeoutMs()

maxPoolSize

public final int maxPoolSize()

maxIdle

public final int maxIdle()

minIdle

public final int minIdle()

ssl

public final boolean ssl()

withHost

public final @NonNull RedisConfig withHost(String host)

Returns:

this.

withPort

public final @NonNull RedisConfig withPort(int port)

Returns:

this.

withPassword

public final @NonNull RedisConfig withPassword(String password)

Returns:

this.

withDatabase

public final @NonNull RedisConfig withDatabase(int database)

Returns:

this.

withConnectionTimeoutMs

public final @NonNull RedisConfig withConnectionTimeoutMs(int connectionTimeoutMs)

Returns:

this.

withSocketTimeoutMs

public final @NonNull RedisConfig withSocketTimeoutMs(int socketTimeoutMs)

Returns:

this.

withMaxPoolSize

public final @NonNull RedisConfig withMaxPoolSize(int maxPoolSize)

Returns:

this.

withMaxIdle

public final @NonNull RedisConfig withMaxIdle(int maxIdle)

Returns:

this.

withMinIdle

public final @NonNull RedisConfig withMinIdle(int minIdle)

Returns:

this.

withSsl

public final @NonNull RedisConfig withSsl(boolean ssl)

Returns:

this.