Package org.springframework.kafka.support.serializer

Class DelegatingSerializer

java.lang.Object

org.springframework.kafka.support.serializer.DelegatingSerializer

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.kafka.common.serialization.Serializer<Object>

public class DelegatingSerializer
extends Object
implements org.apache.kafka.common.serialization.Serializer<Object>

A Serializer that delegates to other serializers based on a serialization selector header. If the header is missing, and the type is supported by Serdes we will delegate to that serializer type.

Since:

2.3

Author:

Gary Russell

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY_SERIALIZATION_SELECTOR	Name of the header containing the serialization selector for keys.
static final String	KEY_SERIALIZATION_SELECTOR_CONFIG	Name of the configuration property containing the serialization selector map for keys with format selector:class,....
static final String	VALUE_SERIALIZATION_SELECTOR	Name of the header containing the serialization selector for values.
static final String	VALUE_SERIALIZATION_SELECTOR_CONFIG	Name of the configuration property containing the serialization selector map for values with format selector:class,....

Constructor Summary

Constructors

Constructor	Description
DelegatingSerializer()	Construct an instance that will be configured in configure(Map, boolean) with producer properties VALUE_SERIALIZATION_SELECTOR_CONFIG and KEY_SERIALIZATION_SELECTOR_CONFIG.
DelegatingSerializer(Map<String,org.apache.kafka.common.serialization.Serializer<?>> delegates)	Construct an instance with the supplied mapping of selectors to delegate serializers.

Method Summary

Modifier and Type	Method	Description
void	addDelegate(String selector, org.apache.kafka.common.serialization.Serializer<?> serializer)
void	close()
void	configure(Map<String,?> configs, boolean isKey)
protected static Map<String,org.apache.kafka.common.serialization.Serializer<?>>	createDelegates(String mappings, Map<String,?> configs, boolean isKey)
protected static void	createInstanceAndConfigure(Map<String,?> configs, boolean isKey, Map<String,org.apache.kafka.common.serialization.Serializer<?>> delegateMap, String selector, String className)
protected static void	instantiateAndConfigure(Map<String,?> configs, boolean isKey, Map<String,org.apache.kafka.common.serialization.Serializer<?>> delegateMap, String selector, Class<?> clazz)
org.apache.kafka.common.serialization.Serializer<?>	removeDelegate(String selector)
byte[]	serialize(String topic, Object data)
byte[]	serialize(String topic, org.apache.kafka.common.header.Headers headers, Object data)

Methods inherited from class java.lang.Object

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

Field Details

VALUE_SERIALIZATION_SELECTOR

public static final String VALUE_SERIALIZATION_SELECTOR

Name of the header containing the serialization selector for values.

See Also:

• Constant Field Values

KEY_SERIALIZATION_SELECTOR

public static final String KEY_SERIALIZATION_SELECTOR

Name of the header containing the serialization selector for keys.

See Also:

• Constant Field Values

VALUE_SERIALIZATION_SELECTOR_CONFIG

public static final String VALUE_SERIALIZATION_SELECTOR_CONFIG

Name of the configuration property containing the serialization selector map for values with format selector:class,....

See Also:

• Constant Field Values

KEY_SERIALIZATION_SELECTOR_CONFIG

public static final String KEY_SERIALIZATION_SELECTOR_CONFIG

Name of the configuration property containing the serialization selector map for keys with format selector:class,....

See Also:

• Constant Field Values

Constructor Details

DelegatingSerializer

public DelegatingSerializer()

Construct an instance that will be configured in configure(Map, boolean) with producer properties VALUE_SERIALIZATION_SELECTOR_CONFIG and KEY_SERIALIZATION_SELECTOR_CONFIG.

DelegatingSerializer

public DelegatingSerializer(Map<String,org.apache.kafka.common.serialization.Serializer<?>> delegates)

Construct an instance with the supplied mapping of selectors to delegate serializers. The selector must be supplied in the KEY_SERIALIZATION_SELECTOR and/or VALUE_SERIALIZATION_SELECTOR headers. It is not necessary to configure standard serializers supported by Serdes.

Parameters:

delegates - the map of delegates.

Method Details

configure

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

Specified by:

configure in interface org.apache.kafka.common.serialization.Serializer<Object>

createDelegates

protected static Map<String,org.apache.kafka.common.serialization.Serializer<?>> createDelegates(String mappings,
 Map<String,?> configs,
 boolean isKey)

createInstanceAndConfigure

protected static void createInstanceAndConfigure(Map<String,?> configs,
 boolean isKey,
 Map<String,org.apache.kafka.common.serialization.Serializer<?>> delegateMap,
 String selector,
 String className)

instantiateAndConfigure

protected static void instantiateAndConfigure(Map<String,?> configs,
 boolean isKey,
 Map<String,org.apache.kafka.common.serialization.Serializer<?>> delegateMap,
 String selector,
 Class<?> clazz)

addDelegate

public void addDelegate(String selector,
 org.apache.kafka.common.serialization.Serializer<?> serializer)

removeDelegate

@Nullable
public org.apache.kafka.common.serialization.Serializer<?> removeDelegate(String selector)

serialize

public byte[] serialize(String topic,
 Object data)

Specified by:

serialize in interface org.apache.kafka.common.serialization.Serializer<Object>

serialize

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

Specified by:

serialize in interface org.apache.kafka.common.serialization.Serializer<Object>

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface org.apache.kafka.common.serialization.Serializer<Object>