Skip to content

Modify config pattern #2402

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 9, 2021
Merged

Modify config pattern #2402

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a19ab29
Modify config pattern
sazzad16 Mar 7, 2021
f0be65c
further rename params, variables
sazzad16 Mar 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions src/main/java/redis/clients/jedis/BinaryJedis.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,27 +150,27 @@ public BinaryJedis(final String host, final int port, final int timeout, final b
public BinaryJedis(final String host, final int port, final int connectionTimeout,
final int soTimeout) {
this(host, port, DefaultJedisClientConfig.builder()
.withConnectionTimeout(connectionTimeout).withSoTimeout(soTimeout).build());
.withConnectionTimeoutMillis(connectionTimeout).withSoTimeoutMillis(soTimeout).build());
}

public BinaryJedis(final String host, final int port, final int connectionTimeout,
final int soTimeout, final int infiniteSoTimeout) {
this(host, port, DefaultJedisClientConfig.builder()
.withConnectionTimeout(connectionTimeout).withSoTimeout(soTimeout)
.withInfiniteSoTimeout(infiniteSoTimeout).build());
.withConnectionTimeoutMillis(connectionTimeout).withSoTimeoutMillis(soTimeout)
.withInfiniteSoTimeoutMillis(infiniteSoTimeout).build());
}

public BinaryJedis(final String host, final int port, final int connectionTimeout,
final int soTimeout, final boolean ssl) {
this(host, port, DefaultJedisClientConfig.builder()
.withConnectionTimeout(connectionTimeout).withSoTimeout(soTimeout).withSsl(ssl).build());
.withConnectionTimeoutMillis(connectionTimeout).withSoTimeoutMillis(soTimeout).withSsl(ssl).build());
}

public BinaryJedis(final String host, final int port, final int connectionTimeout,
final int soTimeout, final boolean ssl, final SSLSocketFactory sslSocketFactory,
final SSLParameters sslParameters, final HostnameVerifier hostnameVerifier) {
this(host, port, DefaultJedisClientConfig.builder()
.withConnectionTimeout(connectionTimeout).withSoTimeout(soTimeout).withSsl(ssl)
.withConnectionTimeoutMillis(connectionTimeout).withSoTimeoutMillis(soTimeout).withSsl(ssl)
.withSslSocketFactory(sslSocketFactory).withSslParameters(sslParameters)
.withHostnameVerifier(hostnameVerifier).build());
}
Expand All @@ -180,15 +180,15 @@ public BinaryJedis(final String host, final int port, final int connectionTimeou
final SSLSocketFactory sslSocketFactory, final SSLParameters sslParameters,
final HostnameVerifier hostnameVerifier) {
this(host, port, DefaultJedisClientConfig.builder()
.withConnectionTimeout(connectionTimeout).withSoTimeout(soTimeout)
.withInfiniteSoTimeout(infiniteSoTimeout).withSsl(ssl)
.withConnectionTimeoutMillis(connectionTimeout).withSoTimeoutMillis(soTimeout)
.withInfiniteSoTimeoutMillis(infiniteSoTimeout).withSsl(ssl)
.withSslSocketFactory(sslSocketFactory).withSslParameters(sslParameters)
.withHostnameVerifier(hostnameVerifier).build());
}

public BinaryJedis(final JedisShardInfo shardInfo) {
this(shardInfo.getHost(), shardInfo.getPort(), DefaultJedisClientConfig.builder()
.withConnectionTimeout(shardInfo.getConnectionTimeout()).withSoTimeout(shardInfo.getSoTimeout())
.withConnectionTimeoutMillis(shardInfo.getConnectionTimeout()).withSoTimeoutMillis(shardInfo.getSoTimeout())
.withUser(shardInfo.getUser()).withPassword(shardInfo.getPassword()).withDatabse(shardInfo.getDb())
.withSsl(shardInfo.getSsl()).withSslSocketFactory(shardInfo.getSslSocketFactory())
.withSslParameters(shardInfo.getSslParameters()).withHostnameVerifier(shardInfo.getHostnameVerifier()).build());
Expand Down Expand Up @@ -217,14 +217,14 @@ public BinaryJedis(final URI uri, final int timeout, final SSLSocketFactory sslS

public BinaryJedis(final URI uri, final int connectionTimeout, final int soTimeout) {
this(uri, DefaultJedisClientConfig.builder()
.withConnectionTimeout(connectionTimeout).withSoTimeout(soTimeout).build());
.withConnectionTimeoutMillis(connectionTimeout).withSoTimeoutMillis(soTimeout).build());
}

public BinaryJedis(final URI uri, final int connectionTimeout, final int soTimeout,
final SSLSocketFactory sslSocketFactory,final SSLParameters sslParameters,
final HostnameVerifier hostnameVerifier) {
this(uri, DefaultJedisClientConfig.builder()
.withConnectionTimeout(connectionTimeout).withSoTimeout(soTimeout)
.withConnectionTimeoutMillis(connectionTimeout).withSoTimeoutMillis(soTimeout)
.withSslSocketFactory(sslSocketFactory).withSslParameters(sslParameters)
.withHostnameVerifier(hostnameVerifier).build());
}
Expand All @@ -233,8 +233,8 @@ public BinaryJedis(final URI uri, final int connectionTimeout, final int soTimeo
final int infiniteSoTimeout, final SSLSocketFactory sslSocketFactory,
final SSLParameters sslParameters, final HostnameVerifier hostnameVerifier) {
this(uri, DefaultJedisClientConfig.builder()
.withConnectionTimeout(connectionTimeout).withSoTimeout(soTimeout)
.withInfiniteSoTimeout(infiniteSoTimeout).withSslSocketFactory(sslSocketFactory)
.withConnectionTimeoutMillis(connectionTimeout).withSoTimeoutMillis(soTimeout)
.withInfiniteSoTimeoutMillis(infiniteSoTimeout).withSslSocketFactory(sslSocketFactory)
.withSslParameters(sslParameters).withHostnameVerifier(hostnameVerifier).build());
}

Expand All @@ -243,8 +243,8 @@ public BinaryJedis(final URI uri, JedisClientConfig config) {
throw new InvalidURIException(String.format("Cannot open Redis connection due invalid URI \"%s\".", uri.toString()));
}
client = new Client(new HostAndPort(uri.getHost(), uri.getPort()),
DefaultJedisClientConfig.builder().withConnectionTimeout(config.getConnectionTimeout())
.withSoTimeout(config.getSoTimeout()).withInfiniteSoTimeout(config.getInfiniteSoTimeout())
DefaultJedisClientConfig.builder().withConnectionTimeoutMillis(config.getConnectionTimeoutMillis())
.withSoTimeoutMillis(config.getSoTimeoutMillis()).withInfiniteSoTimeoutMillis(config.getInfiniteSoTimeoutMillis())
.withUser(JedisURIHelper.getUser(uri)).withPassword(JedisURIHelper.getPassword(uri))
.withDatabse(JedisURIHelper.getDBIndex(uri)).withClientName(config.getClientName())
.withSsl(JedisURIHelper.isRedisSSLScheme(uri))
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/redis/clients/jedis/Connection.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public class Connection implements Closeable {
private static final byte[][] EMPTY_ARGS = new byte[0][];

private boolean socketParamModified = false; // for backward compatibility
private JedisSocketFactory socketFactory; // TODO: sould be final
private JedisSocketFactory socketFactory; // TODO: should be final
private Socket socket;
private RedisOutputStream outputStream;
private RedisInputStream inputStream;
Expand Down Expand Up @@ -72,8 +72,8 @@ public Connection(final String host, final int port, final boolean ssl,

public Connection(final HostAndPort hostAndPort, final JedisClientConfig clientConfig) {
this(new DefaultJedisSocketFactory(hostAndPort, clientConfig));
this.soTimeout = clientConfig.getSoTimeout();
this.infiniteSoTimeout = clientConfig.getInfiniteSoTimeout();
this.soTimeout = clientConfig.getSoTimeoutMillis();
this.infiniteSoTimeout = clientConfig.getInfiniteSoTimeoutMillis();
}

public Connection(final JedisSocketFactory jedisSocketFactory) {
Expand Down
54 changes: 27 additions & 27 deletions src/main/java/redis/clients/jedis/DefaultJedisClientConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@

public final class DefaultJedisClientConfig implements JedisClientConfig {

private final int connectionTimeout;
private final int soTimeout;
private final int infiniteSoTimeout;
private final int connectionTimeoutMillis;
private final int soTimeoutMillis;
private final int infiniteSoTimeoutMillis;

private final String user;
private final String password;
Expand All @@ -22,13 +22,13 @@ public final class DefaultJedisClientConfig implements JedisClientConfig {

private final HostAndPortMapper hostAndPortMapper;

private DefaultJedisClientConfig(int connectionTimeout, int soTimeout, int infiniteSoTimeout,
String user, String password, int database, String clientName,
private DefaultJedisClientConfig(int connectionTimeoutMillis, int soTimeoutMillis,
int infiniteSoTimeoutMillis, String user, String password, int database, String clientName,
boolean ssl, SSLSocketFactory sslSocketFactory, SSLParameters sslParameters,
HostnameVerifier hostnameVerifier, HostAndPortMapper hostAndPortMapper) {
this.connectionTimeout = connectionTimeout;
this.soTimeout = soTimeout;
this.infiniteSoTimeout = infiniteSoTimeout;
this.connectionTimeoutMillis = connectionTimeoutMillis;
this.soTimeoutMillis = soTimeoutMillis;
this.infiniteSoTimeoutMillis = infiniteSoTimeoutMillis;
this.user = user;
this.password = password;
this.database = database;
Expand All @@ -41,18 +41,18 @@ private DefaultJedisClientConfig(int connectionTimeout, int soTimeout, int infin
}

@Override
public int getConnectionTimeout() {
return connectionTimeout;
public int getConnectionTimeoutMillis() {
return connectionTimeoutMillis;
}

@Override
public int getSoTimeout() {
return soTimeout;
public int getSoTimeoutMillis() {
return soTimeoutMillis;
}

@Override
public int getInfiniteSoTimeout() {
return infiniteSoTimeout;
public int getInfiniteSoTimeoutMillis() {
return infiniteSoTimeoutMillis;
}

@Override
Expand Down Expand Up @@ -106,9 +106,9 @@ public static Builder builder() {

public static class Builder {

private int connectionTimeout = Protocol.DEFAULT_TIMEOUT;
private int soTimeout = Protocol.DEFAULT_TIMEOUT;
private int infiniteSoTimeout = 0;
private int connectionTimeoutMillis = Protocol.DEFAULT_TIMEOUT;
private int soTimeoutMillis = Protocol.DEFAULT_TIMEOUT;
private int infiniteSoTimeoutMillis = 0;

private String user = null;
private String password = null;
Expand All @@ -126,23 +126,23 @@ private Builder() {
}

public DefaultJedisClientConfig build() {
return new DefaultJedisClientConfig(connectionTimeout, soTimeout, infiniteSoTimeout,
user, password, databse, clientName,
return new DefaultJedisClientConfig(connectionTimeoutMillis, soTimeoutMillis,
infiniteSoTimeoutMillis, user, password, databse, clientName,
ssl, sslSocketFactory, sslParameters, hostnameVerifier, hostAndPortMapper);
}

public Builder withConnectionTimeout(int connectionTimeout) {
this.connectionTimeout = connectionTimeout;
public Builder withConnectionTimeoutMillis(int connectionTimeoutMillis) {
this.connectionTimeoutMillis = connectionTimeoutMillis;
return this;
}

public Builder withSoTimeout(int soTimeout) {
this.soTimeout = soTimeout;
public Builder withSoTimeoutMillis(int soTimeoutMillis) {
this.soTimeoutMillis = soTimeoutMillis;
return this;
}

public Builder withInfiniteSoTimeout(int infiniteSoTimeout) {
this.infiniteSoTimeout = infiniteSoTimeout;
public Builder withInfiniteSoTimeoutMillis(int infiniteSoTimeoutMillis) {
this.infiniteSoTimeoutMillis = infiniteSoTimeoutMillis;
return this;
}

Expand Down Expand Up @@ -193,8 +193,8 @@ public Builder withHostAndPortMapper(HostAndPortMapper hostAndPortMapper) {
}

public static DefaultJedisClientConfig copyConfig(JedisClientConfig copy) {
return new DefaultJedisClientConfig(copy.getConnectionTimeout(), copy.getSoTimeout(),
copy.getInfiniteSoTimeout(), copy.getUser(), copy.getPassword(), copy.getDatabase(),
return new DefaultJedisClientConfig(copy.getConnectionTimeoutMillis(), copy.getSoTimeoutMillis(),
copy.getInfiniteSoTimeoutMillis(), copy.getUser(), copy.getPassword(), copy.getDatabase(),
copy.getClientName(), copy.isSsl(), copy.getSslSocketFactory(), copy.getSslParameters(),
copy.getHostnameVerifier(), copy.getHostAndPortMapper());
}
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/redis/clients/jedis/DefaultJedisSocketFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ public DefaultJedisSocketFactory(String host, int port, int connectionTimeout, i
public DefaultJedisSocketFactory(HostAndPort hostAndPort, JedisClientConfig config) {
this.hostAndPort = hostAndPort;
if (config != null) {
this.connectionTimeout = config.getConnectionTimeout();
this.soTimeout = config.getSoTimeout();
this.connectionTimeout = config.getConnectionTimeoutMillis();
this.soTimeout = config.getSoTimeoutMillis();
this.ssl = config.isSsl();
this.sslSocketFactory = config.getSslSocketFactory();
this.sslParameters = config.getSslParameters();
Expand Down
60 changes: 48 additions & 12 deletions src/main/java/redis/clients/jedis/JedisClientConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,68 @@

public interface JedisClientConfig {

int getConnectionTimeout();
/**
* @return Connection timeout in milliseconds
*/
default int getConnectionTimeoutMillis() {
return Protocol.DEFAULT_TIMEOUT;
}

int getSoTimeout();
/**
* @return Socket timeout in milliseconds
*/
default int getSoTimeoutMillis() {
return Protocol.DEFAULT_TIMEOUT;
}

/**
* @return Socket timeout (in milliseconds) to use during blocking operation. Default is '0',
* which means to block forever.
*/
int getInfiniteSoTimeout();
default int getInfiniteSoTimeoutMillis() {
return 0;
}

String getUser();
/**
* @return Redis ACL user
*/
default String getUser() {
return null;
}

String getPassword();
default String getPassword() {
return null;
}

int getDatabase();
default int getDatabase() {
return Protocol.DEFAULT_DATABASE;
}

String getClientName();
default String getClientName() {
return null;
}

boolean isSsl();
/**
* @return <code>true</code> - to create a TLS connection. <code>false</code> - otherwise.
*/
default boolean isSsl() {
return false;
}

SSLSocketFactory getSslSocketFactory();
default SSLSocketFactory getSslSocketFactory() {
return null;
}

SSLParameters getSslParameters();
default SSLParameters getSslParameters() {
return null;
}

HostnameVerifier getHostnameVerifier();
default HostnameVerifier getHostnameVerifier() {
return null;
}

HostAndPortMapper getHostAndPortMapper();
default HostAndPortMapper getHostAndPortMapper() {
return null;
}

}
8 changes: 4 additions & 4 deletions src/main/java/redis/clients/jedis/JedisClusterConnectionHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,14 +65,14 @@ public JedisClusterConnectionHandler(Set<HostAndPort> nodes, final GenericObject
boolean ssl, SSLSocketFactory sslSocketFactory, SSLParameters sslParameters,
HostnameVerifier hostnameVerifier, JedisClusterHostAndPortMap portMap) {
this(nodes,
DefaultJedisClientConfig.builder().withConnectionTimeout(connectionTimeout)
.withSoTimeout(soTimeout).withInfiniteSoTimeout(infiniteSoTimeout)
DefaultJedisClientConfig.builder().withConnectionTimeoutMillis(connectionTimeout)
.withSoTimeoutMillis(soTimeout).withInfiniteSoTimeoutMillis(infiniteSoTimeout)
.withUser(user).withPassword(password).withClientName(clientName)
.withSsl(ssl).withSslSocketFactory(sslSocketFactory).withSslParameters(sslParameters)
.withHostnameVerifier(hostnameVerifier).build(),
poolConfig,
DefaultJedisClientConfig.builder().withConnectionTimeout(connectionTimeout)
.withSoTimeout(soTimeout).withInfiniteSoTimeout(infiniteSoTimeout)
DefaultJedisClientConfig.builder().withConnectionTimeoutMillis(connectionTimeout)
.withSoTimeoutMillis(soTimeout).withInfiniteSoTimeoutMillis(infiniteSoTimeout)
.withUser(user).withPassword(password).withClientName(clientName)
.withSsl(ssl).withSslSocketFactory(sslSocketFactory).withSslParameters(sslParameters)
.withHostnameVerifier(hostnameVerifier).withHostAndPortMapper(portMap).build());
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/redis/clients/jedis/JedisClusterInfoCache.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,8 @@ public JedisClusterInfoCache(final GenericObjectPoolConfig poolConfig,
SSLSocketFactory sslSocketFactory, SSLParameters sslParameters,
HostnameVerifier hostnameVerifier, HostAndPortMapper hostAndPortMap) {
this(poolConfig,
DefaultJedisClientConfig.builder().withConnectionTimeout(connectionTimeout)
.withSoTimeout(soTimeout).withInfiniteSoTimeout(infiniteSoTimeout)
DefaultJedisClientConfig.builder().withConnectionTimeoutMillis(connectionTimeout)
.withSoTimeoutMillis(soTimeout).withInfiniteSoTimeoutMillis(infiniteSoTimeout)
.withUser(user).withPassword(password).withClientName(clientName)
.withSsl(ssl).withSslSocketFactory(sslSocketFactory)
.withSslParameters(sslParameters) .withHostnameVerifier(hostnameVerifier)
Expand Down
8 changes: 4 additions & 4 deletions src/main/java/redis/clients/jedis/JedisFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ class JedisFactory implements PooledObjectFactory<Jedis> {
final String clientName, final boolean ssl, final SSLSocketFactory sslSocketFactory,
final SSLParameters sslParameters, final HostnameVerifier hostnameVerifier) {
this.hostAndPort.set(new HostAndPort(host, port));
this.config = DefaultJedisClientConfig.builder().withConnectionTimeout(connectionTimeout)
.withSoTimeout(soTimeout).withInfiniteSoTimeout(infiniteSoTimeout).withUser(user)
this.config = DefaultJedisClientConfig.builder().withConnectionTimeoutMillis(connectionTimeout)
.withSoTimeoutMillis(soTimeout).withInfiniteSoTimeoutMillis(infiniteSoTimeout).withUser(user)
.withPassword(password).withDatabse(database).withClientName(clientName)
.withSsl(ssl).withSslSocketFactory(sslSocketFactory)
.withSslParameters(sslParameters).withHostnameVerifier(hostnameVerifier).build();
Expand All @@ -93,8 +93,8 @@ class JedisFactory implements PooledObjectFactory<Jedis> {
"Cannot open Redis connection due invalid URI. %s", uri.toString()));
}
this.hostAndPort.set(new HostAndPort(uri.getHost(), uri.getPort()));
this.config = DefaultJedisClientConfig.builder().withConnectionTimeout(connectionTimeout)
.withSoTimeout(soTimeout).withInfiniteSoTimeout(infiniteSoTimeout)
this.config = DefaultJedisClientConfig.builder().withConnectionTimeoutMillis(connectionTimeout)
.withSoTimeoutMillis(soTimeout).withInfiniteSoTimeoutMillis(infiniteSoTimeout)
.withUser(JedisURIHelper.getUser(uri)).withPassword(JedisURIHelper.getPassword(uri))
.withDatabse(JedisURIHelper.getDBIndex(uri)).withClientName(clientName)
.withSsl(JedisURIHelper.isRedisSSLScheme(uri)).withSslSocketFactory(sslSocketFactory)
Expand Down
2 changes: 1 addition & 1 deletion src/test/java/redis/clients/jedis/tests/JedisClusterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -601,7 +601,7 @@ public void testJedisClusterTimeout() {
public void testJedisClusterTimeoutWithConfig() {
HostAndPort hp = nodeInfo1;
try (JedisCluster jc = new JedisCluster(hp, DefaultJedisClientConfig.builder()
.withConnectionTimeout(4000).withSoTimeout(4000).withPassword("cluster").build(),
.withConnectionTimeoutMillis(4000).withSoTimeoutMillis(4000).withPassword("cluster").build(),
DEFAULT_REDIRECTIONS, DEFAULT_POOL_CONFIG)) {

jc.getClusterNodes().values().forEach(pool -> {
Expand Down
Loading