|
28 | 28 | * called concurrently and must be thread-safe.
|
29 | 29 | * <p>
|
30 | 30 | * Your implementation of the KafkaToMqttTransformer must be placed in a Java archive (.jar) together with all its
|
31 |
| - * dependencies in the {@code customizations} folder of the HiveMQ Enterprise Extension for Kafka. In addition a {@code |
32 |
| - * <kafka-to-mqtt-transformer>} referencing the implementing class via its canonical name must be configured in the |
33 |
| - * {@code kafka-extension.xml} file. |
| 31 | + * dependencies in the {@code customizations} folder of the "HiveMQ Enterprise Extension for Kafka". In addition, a |
| 32 | + * {@code <kafka-to-mqtt-transformer>} referencing the implementing class via its canonical name must be configured in |
| 33 | + * the {@code kafka-extension.xml} file. |
34 | 34 | *
|
35 | 35 | * @author Christoph Schäbel
|
36 | 36 | * @author Georg Held
|
|
41 | 41 | public interface KafkaToMqttTransformer extends Transformer<KafkaToMqttInitInput> {
|
42 | 42 |
|
43 | 43 | /**
|
44 |
| - * This callback is executed for every {@link com.hivemq.extensions.kafka.api.model.KafkaRecord KafkaRecord} that is |
45 |
| - * polled by the HiveMQ Enterprise Extension for Kafka and matches the {@code <mqtt-to-kafka-transformer>} tag |
46 |
| - * configured in the {@code <mqtt-topic-filters>}. It allows the publication of any number of {@link |
| 44 | + * This callback is executed for every {@link com.hivemq.extensions.kafka.api.model.KafkaRecord KafkaRecord} that |
| 45 | + * the "HiveMQ Enterprise Extension for Kafka" polls from Kafka according to the configured {@code <kafka-topics>} |
| 46 | + * in the {@code <kafka-to-mqtt-transformer>} tag. |
| 47 | + * <p> |
| 48 | + * It allows the publication of any number of {@link |
47 | 49 | * com.hivemq.extension.sdk.api.services.publish.Publish Publishes} via the {@link KafkaToMqttOutput} object. This
|
48 | 50 | * method is called by multiple threads concurrently. Extensions are responsible for their own exception handling
|
49 | 51 | * and this method must not throw any {@link Exception}.
|
50 | 52 | *
|
51 |
| - * @param input the {@link KafkaToMqttInput} contains the triggering |
| 53 | + * @param input The {@link KafkaToMqttInput} contains the triggering |
52 | 54 | * {@link com.hivemq.extensions.kafka.api.model.KafkaRecord
|
53 | 55 | * KafkaRecord} and the {@link com.hivemq.extensions.kafka.api.model.KafkaCluster KafkaCluster}
|
54 | 56 | * information.
|
55 |
| - * @param output the {@link KafkaToMqttOutput} allows to {@link KafkaToMqttOutput#setPublishes(java.util.List) |
56 |
| - * provide a list of Publishes}. If no output is set, a empty List is used as default and the kafka |
| 57 | + * @param output The {@link KafkaToMqttOutput} allows to {@link KafkaToMqttOutput#setPublishes(java.util.List) |
| 58 | + * provide a list of Publishes}. If no output is set, an empty List is used as default and the kafka |
57 | 59 | * record will not be processed again, but ignored.
|
58 | 60 | * @since 4.5.0
|
59 | 61 | */
|
|
0 commit comments