io.quicksign.kafka.crypto

Class CryptoDeserializer<T>

java.lang.Object

io.quicksign.kafka.crypto.CryptoDeserializer<T>

Type Parameters:

T -

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.kafka.common.serialization.Deserializer<T>, org.apache.kafka.common.serialization.ExtendedDeserializer<T>

public class CryptoDeserializer<T>
extends Object
implements org.apache.kafka.common.serialization.ExtendedDeserializer<T>

Deserializer for encrypted data

If the data to deserialize starts with the magic bytes KafkaCryptoConstants.ENCRYPTED_PREFIX, then the data is decrypted using the Decryptor.The result is then deserialized using the underlying Deserializer. If the data where not successfully decrypted, the result of the deserialization will be null

If the data to deserialize does not starts with the magic bytes, it is directly deserialized using the underlying Deserializer

Please note that this Deserializer has no default constructor, so it can not be configured via properties. So if you want to use it into a Consumer, you will have to use org.apache.kafka.clients.consumer.KafkaConsumer#KafkaConsumer(Properties, Deserializer, Deserializer) or org.apache.kafka.clients.consumer.KafkaConsumer#KafkaConsumer(Map, Deserializer, Deserializer) with your instance of CryptoDeserializer

See Also:

CryptoSerializer, Decryptor

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.kafka.common.serialization.ExtendedDeserializer

org.apache.kafka.common.serialization.ExtendedDeserializer.Wrapper<T>

Constructor Summary

Constructors

Constructor and Description
CryptoDeserializer(org.apache.kafka.common.serialization.ExtendedDeserializer<? extends T> rawDeserializer, Decryptor decryptor)

Method Summary

Modifier and Type	Method and Description
void	close()
void	configure(Map<String,?> configs, boolean isKey)
T	deserialize(String topic, byte[] data) deserialize the data (with decryption if needed) It is equivalent to:
T	deserialize(String topic, org.apache.kafka.common.header.Headers headers, byte[] data) deserialize the data (with decryption if needed) The keyref used to deserialize the data will be added to the header KafkaCryptoConstants.KEY_REF_HEADER (may be null)

Methods inherited from class java.lang.Object

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

Constructor Detail

CryptoDeserializer

public CryptoDeserializer(org.apache.kafka.common.serialization.ExtendedDeserializer<? extends T> rawDeserializer,
                          Decryptor decryptor)

Parameters:

rawDeserializer - deserializer to deserialize clear data

decryptor - Decryptor used to decrypt the data

Method Detail

deserialize

public T deserialize(String topic,
                     org.apache.kafka.common.header.Headers headers,
                     byte[] data)

deserialize the data (with decryption if needed) The keyref used to deserialize the data will be added to the header KafkaCryptoConstants.KEY_REF_HEADER (may be null)

Specified by:

deserialize in interface org.apache.kafka.common.serialization.ExtendedDeserializer<T>

Parameters:

topic -

headers - they will be enriched with header KafkaCryptoConstants.KEY_REF_HEADER

data -

Returns:

the deserialized data

configure

public void configure(Map<String,?> configs,
                      boolean isKey)

Specified by:

configure in interface org.apache.kafka.common.serialization.Deserializer<T>

deserialize

public T deserialize(String topic,
                     byte[] data)

deserialize the data (with decryption if needed) It is equivalent to:

  deserialize(topic, new RecordHeaders(), data);
 

Specified by:

deserialize in interface org.apache.kafka.common.serialization.Deserializer<T>

Parameters:

topic -

data -

Returns:

See Also:

deserialize(String, Headers, byte[])

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface org.apache.kafka.common.serialization.Deserializer<T>