io.streamnative.kafka.client.api.ProduceContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kafka-client-api Show documentation
The Kafka client API without any Kafka dependency
The newest version!
/**
 * Copyright (c) 2019 - 2024 StreamNative, Inc.. All Rights Reserved.
 */
/**
 * 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 io.streamnative.kafka.client.api;

import java.lang.reflect.InvocationTargetException;
import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.Future;
import java.util.function.BiFunction;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.RequiredArgsConstructor;
import lombok.Setter;
import lombok.experimental.Accessors;

/**
 * Context for producing messages.
 */
@Getter
@RequiredArgsConstructor
public class ProduceContext {

    private final Producer producer;
    private final String topic;
    private final Integer partition;
    private final Long timestamp;
    private final K key;
    private final V value;
    private final List headers;
    private final CompletableFuture future = new CompletableFuture<>();

    /**
     * Create an instance of Kafka's ProducerRecord
     * for kafka version higher than or equal to 0.11.x.
     *
     * @param clazz the class type of Kafka's ProducerRecord
     * @param headerConstructor the constructor of Kafka's Header implementation
     * @param  it should be org.apache.kafka.clients.producer.ProducerRecord
     * @param  it should be an implementation of org.apache.kafka.common.header.Header, e.g. RecordHeader
     * @return an instance of org.apache.kafka.clients.producer.ProducerRecord
     */
    public  T createV2ProducerRecord(final Class clazz,
                                               final BiFunction headerConstructor) {
        try {
            return clazz.getConstructor(
                    String.class, Integer.class, Long.class, Object.class, Object.class, Iterable.class
            ).newInstance(topic, partition, timestamp, key, value, Header.toHeaders(headers, headerConstructor));
        } catch (InstantiationException
                | IllegalAccessException
                | InvocationTargetException
                | NoSuchMethodException e) {
            throw new IllegalArgumentException(e);
        }
    }

    /**
     * Create an instance of Kafka's ProducerRecord less than 0.11.x.
     * Because there is no header in ProducerRecord before 0.11.x.
     *
     * @param clazz the class type of Kafka's ProducerRecord
     * @param  it should be org.apache.kafka.clients.producer.ProducerRecord
     * @return an instance of org.apache.kafka.clients.producer.ProducerRecord
     */
    public  T createV1ProducerRecord(final Class clazz) {
        try {
            return clazz.getConstructor(
                    String.class, Integer.class, Long.class, Object.class, Object.class
            ).newInstance(topic, partition, timestamp, key, value);
        } catch (InstantiationException
                | IllegalAccessException
                | InvocationTargetException
                | NoSuchMethodException e) {
            throw new IllegalArgumentException(e);
        }
    }

    /**
     * Create an instance of Kafka's ProducerRecord less than 0.10.x.
     * Because there is no timestamp in ProducerRecord before 0.10.x.
     *
     * @param clazz the class type of Kafka's ProducerRecord
     * @param  it should be org.apache.kafka.clients.producer.ProducerRecord
     * @return an instance of org.apache.kafka.clients.producer.ProducerRecord
     */
    public  T createV0ProducerRecord(final Class clazz) {
        try {
            return clazz.getConstructor(
                    String.class, Integer.class, Object.class, Object.class
            ).newInstance(topic, partition, key, value);
        } catch (InstantiationException
                | IllegalAccessException
                | InvocationTargetException
                | NoSuchMethodException e) {
            throw new IllegalArgumentException(e);
        }
    }

    /**
     * Complete the internal `future` field.
     *
     * @param metadata the instance of Kafka's RecordMetadata
     * @param e the exception to complete exceptionally if it's not null
     * @param  it should be org.apache.kafka.clients.producer.RecordMetadata
     */
    public  void complete(final T metadata, final Exception e) {
        if (e == null) {
            future.complete(RecordMetadata.create(metadata));
        } else {
            future.completeExceptionally(e);
        }
    }

    /**
     * Send the message using ProduceContext instead of using Producer directly.
     *
     * @see Producer#sendAsync(ProduceContext)
     */
    public Future sendAsync() {
        if (producer == null) {
            throw new IllegalArgumentException("producer is null");
        }
        return producer.sendAsync(this);
    }

    public static  ProduceContextBuilder builder() {
        return new ProduceContextBuilder<>();
    }

    @Accessors(fluent = true)
    @NoArgsConstructor
    @Setter
    public static class ProduceContextBuilder {

        private Producer producer;
        private String topic;
        private Integer partition;
        private Long timestamp;
        private K key;
        private V value;
        private List headers;

        public ProduceContext build() {
            return new ProduceContext<>(producer, topic, partition, timestamp, key, value, headers);
        }
    }
}