org.springframework.data.redis.connection.lettuce.LettucePoolingClientConfiguration Maven / Gradle / Ivy
/*
* Copyright 2017-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.redis.connection.lettuce;
import io.lettuce.core.ClientOptions;
import io.lettuce.core.resource.ClientResources;
import java.time.Duration;
import org.apache.commons.pool2.impl.GenericObjectPoolConfig;
import org.springframework.util.Assert;
/**
* Redis client configuration for lettuce using a driver level pooled connection by adding pooling specific
* configuration to {@link LettuceClientConfiguration}.
*
* @author Mark Paluch
* @author Christoph Strobl
* @since 2.0
*/
public interface LettucePoolingClientConfiguration extends LettuceClientConfiguration {
/**
* @return the {@link GenericObjectPoolConfig}. Never {@literal null}.
*/
GenericObjectPoolConfig getPoolConfig();
/**
* Creates a new {@link LettucePoolingClientConfigurationBuilder} to build {@link LettucePoolingClientConfiguration}
* to be used with the Lettuce client.
*
* @return a new {@link LettucePoolingClientConfigurationBuilder} to build {@link LettucePoolingClientConfiguration}.
*/
static LettucePoolingClientConfigurationBuilder builder() {
return new LettucePoolingClientConfigurationBuilder();
}
/**
* Creates a default {@link LettucePoolingClientConfiguration} with
*
* - SSL
* - no
* - Peer Verification
* - yes
* - Start TLS
* - no
* - Client Options
* - none
* - Client Resources
* - none
* - Connect Timeout
* - 60 Seconds
* - Shutdown Timeout
* - 100 Milliseconds
* - pool config
* - default {@link GenericObjectPoolConfig}
*
*
* @return a {@link LettucePoolingClientConfiguration} with defaults.
*/
static LettucePoolingClientConfiguration defaultConfiguration() {
return builder().build();
}
/**
* @author Mark Paluch
* @author Christoph Strobl
*/
class LettucePoolingClientConfigurationBuilder extends LettuceClientConfigurationBuilder {
GenericObjectPoolConfig poolConfig = new GenericObjectPoolConfig();
LettucePoolingClientConfigurationBuilder() {
super();
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.lettuce.LettuceClientConfiguration.LettuceClientConfigurationBuilder#useSsl()
*/
@Override
public LettucePoolingSslClientConfigurationBuilder useSsl() {
super.useSsl();
return new LettucePoolingSslClientConfigurationBuilder(this);
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.lettuce.LettuceClientConfiguration.LettuceClientConfigurationBuilder#clientResources(io.lettuce.core.resource.ClientResources)
*/
@Override
public LettucePoolingClientConfigurationBuilder clientResources(ClientResources clientResources) {
super.clientResources(clientResources);
return this;
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.lettuce.LettuceClientConfiguration.LettuceClientConfigurationBuilder#clientOptions(io.lettuce.core.ClientOptions)
*/
@Override
public LettucePoolingClientConfigurationBuilder clientOptions(ClientOptions clientOptions) {
super.clientOptions(clientOptions);
return this;
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.lettuce.LettuceClientConfiguration.LettuceClientConfigurationBuilder#commandTimeout(java.time.Duration)
*/
@Override
public LettucePoolingClientConfigurationBuilder commandTimeout(Duration timeout) {
super.commandTimeout(timeout);
return this;
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.lettuce.LettuceClientConfiguration.LettuceClientConfigurationBuilder#shutdownTimeout(java.time.Duration)
*/
@Override
public LettucePoolingClientConfigurationBuilder shutdownTimeout(Duration shutdownTimeout) {
super.shutdownTimeout(shutdownTimeout);
return this;
}
/**
* Set the {@link GenericObjectPoolConfig} used by the driver.
*
* @param poolConfig must not be {@literal null}.
*/
public LettucePoolingClientConfigurationBuilder poolConfig(GenericObjectPoolConfig poolConfig) {
Assert.notNull(poolConfig, "PoolConfig must not be null!");
this.poolConfig = poolConfig;
return this;
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.lettuce.LettuceClientConfiguration.LettuceClientConfigurationBuilder#build()
*/
@Override
public LettucePoolingClientConfiguration build() {
return new DefaultLettucePoolingClientConfiguration(super.build(), poolConfig);
}
}
/**
* @author Christoph Strobl
*/
class LettucePoolingSslClientConfigurationBuilder extends LettuceSslClientConfigurationBuilder {
LettucePoolingSslClientConfigurationBuilder(LettucePoolingClientConfigurationBuilder delegate) {
super(delegate);
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.lettuce.LettuceClientConfiguration.LettuceSslClientConfigurationBuilder#and()
*/
@Override
public LettucePoolingClientConfigurationBuilder and() {
return (LettucePoolingClientConfigurationBuilder) super.and();
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.lettuce.LettuceClientConfiguration.LettuceSslClientConfigurationBuilder#disablePeerVerification()
*/
@Override
public LettucePoolingSslClientConfigurationBuilder disablePeerVerification() {
super.disablePeerVerification();
return this;
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.lettuce.LettuceClientConfiguration.LettuceSslClientConfigurationBuilder#startTls()
*/
@Override
public LettucePoolingSslClientConfigurationBuilder startTls() {
super.startTls();
return this;
}
/*
* (non-Javadoc)
* @see org.springframework.data.redis.connection.lettuce.LettuceClientConfiguration.LettuceSslClientConfigurationBuilder#build()
*/
@Override
public LettucePoolingClientConfiguration build() {
return (LettucePoolingClientConfiguration) super.build();
}
}
}