reactor.kafka.receiver.ReceiverRecord Maven / Gradle / Ivy

/*
 * Copyright (c) 2016-2021 VMware Inc. or its affiliates, 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
 *
 *   https://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 reactor.kafka.receiver;

import org.apache.kafka.clients.consumer.ConsumerRecord;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

/**
 * Represents an incoming record dispatched by {@link KafkaReceiver}.
 *
 * @param  Incoming record key type
 * @param  Incoming record value type
 */
public class ReceiverRecord extends ConsumerRecord {

    private static final Method CHECKSUM_METHOD;

    static {
        Method method;
        try {
            method = ConsumerRecord.class.getDeclaredMethod("checksum");
        } catch (NoSuchMethodException | SecurityException e) {
            method = null;
        }
        CHECKSUM_METHOD = method;
    }

    private final ReceiverOffset receiverOffset;

    @SuppressWarnings("deprecation")
    public ReceiverRecord(ConsumerRecord consumerRecord, ReceiverOffset receiverOffset) {
        super(consumerRecord.topic(),
                consumerRecord.partition(),
                consumerRecord.offset(),
                consumerRecord.timestamp(),
                consumerRecord.timestampType(),
                checksum(consumerRecord),
                consumerRecord.serializedKeySize(),
                consumerRecord.serializedValueSize(),
                consumerRecord.key(),
                consumerRecord.value(),
                consumerRecord.headers());
        this.receiverOffset = receiverOffset;
    }

    private static Long checksum(@SuppressWarnings("rawtypes") ConsumerRecord consumerRecord) {
        Long checksum = -1L;
        if (CHECKSUM_METHOD != null) {
            try {
                checksum = (Long) CHECKSUM_METHOD.invoke(consumerRecord);
            } catch (IllegalAccessException | IllegalArgumentException | InvocationTargetException e) {
                throw new IllegalStateException(e);
            }
        }
        return checksum;
    }

    /**
     * Returns an acknowledgeable offset instance that should be acknowledged after this
     * record has been consumed. Acknowledged records are automatically committed
     * based on the commit batch size and commit interval configured for the {@link KafkaReceiver}.
     * Acknowledged records may be also committed using {@link ReceiverOffset#commit()}.
     *
     * @return offset to acknowledge after record is processed
     */
    public ReceiverOffset receiverOffset() {
        return receiverOffset;
    }
}