Class AbstractKafkaHeaderMapper
java.lang.Object
org.springframework.kafka.support.AbstractKafkaHeaderMapper
- All Implemented Interfaces:
KafkaHeaderMapper
- Direct Known Subclasses:
DefaultKafkaHeaderMapper
,SimpleKafkaHeaderMapper
Base for Kafka header mappers.
- Since:
- 2.1.3
- Author:
- Gary Russell, Artem Bilan
-
Nested Class Summary
Modifier and TypeClassDescriptionprotected static interface
A matcher for headers.protected static class
A matcher that never matches a set of headers.protected static class
A pattern-based header matcher that matches if the specified header matches the specified simple pattern. -
Field Summary
-
Constructor Summary
ModifierConstructorDescriptionprotected
AbstractKafkaHeaderMapper
(boolean outbound, String... patterns) Construct a mapper that will match the supplied patterns (outbound) and all headers (inbound).AbstractKafkaHeaderMapper
(String... patterns) Construct a mapper that will match the supplied patterns (outbound) and all headers (inbound). -
Method Summary
Modifier and TypeMethodDescriptionprotected final void
addMatchers
(AbstractKafkaHeaderMapper.HeaderMatcher... matchersToAdd) Subclasses can invoke this to add customAbstractKafkaHeaderMapper.HeaderMatcher
s.void
addRawMappedHeader
(String name, boolean toString) Add a raw mapped header.protected Charset
protected Object
headerValueToAddIn
(org.apache.kafka.common.header.Header header) Check if the header value should be mapped to a String, if so configured.protected Object
headerValueToAddOut
(String key, Object value) Check if the value is a String and convert to byte[], if so configured.protected boolean
protected boolean
protected boolean
matchesForInbound
(String header) Matches header names for inbound mapping when configured as an inbound mapper.void
setCharset
(Charset charset) Set the charset to use when mapping String-valued headers to/from byte[].void
setMapAllStringsOut
(boolean mapAllStringsOut) Set to true to map allString
valued outbound headers tobyte[]
.void
setRawMappedHeaders
(Map<String, Boolean> rawMappedHeaders) Set the headers to not perform any conversion on (exceptString
tobyte[]
for outbound).Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.springframework.kafka.support.KafkaHeaderMapper
fromHeaders, toHeaders
-
Field Details
-
logger
-
-
Constructor Details
-
AbstractKafkaHeaderMapper
Construct a mapper that will match the supplied patterns (outbound) and all headers (inbound). For outbound mapping, certain internal framework headers are never mapped.- Parameters:
patterns
- the patterns.
-
AbstractKafkaHeaderMapper
Construct a mapper that will match the supplied patterns (outbound) and all headers (inbound). For outbound mapping, certain internal framework headers are never mapped.- Parameters:
outbound
- true for an outbound mapper.patterns
- the patterns.
-
-
Method Details
-
addMatchers
Subclasses can invoke this to add customAbstractKafkaHeaderMapper.HeaderMatcher
s.- Parameters:
matchersToAdd
- the matchers to add.- Since:
- 2.3
-
setMapAllStringsOut
public void setMapAllStringsOut(boolean mapAllStringsOut) Set to true to map allString
valued outbound headers tobyte[]
. To map to aString
for inbound, there must be an entry in the rawMappedHeaders map.- Parameters:
mapAllStringsOut
- true to map all strings.- Since:
- 2.2.5
- See Also:
-
getCharset
-
setCharset
Set the charset to use when mapping String-valued headers to/from byte[]. Default UTF-8.- Parameters:
charset
- the charset.- Since:
- 2.2.5
- See Also:
-
setRawMappedHeaders
Set the headers to not perform any conversion on (exceptString
tobyte[]
for outbound). Inbound headers that match will be mapped asbyte[]
unless the corresponding boolean in the map value is true, in which case it will be mapped as a String.- Parameters:
rawMappedHeaders
- the header names to not convert and- Since:
- 2.2.5
- See Also:
-
addRawMappedHeader
Add a raw mapped header.- Parameters:
name
- the header name.toString
- convert to string on inbound when true.- Since:
- 2.7.1
- See Also:
-
matches
-
matches
-
matchesForInbound
Matches header names for inbound mapping when configured as an inbound mapper.- Parameters:
header
- the header name.- Returns:
- true if it can be mapped.
- Since:
- 2.8.8
-
headerValueToAddOut
Check if the value is a String and convert to byte[], if so configured.- Parameters:
key
- the header name.value
- the header value.- Returns:
- the value to add.
- Since:
- 2.2.5
-
headerValueToAddIn
Check if the header value should be mapped to a String, if so configured.- Parameters:
header
- the header.- Returns:
- the value to add.
-