diff --git a/README.md b/README.md index 8ec9b92..a69cef3 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ Are you having trouble using the extension? We'd like to help you out the best we can! There are a couple of things to consider when you're traversing anything Axon: -* Checking the [reference guide](https://library.axoniq.io/axon_framework_ref/) should be your first stop, +* Checking the [reference guide](https://library.axoniq.io/axon-framework-reference/) should be your first stop, as the majority of possible scenarios you might encounter when using Axon should be covered there. * If the Reference Guide does not cover a specific topic you would've expected, we'd appreciate if you could post a [new thread/topic on our library fourms describing the problem](https://discuss.axoniq.io/c/26). diff --git a/docs/extension-guide/modules/ROOT/pages/consuming.adoc b/docs/extension-guide/modules/ROOT/pages/consuming.adoc index ae4fe06..55c2c0d 100644 --- a/docs/extension-guide/modules/ROOT/pages/consuming.adoc +++ b/docs/extension-guide/modules/ROOT/pages/consuming.adoc @@ -1,7 +1,7 @@ :navtitle: Consuming Events From Kafka = Consuming Events from Kafka -Event messages in an Axon application can be consumed through either a Subscribing or a Tracking xref:axon_framework_ref:events:event-processors/README.adoc[Event Processor]. Both options are maintained when it comes to consuming events from a Kafka topic, which from a set-up perspective translates to a xref:#subscribable-message-source[SubscribableMessageSource] or a xref:#streamable-messasge-source[StreamableKafkaMessageSource] respectively, Both will be described in more detail later on, as we first shed light on the general requirements for event consumption in Axon through Kafka. +Event messages in an Axon application can be consumed through either a Subscribing or a Tracking xref:axon-framework-reference:events:event-processors/README.adoc[Event Processor]. Both options are maintained when it comes to consuming events from a Kafka topic, which from a set-up perspective translates to a xref:#subscribable-message-source[SubscribableMessageSource] or a xref:#streamable-messasge-source[StreamableKafkaMessageSource] respectively, Both will be described in more detail later on, as we first shed light on the general requirements for event consumption in Axon through Kafka. Both approaches use a similar mechanism to poll events with a Kafka `Consumer`, which breaks down to a combination of a `ConsumerFactory` and a `Fetcher`. The extension provides a `DefaultConsumerFactory`, whose sole requirement is a `Map` of configuration properties. The `Map` contains the settings to use for the Kafka `Consumer` client, such as the Kafka instance locations. Please check the link:https://kafka.apache.org/[Kafka documentation,window=_blank,role=external] for the possible settings and their values. diff --git a/docs/extension-guide/modules/ROOT/pages/message-format.adoc b/docs/extension-guide/modules/ROOT/pages/message-format.adoc index 7aab8c0..b2cd2f7 100644 --- a/docs/extension-guide/modules/ROOT/pages/message-format.adoc +++ b/docs/extension-guide/modules/ROOT/pages/message-format.adoc @@ -7,11 +7,11 @@ Albeit the default, this implementation allows for some customization, such as h The `SequencingPolicy` can be adjusted to change the behaviour of the record key being used. The default sequencing policy is the `SequentialPerAggregatePolicy`, which leads to the aggregate identifier of an event being the key of a `ProducerRecord` and `ConsumerRecord`. -The format of an event message defines an API between the producer and the consumer of the message. This API may change over time, leading to incompatibility between the event class' structure on the receiving side and the event structure of a message containing the old format. Axon addresses the topic of xref:axon_framework_ref:events:event-versioning.adoc[Event Versioning] by introducing Event Upcasters. The `DefaultKafkaMessageConverter` supports this by provisioning an `EventUpcasterChain` and run the upcasting process on the `MetaData` and `Payload` of individual messages converted from `ConsumerRecord` before those are passed to the `Serializer` and converted into `Event` instances. +The format of an event message defines an API between the producer and the consumer of the message. This API may change over time, leading to incompatibility between the event class' structure on the receiving side and the event structure of a message containing the old format. Axon addresses the topic of xref:axon-framework-reference:events:event-versioning.adoc[Event Versioning] by introducing Event Upcasters. The `DefaultKafkaMessageConverter` supports this by provisioning an `EventUpcasterChain` and run the upcasting process on the `MetaData` and `Payload` of individual messages converted from `ConsumerRecord` before those are passed to the `Serializer` and converted into `Event` instances. Note that the `KafkaMessageConverter` feeds the upcasters with messages one-by-one, limiting it to one-to-one or one-to-many upcasting only. Upcasters performing a many-to-one or many-to-many operation thus won't be able to operate inside the extension (yet). -Lastly, the `Serializer` used by the converter can be adjusted. See the xref:axon_framework_ref:ROOT:serialization.adoc[Serializer] section for more details on this. +Lastly, the `Serializer` used by the converter can be adjusted. See the xref:axon-framework-reference:ROOT:serialization.adoc[Serializer] section for more details on this. [source,java] ---- diff --git a/docs/extension-guide/modules/ROOT/pages/publishing.adoc b/docs/extension-guide/modules/ROOT/pages/publishing.adoc index ae60bc6..b6ab8f8 100644 --- a/docs/extension-guide/modules/ROOT/pages/publishing.adoc +++ b/docs/extension-guide/modules/ROOT/pages/publishing.adoc @@ -3,7 +3,7 @@ When Event Messages are published to an Event Bus (or Event Store), they can be forwarded to a Kafka topic using the `KafkaPublisher`. To achieve this it will utilize a Kafka `Producer`, retrieved through Axon's `ProducerFactory`. The `KafkaPublisher` in turn receives the events to publish from a `KafkaEventPublisher`. -Since the `KafkaEventPublisher` is an event message handler in Axon terms, we can provide it to any xref:axon_framework_ref:events:event-processors/README.adoc[Event Processor] to receive the published events. The choice of event processor which brings differing characteristics for event publication to Kafka: +Since the `KafkaEventPublisher` is an event message handler in Axon terms, we can provide it to any xref:axon-framework-reference:events:event-processors/README.adoc[Event Processor] to receive the published events. The choice of event processor which brings differing characteristics for event publication to Kafka: - *Subscribing Event Processor* - publication of messages to Kafka will occur in the same thread (and Unit of Work) which published the events to the event bus. This approach ensures failure to publish to Kafka enforces failure of the initial event publication on the event bus