Merge pull request #26982 from bono007
* gh-26982: Polish "Add Rabbit connection factory configurers" Add Rabbit connection factory configurers Closes gh-26982pull/30691/head
Andy Wilkinson
3 years ago
commit
659667bb65
@ -0,0 +1,73 @@
|
||||
/*
|
||||
* Copyright 2012-2021 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
|
||||
*
|
||||
* https://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.boot.autoconfigure.amqp;
|
||||
|
||||
import org.springframework.amqp.rabbit.connection.AbstractConnectionFactory;
|
||||
import org.springframework.amqp.rabbit.connection.ConnectionNameStrategy;
|
||||
import org.springframework.boot.context.properties.PropertyMapper;
|
||||
import org.springframework.util.Assert;
|
||||
|
||||
/**
|
||||
* Configures {@link AbstractConnectionFactory Rabbit ConnectionFactory} with sensible
|
||||
* defaults.
|
||||
*
|
||||
* @param <T> the connection factory type.
|
||||
* @author Chris Bono
|
||||
* @since 2.6.0
|
||||
*/
|
||||
public abstract class AbstractConnectionFactoryConfigurer<T extends AbstractConnectionFactory> {
|
||||
|
||||
private final RabbitProperties rabbitProperties;
|
||||
|
||||
private ConnectionNameStrategy connectionNameStrategy;
|
||||
|
||||
protected AbstractConnectionFactoryConfigurer(RabbitProperties properties) {
|
||||
Assert.notNull(properties, "RabbitProperties must not be null");
|
||||
this.rabbitProperties = properties;
|
||||
}
|
||||
|
||||
protected final ConnectionNameStrategy getConnectionNameStrategy() {
|
||||
return this.connectionNameStrategy;
|
||||
}
|
||||
|
||||
protected final void setConnectionNameStrategy(ConnectionNameStrategy connectionNameStrategy) {
|
||||
this.connectionNameStrategy = connectionNameStrategy;
|
||||
}
|
||||
|
||||
/**
|
||||
* Configures the given {@code connectionFactory} with sensible defaults.
|
||||
* @param connectionFactory connection factory to configure
|
||||
*/
|
||||
public final void configure(T connectionFactory) {
|
||||
Assert.notNull(connectionFactory, "ConnectionFactory must not be null");
|
||||
PropertyMapper map = PropertyMapper.get();
|
||||
map.from(this.rabbitProperties::determineAddresses).to(connectionFactory::setAddresses);
|
||||
map.from(this.rabbitProperties::getAddressShuffleMode).whenNonNull()
|
||||
.to(connectionFactory::setAddressShuffleMode);
|
||||
map.from(this.connectionNameStrategy).whenNonNull().to(connectionFactory::setConnectionNameStrategy);
|
||||
configure(connectionFactory, this.rabbitProperties);
|
||||
}
|
||||
|
||||
/**
|
||||
* Configures the given {@code connectionFactory} using the given
|
||||
* {@code rabbitProperties}.
|
||||
* @param connectionFactory connection factory to configure
|
||||
* @param rabbitProperties properties to use for the configuration
|
||||
*/
|
||||
protected abstract void configure(T connectionFactory, RabbitProperties rabbitProperties);
|
||||
|
||||
}
|
||||
@ -0,0 +1,51 @@
|
||||
/*
|
||||
* Copyright 2012-2021 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
|
||||
*
|
||||
* https://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.boot.autoconfigure.amqp;
|
||||
|
||||
import java.time.Duration;
|
||||
|
||||
import org.springframework.amqp.rabbit.connection.CachingConnectionFactory;
|
||||
import org.springframework.boot.context.properties.PropertyMapper;
|
||||
|
||||
/**
|
||||
* Configures Rabbit {@link CachingConnectionFactory} with sensible defaults.
|
||||
*
|
||||
* @author Chris Bono
|
||||
* @since 2.6.0
|
||||
*/
|
||||
public class CachingConnectionFactoryConfigurer extends AbstractConnectionFactoryConfigurer<CachingConnectionFactory> {
|
||||
|
||||
public CachingConnectionFactoryConfigurer(RabbitProperties properties) {
|
||||
super(properties);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void configure(CachingConnectionFactory connectionFactory, RabbitProperties rabbitProperties) {
|
||||
PropertyMapper map = PropertyMapper.get();
|
||||
map.from(rabbitProperties::isPublisherReturns).to(connectionFactory::setPublisherReturns);
|
||||
map.from(rabbitProperties::getPublisherConfirmType).whenNonNull()
|
||||
.to(connectionFactory::setPublisherConfirmType);
|
||||
RabbitProperties.Cache.Channel channel = rabbitProperties.getCache().getChannel();
|
||||
map.from(channel::getSize).whenNonNull().to(connectionFactory::setChannelCacheSize);
|
||||
map.from(channel::getCheckoutTimeout).whenNonNull().as(Duration::toMillis)
|
||||
.to(connectionFactory::setChannelCheckoutTimeout);
|
||||
RabbitProperties.Cache.Connection connection = rabbitProperties.getCache().getConnection();
|
||||
map.from(connection::getMode).whenNonNull().to(connectionFactory::setCacheMode);
|
||||
map.from(connection::getSize).whenNonNull().to(connectionFactory::setConnectionCacheSize);
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,101 @@
|
||||
/*
|
||||
* Copyright 2012-2020 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
|
||||
*
|
||||
* https://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.boot.autoconfigure.amqp;
|
||||
|
||||
import java.time.Duration;
|
||||
|
||||
import com.rabbitmq.client.impl.CredentialsProvider;
|
||||
import com.rabbitmq.client.impl.CredentialsRefreshService;
|
||||
|
||||
import org.springframework.amqp.rabbit.connection.RabbitConnectionFactoryBean;
|
||||
import org.springframework.boot.context.properties.PropertyMapper;
|
||||
import org.springframework.core.io.ResourceLoader;
|
||||
import org.springframework.util.Assert;
|
||||
|
||||
/**
|
||||
* Configures {@link RabbitConnectionFactoryBean} with sensible defaults.
|
||||
*
|
||||
* @author Chris Bono
|
||||
* @since 2.6.0
|
||||
*/
|
||||
public class RabbitConnectionFactoryBeanConfigurer {
|
||||
|
||||
private final RabbitProperties rabbitProperties;
|
||||
|
||||
private final ResourceLoader resourceLoader;
|
||||
|
||||
private CredentialsProvider credentialsProvider;
|
||||
|
||||
private CredentialsRefreshService credentialsRefreshService;
|
||||
|
||||
public RabbitConnectionFactoryBeanConfigurer(ResourceLoader resourceLoader, RabbitProperties properties) {
|
||||
this.resourceLoader = resourceLoader;
|
||||
this.rabbitProperties = properties;
|
||||
}
|
||||
|
||||
public void setCredentialsProvider(CredentialsProvider credentialsProvider) {
|
||||
this.credentialsProvider = credentialsProvider;
|
||||
}
|
||||
|
||||
public void setCredentialsRefreshService(CredentialsRefreshService credentialsRefreshService) {
|
||||
this.credentialsRefreshService = credentialsRefreshService;
|
||||
}
|
||||
|
||||
/**
|
||||
* Configure the specified rabbit connection factory bean. The factory bean can be
|
||||
* further tuned and default settings can be overridden. It is the repsonsiblity of
|
||||
* the caller to invoke {@link RabbitConnectionFactoryBean#afterPropertiesSet()}
|
||||
* though.
|
||||
* @param factory the {@link RabbitConnectionFactoryBean} instance to configure
|
||||
*/
|
||||
public void configure(RabbitConnectionFactoryBean factory) {
|
||||
Assert.notNull(factory, "RabbitConnectionFactoryBean must not be null");
|
||||
factory.setResourceLoader(this.resourceLoader);
|
||||
PropertyMapper map = PropertyMapper.get();
|
||||
map.from(this.rabbitProperties::determineHost).whenNonNull().to(factory::setHost);
|
||||
map.from(this.rabbitProperties::determinePort).to(factory::setPort);
|
||||
map.from(this.rabbitProperties::determineUsername).whenNonNull().to(factory::setUsername);
|
||||
map.from(this.rabbitProperties::determinePassword).whenNonNull().to(factory::setPassword);
|
||||
map.from(this.rabbitProperties::determineVirtualHost).whenNonNull().to(factory::setVirtualHost);
|
||||
map.from(this.rabbitProperties::getRequestedHeartbeat).whenNonNull().asInt(Duration::getSeconds)
|
||||
.to(factory::setRequestedHeartbeat);
|
||||
map.from(this.rabbitProperties::getRequestedChannelMax).to(factory::setRequestedChannelMax);
|
||||
RabbitProperties.Ssl ssl = this.rabbitProperties.getSsl();
|
||||
if (ssl.determineEnabled()) {
|
||||
factory.setUseSSL(true);
|
||||
map.from(ssl::getAlgorithm).whenNonNull().to(factory::setSslAlgorithm);
|
||||
map.from(ssl::getKeyStoreType).to(factory::setKeyStoreType);
|
||||
map.from(ssl::getKeyStore).to(factory::setKeyStore);
|
||||
map.from(ssl::getKeyStorePassword).to(factory::setKeyStorePassphrase);
|
||||
map.from(ssl::getKeyStoreAlgorithm).whenNonNull().to(factory::setKeyStoreAlgorithm);
|
||||
map.from(ssl::getTrustStoreType).to(factory::setTrustStoreType);
|
||||
map.from(ssl::getTrustStore).to(factory::setTrustStore);
|
||||
map.from(ssl::getTrustStorePassword).to(factory::setTrustStorePassphrase);
|
||||
map.from(ssl::getTrustStoreAlgorithm).whenNonNull().to(factory::setTrustStoreAlgorithm);
|
||||
map.from(ssl::isValidateServerCertificate)
|
||||
.to((validate) -> factory.setSkipServerCertificateValidation(!validate));
|
||||
map.from(ssl::getVerifyHostname).to(factory::setEnableHostnameVerification);
|
||||
}
|
||||
map.from(this.rabbitProperties::getConnectionTimeout).whenNonNull().asInt(Duration::toMillis)
|
||||
.to(factory::setConnectionTimeout);
|
||||
map.from(this.rabbitProperties::getChannelRpcTimeout).whenNonNull().asInt(Duration::toMillis)
|
||||
.to(factory::setChannelRpcTimeout);
|
||||
map.from(this.credentialsProvider).whenNonNull().to(factory::setCredentialsProvider);
|
||||
map.from(this.credentialsRefreshService).whenNonNull().to(factory::setCredentialsRefreshService);
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue