com.migratorydata.client

Class MigratoryDataKafkaUtils

java.lang.Object

com.migratorydata.client.MigratoryDataKafkaUtils

public class MigratoryDataKafkaUtils
extends Object

This utility class is designed to handle the encoding and decoding of Kafka records that are associated with MigratoryData messages

Constructor Summary

Constructors

Constructor and Description
MigratoryDataKafkaUtils()

Method Summary

Modifier and Type	Method and Description
static org.apache.kafka.common.header.Headers	addRecordMetadata(org.apache.kafka.common.header.Headers headers, boolean compression, MigratoryDataMessage.QoS qos, boolean retained) Add metadata to a Kafka record
static org.apache.kafka.common.header.Headers	addRecordMetadata(org.apache.kafka.common.header.Headers headers, boolean compression, MigratoryDataMessage.QoS qos, boolean retained, boolean benchmarkTimestamp) Add metadata to a Kafka record
static byte[]	compressValue(byte[] data) Compress the value of a Kafka record
static org.apache.kafka.clients.producer.ProducerRecord<String,byte[]>	createRecord(String topic, int partition, long timestamp, String key, byte[] value, boolean compression, MigratoryDataMessage.QoS qos, boolean retained) Creates a Kafka record with a specified timestamp to be sent to a specified topic and partition, with customizable quality of service, compression, and retention options for MigratoryData
static org.apache.kafka.clients.producer.ProducerRecord<String,byte[]>	createRecord(String topic, int partition, String key, byte[] value, boolean compression, MigratoryDataMessage.QoS qos, boolean retained) Creates a Kafka record to be sent to a specified topic and partition, with customizable quality of service, compression, and retention options for MigratoryData
static org.apache.kafka.clients.producer.ProducerRecord<String,byte[]>	createRecord(String topic, String key, byte[] value, boolean compression, MigratoryDataMessage.QoS qos, boolean retained) Creates a Kafka record to be sent to a specified topic, with customizable quality of service, compression, and retention options for MigratoryData
static org.apache.kafka.clients.producer.ProducerRecord<String,byte[]>	createRecord(String topic, String key, byte[] value, boolean compression, MigratoryDataMessage.QoS qos, boolean retained, boolean benchmarkTimestamp) Creates a Kafka record to be sent to a specified topic, with customizable quality of service, compression, and retention options for MigratoryData
static byte[]	decompressValue(byte[] data) Decompress the value of a Kafka record compressed with the compress method
static byte[]	getRecordValue(org.apache.kafka.clients.consumer.ConsumerRecord<String,byte[]> record) Get the content of a Kafka record corresponding to a MigratoryData message

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MigratoryDataKafkaUtils

public MigratoryDataKafkaUtils()

Method Detail

createRecord

public static org.apache.kafka.clients.producer.ProducerRecord<String,byte[]> createRecord(String topic,
                                                                                           String key,
                                                                                           byte[] value,
                                                                                           boolean compression,
                                                                                           MigratoryDataMessage.QoS qos,
                                                                                           boolean retained)

Creates a Kafka record to be sent to a specified topic, with customizable quality of service, compression, and retention options for MigratoryData

Parameters:

topic - The topic the record will be appended to

key - The key that will be included in the record

value - The record content

compression - Specify whether to compress the record content

qos - Define the quality of service (QoS) for delivery by MigratoryData; either QoS.STANDARD or QoS.GUARANTEED

retained - Specify if this record should be retained by MigratoryData as a snapshot message

Returns:

The Kafka record being created by this method

createRecord

public static org.apache.kafka.clients.producer.ProducerRecord<String,byte[]> createRecord(String topic,
                                                                                           int partition,
                                                                                           String key,
                                                                                           byte[] value,
                                                                                           boolean compression,
                                                                                           MigratoryDataMessage.QoS qos,
                                                                                           boolean retained)

Creates a Kafka record to be sent to a specified topic and partition, with customizable quality of service, compression, and retention options for MigratoryData

Parameters:

topic - The topic the record will be appended to

partition - The partition to which the record should be sent

key - The key that will be included in the record

value - The record content

compression - Specify whether to compress the record content

qos - Define the quality of service (QoS) for delivery by MigratoryData; either QoS.STANDARD or QoS.GUARANTEED

retained - Specify if this record should be retained by MigratoryData as a snapshot message

Returns:

The Kafka record being created by this method

createRecord

public static org.apache.kafka.clients.producer.ProducerRecord<String,byte[]> createRecord(String topic,
                                                                                           int partition,
                                                                                           long timestamp,
                                                                                           String key,
                                                                                           byte[] value,
                                                                                           boolean compression,
                                                                                           MigratoryDataMessage.QoS qos,
                                                                                           boolean retained)

Creates a Kafka record with a specified timestamp to be sent to a specified topic and partition, with customizable quality of service, compression, and retention options for MigratoryData

Parameters:

topic - The topic the record will be appended to

partition - The partition to which the record should be sent

timestamp - The timestamp of the record, in milliseconds since epoch. If null, the producer will assign the timestamp using System.currentTimeMillis().

key - The key that will be included in the record

value - The record content

compression - Specify whether to compress the record content

qos - Define the quality of service (QoS) for delivery by MigratoryData; either QoS.STANDARD or QoS.GUARANTEED

retained - Specify if this record should be retained by MigratoryData as a snapshot message

Returns:

The Kafka record being created by this method

createRecord

public static org.apache.kafka.clients.producer.ProducerRecord<String,byte[]> createRecord(String topic,
                                                                                           String key,
                                                                                           byte[] value,
                                                                                           boolean compression,
                                                                                           MigratoryDataMessage.QoS qos,
                                                                                           boolean retained,
                                                                                           boolean benchmarkTimestamp)

Creates a Kafka record to be sent to a specified topic, with customizable quality of service, compression, and retention options for MigratoryData

Parameters:

topic - The topic the record will be appended to

key - The key that will be included in the record

value - The record content

compression - Specify whether to compress the record content

qos - Define the quality of service (QoS) for delivery by MigratoryData; either QoS.STANDARD or QoS.GUARANTEED

retained - Specify if this record should be retained by MigratoryData as a snapshot message

benchmarkTimestamp - Specify if the record should include a timestamp for benchmarking purposes

Returns:

The Kafka record being created by this method

getRecordValue

public static byte[] getRecordValue(org.apache.kafka.clients.consumer.ConsumerRecord<String,byte[]> record)

Get the content of a Kafka record corresponding to a MigratoryData message

Parameters:

record - A Kafka record

Returns:

The content of a Kafka record corresponding to a MigratoryData message

compressValue

public static byte[] compressValue(byte[] data)

Compress the value of a Kafka record

Parameters:

data - The data to be compressed

Returns:

The compressed data

decompressValue

public static byte[] decompressValue(byte[] data)

Decompress the value of a Kafka record compressed with the compress method

Parameters:

data - The compressed data

Returns:

The decompressed data

addRecordMetadata

public static org.apache.kafka.common.header.Headers addRecordMetadata(org.apache.kafka.common.header.Headers headers,
                                                                       boolean compression,
                                                                       MigratoryDataMessage.QoS qos,
                                                                       boolean retained)

Add metadata to a Kafka record

Parameters:

headers - The headers of the Kafka record

compression - Specify whether to compress the record content

qos - Define the quality of service (QoS) for delivery by MigratoryData; either QoS.STANDARD or QoS.GUARANTEED

retained - Specify if this record should be retained by MigratoryData as a snapshot message

Returns:

The headers of the Kafka record with the added metadata

addRecordMetadata

public static org.apache.kafka.common.header.Headers addRecordMetadata(org.apache.kafka.common.header.Headers headers,
                                                                       boolean compression,
                                                                       MigratoryDataMessage.QoS qos,
                                                                       boolean retained,
                                                                       boolean benchmarkTimestamp)

Add metadata to a Kafka record

Parameters:

headers - The headers of the Kafka record

compression - Specify whether to compress the record content

qos - Define the quality of service (QoS) for delivery by MigratoryData; either QoS.STANDARD or QoS.GUARANTEED

retained - Specify if this record should be retained by MigratoryData as a snapshot message

benchmarkTimestamp - Specify if the record should include a timestamp for benchmarking purposes

Returns:

The headers of the Kafka record with the added metadata