Package com.hivemq.extensions.kafka.api.transformers.kafkatomqtt

Interface KafkaToMqttOutput

@DoNotImplement
public interface KafkaToMqttOutput

The output parameter of the KafkaToMqttTransformer. It allows access to the PublishBuilder.

After the KafkaToMqttTransformer.transformKafkaToMqtt(KafkaToMqttInput, KafkaToMqttOutput) method returns the Publishes given to this output will be published by HiveMQ.

Since:

4.5.0

Method Summary

Modifier and Type	Method	Description
@NotNull PublishBuilder	newPublishBuilder()
void	setPublishes(@NotNull List<@NotNull Publish> publishes)	Sets the Publishes, that will be published by HiveMQ after the KafkaToMqttTransformer.transformKafkaToMqtt(KafkaToMqttInput, KafkaToMqttOutput) call returns.

Method Detail

newPublishBuilder

@NotNull
@NotNull PublishBuilder newPublishBuilder()

Returns:

A new PublishBuilder.

Since:

4.5.0

setPublishes

void setPublishes(@NotNull
                  @NotNull List<@NotNull Publish> publishes)

Sets the Publishes, that will be published by HiveMQ after the KafkaToMqttTransformer.transformKafkaToMqtt(KafkaToMqttInput, KafkaToMqttOutput) call returns. The "HiveMQ Enterprise Extension for Kafka" will publish these publishes in the order provided by the publishes argument.

If desired, the same publish can occupy multiple places in the publishes list. When no publish shall be published by HiveMQ for a KafkaRecord, call this method with an empty list.

Use the PublishBuilder to create new publishes as desired.

Each additional call of this method will overwrite the previous one.

Parameters:

publishes - A list of to be published Publishes.

Throws:

NullPointerException - If publishes or any element of it is null.

IllegalArgumentException - If any element in publishes was not created via a PublishBuilder.

Since:

4.5.0