com.hivemq.extensions.kafka.api.transformers.mqtttokafka.MqttToKafkaInput Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hivemq-kafka-extension-customization-sdk Show documentation

SDK for the development of HiveMQ Kafka Extension customizations

There is a newer version: 4.33.0

Show newest version

/*
 * Copyright 2020-present HiveMQ GmbH
 *
 * 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
 *
 *     http://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 com.hivemq.extensions.kafka.api.transformers.mqtttokafka;

import com.hivemq.extension.sdk.api.annotations.DoNotImplement;
import com.hivemq.extension.sdk.api.annotations.Immutable;
import com.hivemq.extension.sdk.api.annotations.NotNull;
import com.hivemq.extension.sdk.api.packets.publish.PublishPacket;
import com.hivemq.extensions.kafka.api.model.KafkaCluster;
import com.hivemq.extensions.kafka.api.services.KafkaTopicService;

/**
 * The input parameter of the {@link MqttToKafkaTransformer}. It contains the information of the to be transformed
 * {@link PublishPacket}.
 * 
 * Additionally, the MqttToKafkaInput allows access to the {@link KafkaCluster} and the {@link KafkaTopicService} for
 * this cluster.
 *
 * @author Christoph Schäbel
 * @author Georg Held
 * @since 4.4.0
 */
@Immutable
@DoNotImplement
public interface MqttToKafkaInput {

    /**
     * @return The {@link PublishPacket} that triggered this transformer call.
     * @since 4.4.0
     */
    @NotNull PublishPacket getPublishPacket();

    /**
     * @return The {@link KafkaTopicService} to interact with topics on the Kafka cluster.
     * @since 4.4.0
     */
    @NotNull KafkaTopicService getKafkaTopicService();

    /**
     * @return The {@link KafkaCluster} this transformer is associated with.
     * @since 4.4.0
     */
    @NotNull KafkaCluster getKafkaCluster();
}