Skip to content

Commit 84b6f29

Browse files
artembilangaryrussell
authored andcommitted
Fix typos in the AbstractKafkaHeaderMapper (#1077)
* Fix typos in the `AbstractKafkaHeaderMapper` * * Fix `DefaultKafkaHeaderMapperTests` for changed methods
1 parent 831521a commit 84b6f29

File tree

5 files changed

+30
-34
lines changed

5 files changed

+30
-34
lines changed

spring-kafka/src/main/java/org/springframework/kafka/support/AbstractKafkaHeaderMapper.java

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
import java.text.MessageFormat;
2222
import java.util.ArrayList;
2323
import java.util.Arrays;
24+
import java.util.Collections;
2425
import java.util.HashMap;
2526
import java.util.List;
2627
import java.util.Map;
@@ -41,6 +42,8 @@
4142
* Base for Kafka header mappers.
4243
*
4344
* @author Gary Russell
45+
* @author Artem Bilan
46+
*
4447
* @since 2.1.3
4548
*
4649
*/
@@ -50,7 +53,7 @@ public abstract class AbstractKafkaHeaderMapper implements KafkaHeaderMapper {
5053

5154
private final List<HeaderMatcher> matchers = new ArrayList<>();
5255

53-
private final Map<String, Boolean> rawMappedtHeaders = new HashMap<>();
56+
private final Map<String, Boolean> rawMappedHeaders = new HashMap<>();
5457

5558
private boolean mapAllStringsOut;
5659

@@ -88,17 +91,15 @@ public AbstractKafkaHeaderMapper(String... patterns) {
8891
protected final void addMatchers(HeaderMatcher... matchersToAdd) {
8992
Assert.notNull(matchersToAdd, "'matchersToAdd' cannot be null");
9093
Assert.noNullElements(matchersToAdd, "'matchersToAdd' cannot have null elements");
91-
for (HeaderMatcher matcher : matchersToAdd) {
92-
this.matchers.add(matcher);
93-
}
94+
Collections.addAll(this.matchers, matchersToAdd);
9495
}
9596

9697
/**
9798
* Set to true to map all {@code String} valued outbound headers to {@code byte[]}.
9899
* To map to a {@code String} for inbound, there must be an entry in the rawMappedHeaders map.
99100
* @param mapAllStringsOut true to map all strings.
100101
* @since 2.2.5
101-
* @see #setRawMappedHaeaders(Map)
102+
* @see #setRawMappedHeaders(Map)
102103
*/
103104
public void setMapAllStringsOut(boolean mapAllStringsOut) {
104105
this.mapAllStringsOut = mapAllStringsOut;
@@ -112,7 +113,7 @@ protected Charset getCharset() {
112113
* Set the charset to use when mapping String-valued headers to/from byte[]. Default UTF-8.
113114
* @param charset the charset.
114115
* @since 2.2.5
115-
* @see #setRawMappedHaeaders(Map)
116+
* @see #setRawMappedHeaders(Map)
116117
*/
117118
public void setCharset(Charset charset) {
118119
Assert.notNull(charset, "'charset' cannot be null");
@@ -129,10 +130,10 @@ public void setCharset(Charset charset) {
129130
* @see #setCharset(Charset)
130131
* @see #setMapAllStringsOut(boolean)
131132
*/
132-
public void setRawMappedHaeaders(Map<String, Boolean> rawMappedHeaders) {
133+
public void setRawMappedHeaders(Map<String, Boolean> rawMappedHeaders) {
133134
if (!ObjectUtils.isEmpty(rawMappedHeaders)) {
134-
this.rawMappedtHeaders.clear();
135-
this.rawMappedtHeaders.putAll(rawMappedHeaders);
135+
this.rawMappedHeaders.clear();
136+
this.rawMappedHeaders.putAll(rawMappedHeaders);
136137
}
137138
}
138139

@@ -167,7 +168,7 @@ protected boolean matches(String header) {
167168
/**
168169
* Check if the value is a String and convert to byte[], if so configured.
169170
* @param key the header name.
170-
* @param value the headet value.
171+
* @param value the header value.
171172
* @return the value to add.
172173
* @since 2.2.5
173174
*/
@@ -181,7 +182,7 @@ protected Object headerValueToAddOut(String key, Object value) {
181182

182183
@Nullable
183184
private byte[] mapRawOut(String header, Object value) {
184-
if (this.mapAllStringsOut || this.rawMappedtHeaders.containsKey(header)) {
185+
if (this.mapAllStringsOut || this.rawMappedHeaders.containsKey(header)) {
185186
if (value instanceof byte[]) {
186187
return (byte[]) value;
187188
}
@@ -197,7 +198,7 @@ else if (value instanceof String) {
197198
* @param header the header.
198199
* @return the value to add.
199200
*/
200-
protected Object headertValueToAddIn(Header header) {
201+
protected Object headerValueToAddIn(Header header) {
201202
Object mapped = mapRawIn(header.key(), header.value());
202203
if (mapped == null) {
203204
mapped = header.value();
@@ -207,7 +208,7 @@ protected Object headertValueToAddIn(Header header) {
207208

208209
@Nullable
209210
private String mapRawIn(String header, byte[] value) {
210-
Boolean asString = this.rawMappedtHeaders.get(header);
211+
Boolean asString = this.rawMappedHeaders.get(header);
211212
if (Boolean.TRUE.equals(asString)) {
212213
return new String(value, this.charset);
213214
}
@@ -275,7 +276,7 @@ protected static class SimplePatternBasedHeaderMatcher implements HeaderMatcher
275276

276277
private final boolean negate;
277278

278-
public SimplePatternBasedHeaderMatcher(String pattern) {
279+
protected SimplePatternBasedHeaderMatcher(String pattern) {
279280
this(pattern.startsWith("!") ? pattern.substring(1) : pattern, pattern.startsWith("!"));
280281
}
281282

spring-kafka/src/main/java/org/springframework/kafka/support/DefaultKafkaHeaderMapper.java

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,8 @@
3636
import org.springframework.util.ClassUtils;
3737
import org.springframework.util.MimeType;
3838

39-
import com.fasterxml.jackson.core.JsonParseException;
4039
import com.fasterxml.jackson.core.JsonProcessingException;
4140
import com.fasterxml.jackson.databind.DeserializationContext;
42-
import com.fasterxml.jackson.databind.JsonMappingException;
4341
import com.fasterxml.jackson.databind.JsonNode;
4442
import com.fasterxml.jackson.databind.ObjectMapper;
4543
import com.fasterxml.jackson.databind.deser.std.StdNodeBasedDeserializer;
@@ -230,9 +228,9 @@ public void fromHeaders(MessageHeaders headers, Headers target) {
230228
target.add(new RecordHeader(key, headerObjectMapper.writeValueAsBytes(value)));
231229
jsonHeaders.put(key, className);
232230
}
233-
catch (@SuppressWarnings("unused") Exception e) {
231+
catch (Exception e) {
234232
if (logger.isDebugEnabled()) {
235-
logger.debug("Could not map " + key + " with type " + valueToAdd.getClass().getName());
233+
logger.debug("Could not map " + key + " with type " + valueToAdd.getClass().getName(), e);
236234
}
237235
}
238236
}
@@ -272,9 +270,8 @@ public void toHeaders(Headers source, final Map<String, Object> headers) {
272270
headers.put(header.key(), value);
273271
}
274272
catch (IOException e) {
275-
logger.error("Could not decode json type: " + new String(header.value()) + " for key: " + header
276-
.key(),
277-
e);
273+
logger.error("Could not decode json type: " + new String(header.value()) + " for key: " +
274+
header.key(), e);
278275
headers.put(header.key(), header.value());
279276
}
280277
}
@@ -283,16 +280,14 @@ public void toHeaders(Headers source, final Map<String, Object> headers) {
283280
}
284281
}
285282
else {
286-
headers.put(header.key(), headertValueToAddIn(header));
283+
headers.put(header.key(), headerValueToAddIn(header));
287284
}
288285
}
289286
});
290287
}
291288

292-
private Object decodeValue(Header h, Class<?> type)
293-
throws IOException, JsonParseException, JsonMappingException, LinkageError {
294-
295-
final ObjectMapper headerObjectMapper = getObjectMapper();
289+
private Object decodeValue(Header h, Class<?> type) throws IOException, LinkageError {
290+
ObjectMapper headerObjectMapper = getObjectMapper();
296291
Object value = headerObjectMapper.readValue(h.value(), type);
297292
if (type.equals(NonTrustedHeaderType.class)) {
298293
// Upstream NTHT propagated; may be trusted here...

spring-kafka/src/main/java/org/springframework/kafka/support/SimpleKafkaHeaderMapper.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
* A simple header mapper that maps headers directly; for outbound,
2828
* only byte[] headers are mapped; for inbound, headers are mapped
2929
* unchanged, as byte[]. Strings can also be mapped to/from byte.
30-
* See {@link #setRawMappedHaeaders(Map)}.
30+
* See {@link #setRawMappedHeaders(Map)}.
3131
* Most headers in {@link KafkaHeaders} are not mapped on outbound messages.
3232
* The exceptions are correlation and reply headers for request/reply
3333
*
@@ -75,7 +75,7 @@ public void fromHeaders(MessageHeaders headers, Headers target) {
7575

7676
@Override
7777
public void toHeaders(Headers source, Map<String, Object> target) {
78-
source.forEach(header -> target.put(header.key(), headertValueToAddIn(header)));
78+
source.forEach(header -> target.put(header.key(), headerValueToAddIn(header)));
7979
}
8080

8181
}

spring-kafka/src/test/java/org/springframework/kafka/support/DefaultKafkaHeaderMapperTests.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ public void testSpecificStringConvert() {
155155
Map<String, Boolean> rawMappedHeaders = new HashMap<>();
156156
rawMappedHeaders.put("thisOnesAString", true);
157157
rawMappedHeaders.put("thisOnesBytes", false);
158-
mapper.setRawMappedHaeaders(rawMappedHeaders);
158+
mapper.setRawMappedHeaders(rawMappedHeaders);
159159
Map<String, Object> headersMap = new HashMap<>();
160160
headersMap.put("thisOnesAString", "foo");
161161
headersMap.put("thisOnesBytes", "bar");
@@ -180,7 +180,7 @@ public void testJsonStringConvert() {
180180
DefaultKafkaHeaderMapper mapper = new DefaultKafkaHeaderMapper();
181181
Map<String, Boolean> rawMappedHeaders = new HashMap<>();
182182
rawMappedHeaders.put("thisOnesBytes", false);
183-
mapper.setRawMappedHaeaders(rawMappedHeaders);
183+
mapper.setRawMappedHeaders(rawMappedHeaders);
184184
Map<String, Object> headersMap = new HashMap<>();
185185
headersMap.put("thisOnesAString", "foo");
186186
headersMap.put("thisOnesBytes", "bar");
@@ -208,7 +208,7 @@ public void testAlwaysStringConvert() {
208208
mapper.setMapAllStringsOut(true);
209209
Map<String, Boolean> rawMappedHeaders = new HashMap<>();
210210
rawMappedHeaders.put("thisOnesBytes", false);
211-
mapper.setRawMappedHaeaders(rawMappedHeaders);
211+
mapper.setRawMappedHeaders(rawMappedHeaders);
212212
Map<String, Object> headersMap = new HashMap<>();
213213
headersMap.put("thisOnesAString", "foo");
214214
headersMap.put("thisOnesBytes", "bar");

spring-kafka/src/test/java/org/springframework/kafka/support/SimpleKafkaHeaderMapperTests.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ public void testSpecificStringConvert() {
4242
Map<String, Boolean> rawMappedHeaders = new HashMap<>();
4343
rawMappedHeaders.put("thisOnesAString", true);
4444
rawMappedHeaders.put("thisOnesBytes", false);
45-
mapper.setRawMappedHaeaders(rawMappedHeaders);
45+
mapper.setRawMappedHeaders(rawMappedHeaders);
4646
Map<String, Object> headersMap = new HashMap<>();
4747
headersMap.put("thisOnesAString", "foo");
4848
headersMap.put("thisOnesBytes", "bar");
@@ -67,7 +67,7 @@ public void testNotStringConvert() {
6767
SimpleKafkaHeaderMapper mapper = new SimpleKafkaHeaderMapper("*");
6868
Map<String, Boolean> rawMappedHeaders = new HashMap<>();
6969
rawMappedHeaders.put("thisOnesBytes", false);
70-
mapper.setRawMappedHaeaders(rawMappedHeaders);
70+
mapper.setRawMappedHeaders(rawMappedHeaders);
7171
Map<String, Object> headersMap = new HashMap<>();
7272
headersMap.put("thisOnesAString", "foo");
7373
headersMap.put("thisOnesBytes", "bar");
@@ -91,7 +91,7 @@ public void testAlwaysStringConvert() {
9191
mapper.setMapAllStringsOut(true);
9292
Map<String, Boolean> rawMappedHeaders = new HashMap<>();
9393
rawMappedHeaders.put("thisOnesBytes", false);
94-
mapper.setRawMappedHaeaders(rawMappedHeaders);
94+
mapper.setRawMappedHeaders(rawMappedHeaders);
9595
Map<String, Object> headersMap = new HashMap<>();
9696
headersMap.put("thisOnesAString", "foo");
9797
headersMap.put("thisOnesBytes", "bar");

0 commit comments

Comments
 (0)