Prefix function names with spring-

* Add `spring-` prefix to function names

Fixes: #9

This commit renames each sub-module in the common, consumer, function
and supplier groups with a prefix of `spring-`.

* Update README.adoc links to new prefixed names
This commit is contained in:
Chris Bono
2024-01-02 13:07:00 -06:00
committed by GitHub
parent b9a3e59074
commit 84e732da08
596 changed files with 146 additions and 147 deletions

View File

@@ -0,0 +1,164 @@
/*
* Copyright 2020-2023 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.cloud.fn.aggregator;
import java.util.function.Function;
import reactor.core.publisher.Flux;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.BeanFactoryAware;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.cloud.fn.common.config.ComponentCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import org.springframework.integration.aggregator.CorrelationStrategy;
import org.springframework.integration.aggregator.DefaultAggregatingMessageGroupProcessor;
import org.springframework.integration.aggregator.ExpressionEvaluatingCorrelationStrategy;
import org.springframework.integration.aggregator.ExpressionEvaluatingMessageGroupProcessor;
import org.springframework.integration.aggregator.ExpressionEvaluatingReleaseStrategy;
import org.springframework.integration.aggregator.MessageGroupProcessor;
import org.springframework.integration.aggregator.ReleaseStrategy;
import org.springframework.integration.annotation.ServiceActivator;
import org.springframework.integration.channel.FluxMessageChannel;
import org.springframework.integration.config.AggregatorFactoryBean;
import org.springframework.integration.store.MessageGroupStore;
import org.springframework.integration.support.MessageBuilder;
import org.springframework.lang.Nullable;
import org.springframework.messaging.Message;
import org.springframework.messaging.MessageChannel;
/**
* @author Artem Bilan
* @author Corneil du Plessis
*/
@AutoConfiguration
@EnableConfigurationProperties(AggregatorFunctionProperties.class)
public class AggregatorFunctionConfiguration {
@Autowired
private AggregatorFunctionProperties properties;
@Autowired
private BeanFactory beanFactory;
@Bean
public Function<Flux<Message<?>>, Flux<Message<?>>> aggregatorFunction(
FluxMessageChannel inputChannel,
FluxMessageChannel outputChannel
) {
return input -> Flux.from(outputChannel)
.doOnRequest((request) ->
inputChannel.subscribeTo(
input.map((inputMessage) ->
MessageBuilder.fromMessage(inputMessage)
.removeHeader("kafka_consumer")
.build())));
}
@Bean
public FluxMessageChannel inputChannel() {
return new FluxMessageChannel();
}
@Bean
public FluxMessageChannel outputChannel() {
return new FluxMessageChannel();
}
@Bean
@ServiceActivator(inputChannel = "inputChannel")
public AggregatorFactoryBean aggregator(
@Nullable CorrelationStrategy correlationStrategy,
@Nullable ReleaseStrategy releaseStrategy,
@Nullable MessageGroupProcessor messageGroupProcessor,
@Nullable MessageGroupStore messageStore,
@Qualifier("outputChannel") MessageChannel outputChannel,
@Nullable ComponentCustomizer<AggregatorFactoryBean> aggregatorCustomizer) {
AggregatorFactoryBean aggregator = new AggregatorFactoryBean();
aggregator.setExpireGroupsUponCompletion(true);
aggregator.setSendPartialResultOnExpiry(true);
aggregator.setGroupTimeoutExpression(this.properties.getGroupTimeout());
if (correlationStrategy != null) {
aggregator.setCorrelationStrategy(correlationStrategy);
}
if (releaseStrategy != null) {
aggregator.setReleaseStrategy(releaseStrategy);
}
MessageGroupProcessor groupProcessor = messageGroupProcessor;
if (groupProcessor == null) {
groupProcessor = new DefaultAggregatingMessageGroupProcessor();
((BeanFactoryAware) groupProcessor).setBeanFactory(this.beanFactory);
}
aggregator.setProcessorBean(groupProcessor);
if (messageStore != null) {
aggregator.setMessageStore(messageStore);
}
aggregator.setOutputChannel(outputChannel);
if (aggregatorCustomizer != null) {
aggregatorCustomizer.customize(aggregator);
}
return aggregator;
}
@Bean
@ConditionalOnProperty(prefix = AggregatorFunctionProperties.PREFIX, name = "correlation")
@ConditionalOnMissingBean
public CorrelationStrategy correlationStrategy() {
return new ExpressionEvaluatingCorrelationStrategy(this.properties.getCorrelation());
}
@Bean
@ConditionalOnProperty(prefix = AggregatorFunctionProperties.PREFIX, name = "release")
@ConditionalOnMissingBean
public ReleaseStrategy releaseStrategy() {
return new ExpressionEvaluatingReleaseStrategy(this.properties.getRelease());
}
@Bean
@ConditionalOnProperty(prefix = AggregatorFunctionProperties.PREFIX, name = "aggregation")
@ConditionalOnMissingBean
public MessageGroupProcessor messageGroupProcessor() {
return new ExpressionEvaluatingMessageGroupProcessor(this.properties.getAggregation().getExpressionString());
}
@Configuration
@ConditionalOnMissingBean(MessageGroupStore.class)
@Import({
MessageStoreConfiguration.Mongo.class,
MessageStoreConfiguration.Redis.class,
MessageStoreConfiguration.Jdbc.class
})
protected static class MessageStoreAutoConfiguration {
}
}

View File

@@ -0,0 +1,122 @@
/*
* Copyright 2020-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.cloud.fn.aggregator;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.expression.Expression;
/**
* Configuration properties for the Aggregator function.
*
* @author Artem Bilan
*/
@ConfigurationProperties("aggregator")
public class AggregatorFunctionProperties {
static final String PREFIX = "aggregator";
/**
* SpEL expression for correlation key. Default to correlationId header.
*/
private Expression correlation;
/**
* SpEL expression for release strategy. Default is based on the sequenceSize header.
*/
private Expression release;
/**
* SpEL expression for aggregation strategy. Default is collection of payloads.
*/
private Expression aggregation;
/**
* SpEL expression for timeout to expiring uncompleted groups.
*/
private Expression groupTimeout;
/**
* Message store type.
*/
private String messageStoreType = MessageStoreType.SIMPLE;
/**
* Persistence message store entity: table prefix in RDBMS, collection name in MongoDb, etc.
*/
private String messageStoreEntity;
public Expression getCorrelation() {
return this.correlation;
}
public void setCorrelation(Expression correlation) {
this.correlation = correlation;
}
public Expression getRelease() {
return this.release;
}
public void setRelease(Expression release) {
this.release = release;
}
public Expression getAggregation() {
return this.aggregation;
}
public void setAggregation(Expression aggregation) {
this.aggregation = aggregation;
}
public Expression getGroupTimeout() {
return this.groupTimeout;
}
public void setGroupTimeout(Expression groupTimeout) {
this.groupTimeout = groupTimeout;
}
public String getMessageStoreEntity() {
return this.messageStoreEntity;
}
public void setMessageStoreEntity(String messageStoreEntity) {
this.messageStoreEntity = messageStoreEntity;
}
public String getMessageStoreType() {
return this.messageStoreType;
}
public void setMessageStoreType(String messageStoreType) {
this.messageStoreType = messageStoreType;
}
static final class MessageStoreType {
static final String SIMPLE = "simple";
static final String JDBC = "jdbc";
static final String MONGODB = "mongodb";
static final String REDIS = "redis";
}
}

View File

@@ -0,0 +1,60 @@
/*
* Copyright 2020-2022 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.cloud.fn.aggregator;
import java.util.Properties;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.data.mongo.MongoDataAutoConfiguration;
import org.springframework.boot.autoconfigure.data.mongo.MongoRepositoriesAutoConfiguration;
import org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration;
import org.springframework.boot.autoconfigure.data.redis.RedisRepositoriesAutoConfiguration;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
import org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration;
import org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration;
import org.springframework.boot.env.EnvironmentPostProcessor;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.MutablePropertySources;
import org.springframework.core.env.PropertiesPropertySource;
/**
* An {@link EnvironmentPostProcessor} to add {@code spring.autoconfigure.exclude} property
* since we can't use {@code application.properties} from the library perspective.
*
* @author Artem Bilan
* @author Corneil du Plessis
*/
public class ExcludeStoresAutoConfigurationEnvironmentPostProcessor implements EnvironmentPostProcessor {
@Override
public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
MutablePropertySources propertySources = environment.getPropertySources();
Properties properties = new Properties();
properties.setProperty("spring.autoconfigure.exclude",
DataSourceAutoConfiguration.class.getName() + ", " +
DataSourceTransactionManagerAutoConfiguration.class.getName() + ", " +
MongoAutoConfiguration.class.getName() + ", " +
MongoDataAutoConfiguration.class.getName() + ", " +
MongoRepositoriesAutoConfiguration.class.getName() + ", " +
RedisAutoConfiguration.class.getName() + ", " +
RedisRepositoriesAutoConfiguration.class.getName());
propertySources.addLast(new PropertiesPropertySource("aggregator.exclude.stores.auto-configuration", properties));
}
}

View File

@@ -0,0 +1,115 @@
/*
* Copyright 2020-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.cloud.fn.aggregator;
import java.util.Arrays;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.autoconfigure.data.mongo.MongoDataAutoConfiguration;
import org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
import org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration;
import org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Import;
import org.springframework.context.annotation.Primary;
import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.data.mongodb.core.convert.MongoCustomConversions;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.integration.jdbc.store.JdbcMessageStore;
import org.springframework.integration.mongodb.store.ConfigurableMongoDbMessageStore;
import org.springframework.integration.mongodb.support.BinaryToMessageConverter;
import org.springframework.integration.mongodb.support.MessageToBinaryConverter;
import org.springframework.integration.redis.store.RedisMessageStore;
import org.springframework.integration.store.MessageGroupStore;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.util.StringUtils;
/**
* A helper class containing configuration classes for particular technologies
* to expose an appropriate {@link org.springframework.integration.store.MessageStore} bean
* via matched configuration properties.
*
* @author Artem Bilan
* @author Corneil du Plessis
*/
class MessageStoreConfiguration {
@ConditionalOnClass(ConfigurableMongoDbMessageStore.class)
@ConditionalOnProperty(prefix = AggregatorFunctionProperties.PREFIX,
name = "message-store-type",
havingValue = AggregatorFunctionProperties.MessageStoreType.MONGODB)
@Import({ MongoAutoConfiguration.class,
MongoDataAutoConfiguration.class })
static class Mongo {
@Bean
public MessageGroupStore messageStore(MongoTemplate mongoTemplate, AggregatorFunctionProperties properties) {
if (StringUtils.hasText(properties.getMessageStoreEntity())) {
return new ConfigurableMongoDbMessageStore(mongoTemplate, properties.getMessageStoreEntity());
}
else {
return new ConfigurableMongoDbMessageStore(mongoTemplate);
}
}
@Bean
@Primary
public MongoCustomConversions mongoDbCustomConversions() {
return new MongoCustomConversions(Arrays.asList(
new MessageToBinaryConverter(), new BinaryToMessageConverter()));
}
}
@ConditionalOnClass(RedisMessageStore.class)
@ConditionalOnProperty(prefix = AggregatorFunctionProperties.PREFIX,
name = "message-store-type",
havingValue = AggregatorFunctionProperties.MessageStoreType.REDIS)
@Import(RedisAutoConfiguration.class)
static class Redis {
@Bean
public MessageGroupStore messageStore(RedisTemplate<?, ?> redisTemplate) {
return new RedisMessageStore(redisTemplate.getConnectionFactory());
}
}
@ConditionalOnClass(JdbcMessageStore.class)
@ConditionalOnProperty(prefix = AggregatorFunctionProperties.PREFIX,
name = "message-store-type",
havingValue = AggregatorFunctionProperties.MessageStoreType.JDBC)
@Import({
DataSourceAutoConfiguration.class,
DataSourceTransactionManagerAutoConfiguration.class })
static class Jdbc {
@Bean
public MessageGroupStore messageStore(JdbcTemplate jdbcTemplate, AggregatorFunctionProperties properties) {
JdbcMessageStore messageStore = new JdbcMessageStore(jdbcTemplate);
if (StringUtils.hasText(properties.getMessageStoreEntity())) {
messageStore.setTablePrefix(properties.getMessageStoreEntity());
}
return messageStore;
}
}
}

View File

@@ -0,0 +1,2 @@
org.springframework.boot.env.EnvironmentPostProcessor=\
org.springframework.cloud.fn.aggregator.ExcludeStoresAutoConfigurationEnvironmentPostProcessor

View File

@@ -0,0 +1 @@
org.springframework.cloud.fn.aggregator.AggregatorFunctionConfiguration