Skip to content
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.

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

Deprecate own kafka implementation, recommend use of new spring-kafka, #470

Merged
merged 13 commits into from
Nov 2, 2021
2 changes: 2 additions & 0 deletions documentation/guide-kafka.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
:toc: macro
toc::[]

WARNING: devon4j-kafka has been abandoned. Its main feature was the implementation of a retry pattern using multiple topics. This implementation has become an integral part of Spring Kafka. We recommend to use Spring Kafkas own implemenation for retries.

= Messaging Services

Messaging Services provide an asynchronous communication mechanism between applications. Technically this is implemented using http://kafka.apache.org/documentation.html/[Apache Kafka] .
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,10 @@
*
* @param <K> the key type.
* @param <V> the value type.
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
public interface MessageSender<K, V> {

/**
Expand Down Expand Up @@ -43,4 +45,4 @@ public interface MessageSender<K, V> {
*/
void sendMessageAndWait(ProducerRecord<K, V> producerRecord, int timeout) throws Exception;

}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@

/**
* Kafka Common Properties class which contains properties for the {@link KafkaProducer}} and {@link KafkaConsumer}}.
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
public class KafkaCommonProperties {

private String bootstrapServers;
Expand Down Expand Up @@ -346,7 +350,7 @@ public Integer getRequestTimeoutMs() {

/**
* Set the requestTimeoutMs for {@link #getRequestTimeoutMs()}
*
*
* @param requestTimeoutMs the request timeout in milliseconds.
*/
public void setRequestTimeoutMs(Integer requestTimeoutMs) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@
* This is a property class to create configuration for the {@link MessageReceiverConfig} by setting parameter for
* {@link ConsumerConfig} to create {@link ConsumerFactory}.
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
public class KafkaConsumerProperties {

private Integer autoCommitIntervalMs;
Expand Down Expand Up @@ -478,7 +481,7 @@ public String getIsolationLevel() {

/**
* Set the isolationLevel for {@link #getIsolationLevel()}.
*
*
* @param isolationLevel the isolation level
*/
public void setIsolationLevel(String isolationLevel) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@

/**
* This is a property class used to create configuration for {@link MessageReceiverConfig}.
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
public class KafkaListenerContainerProperties {

private Integer ackCount;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,11 @@
/**
* This is a property class to create configuration for for {@link MessageSenderConfig} by setting parameter for
* {@link ProducerConfig} to create {@link ProducerFactory}.
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
public class KafkaProducerProperties {

private String acks;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,10 @@
* {@link MessageLoggingSupport}, {@link KafkaHealthIndicatorProperties}, {@link KafkaHealthIndicator} and
* {@link ConsumerFactory}.
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
@Configuration
@EnableConfigurationProperties
public class MessageCommonConfig {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,11 @@

/**
* A class used to create a configuration for the custom message receiver.
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
@Configuration
@EnableKafka
@EnableAspectJAutoProxy
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,10 @@
/**
* A configuration class for the {@link MessageSender}
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
@Configuration
@Import(MessageCommonConfig.class)
public class MessageSenderConfig {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@

/**
* A property class used to configure for {@link MessageSender}
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
public class MessageSenderProperties {

private int defaultSendTimeoutSeconds = 60;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@
/**
* A property class which is used to configure for {@link KafkaHealthIndicator}
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
public class KafkaHealthIndicatorProperties {

private int timeout = 60;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,11 @@

/**
* A class used to create a configuration for the custom message receiver.
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
@Configuration
@Import(MessageReceiverConfig.class)
public class MessageHealthIndicatorConfig {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@
/**
* An Enum class to specify the Health status.
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
public enum HealthStatus {

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,10 @@
* @param <K> the key type
* @param <V> the value type
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
public class KafkaHealthIndicator<K, V> implements HealthIndicator {

private final ConsumerFactory<K, V> consumerFactory;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@

/**
* This class is used to indicate the health.
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
public class TopicHealthInfo {

private String topic;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,10 @@
*
* @param <K> the key type.
* @param <V> the value type.
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
public class MessageSenderImpl<K, V> implements MessageSender<K, V> {

private static final Logger LOG = LoggerFactory.getLogger(MessageSenderImpl.class);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,10 @@
/**
* This class is an implementation of {@link BeanPostProcessor}.
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
public class ConsumerGroupResolver implements BeanPostProcessor {

private static final String DEFAULT_BEAN_NAME = KafkaListenerAnnotationBeanPostProcessor.DEFAULT_KAFKA_LISTENER_CONTAINER_FACTORY_BEAN_NAME;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@

/**
* An Enum keys to represent Log String format.
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
public enum EventKey {

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@
* This is an implementation class for the {@link ErrorHandler}. This class handles the exception by logging the error
* message and the exception thrown.
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
public class LoggingErrorHandler implements ErrorHandler {

private static final Logger LOG = LoggerFactory.getLogger(LoggingErrorHandler.class);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,10 @@
* @param <K> the key type
* @param <V> the value type
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
@Aspect
@Order(0)
public class MessageListenerLoggingAspect<K, V> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@

/**
* This class is used to log the message events by using {@link EventKey} string formats.
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
public class MessageLoggingSupport {

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@
*
* @param <K> The key type
* @param <V> The value type
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
public class ProducerLoggingListener<K, V> implements ProducerListener<K, V> {

private static final Logger LOG = LoggerFactory.getLogger(ProducerLoggingListener.class);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@
/**
* An Enum class to indicate multiple event results of retry pattern.
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
public enum MessageRetryProcessingResult {

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@
/**
* An Enum class to indicate current retry patter state.
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
public enum RetryState {

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,11 @@
*
* @param <K> the key type.
* @param <V> the value type.
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@FunctionalInterface
@Deprecated
public interface KafkaRecordSupport<K, V> {

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@
/**
* This interface is used to calculate next retry time stamps.
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
public interface MessageBackOffPolicy {

/**
Expand All @@ -24,7 +27,7 @@ public interface MessageBackOffPolicy {
/**
* This method is used to make the thread to sleep for {@link DefaultBackOffPolicyProperties#getRetryReEnqueueDelay()}
* seconds.
*
*
* @param topic the topic
*/
void sleepBeforeReEnqueue(String topic);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,12 @@
* @param <K> the key type.
* @param <V> the value type.
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*
*/
@FunctionalInterface
@Deprecated
public interface MessageProcessor<K, V> {

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,11 @@
*
* @param <K> the key type.
* @param <V> the value type.
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
public interface MessageRetryHandler<K, V> {

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@
*
* @param <K> the key type.
* @param <V> the value type.
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@FunctionalInterface
@Deprecated
public interface MessageRetryOperations<K, V> {

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@
*
* @param <K> the key type.
* @param <V> the value type.
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
public interface MessageRetryPolicy<K, V> {

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@
/**
* This is a property class to define the retry pattern for {@link MessageBackOffPolicy}
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
public class DefaultBackOffPolicyProperties {

private Map<String, Long> retryDelay = new HashMap<>();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,10 @@
/**
* This is a property class for {@link DefaultRetryPolicy}.
*
* @deprecated The implementation of devon4j-kafka will be abandoned. It is superseeded by Springs Kafka
* implementation.
*/
@Deprecated
public class DefaultRetryPolicyProperties {

private Map<String, Long> retryPeriod = new HashMap<>();
Expand Down
Loading