クラス DefaultKafkaHeaderMapper
java.lang.ObjectSE
org.springframework.kafka.support.AbstractKafkaHeaderMapper
org.springframework.kafka.support.DefaultKafkaHeaderMapper
- 実装されたすべてのインターフェース:
KafkaHeaderMapper
Apache Kafka のデフォルトのヘッダーマッパー。
KafkaHeaders
のほとんどのヘッダーは、送信メッセージにマップされません。例外は、リクエスト / 応答メッセージングの相関ヘッダーと応答ヘッダーです。ヘッダー型は、特別なヘッダー JSON_TYPES
に追加されます。- 導入:
- 1.3
- 作成者:
- Gary Russell, Artem Bilan, Soby Chacko
ネストされたクラスのサマリー
ネストされたクラス修飾子と型クラス説明static class
信頼できない型が原因でデコードできなかったヘッダーを表します。クラス org.springframework.kafka.support.AbstractKafkaHeaderMapper から継承されたネストクラス / インターフェース
AbstractKafkaHeaderMapper.HeaderMatcher, AbstractKafkaHeaderMapper.NeverMatchHeaderMatcher, AbstractKafkaHeaderMapper.SimplePatternBasedHeaderMatcher
フィールドサマリー
フィールドクラス org.springframework.kafka.support.AbstractKafkaHeaderMapper から継承されたフィールド
logger
コンストラクターのサマリー
コンストラクターコンストラクター説明送信ヘッダーのデフォルトのオブジェクトマッパーとデフォルトのヘッダーパターンを使用してインスタンスを構築します。すべての受信ヘッダーがマップされます。DefaultKafkaHeaderMapper
(com.fasterxml.jackson.databind.ObjectMapper objectMapper) 提供されたオブジェクトマッパーと送信ヘッダーのデフォルトヘッダーパターンを使用してインスタンスを構築します。すべての受信ヘッダーがマップされます。DefaultKafkaHeaderMapper
(com.fasterxml.jackson.databind.ObjectMapper objectMapper, StringSE... patterns) 提供されたオブジェクトマッパーと送信ヘッダー用に提供されたヘッダーパターンを使用してインスタンスを構築します。すべての受信ヘッダーがマップされます。DefaultKafkaHeaderMapper
(StringSE... patterns) デフォルトのオブジェクトマッパーと送信ヘッダー用に提供されたヘッダーパターンを使用してインスタンスを構築します。すべての受信ヘッダーがマップされます。メソッドのサマリー
修飾子と型メソッド説明void
addToStringClasses
(StringSE... classNames) 送信マッパーがマッピングの前に toString() 操作を実行する必要があるクラス名を追加します。void
addTrustedPackages
(StringSE... packagesToTrust) JSON からオブジェクトを構築するときに使用される信頼できるパッケージのリストにパッケージを追加します。static DefaultKafkaHeaderMapper
forInboundOnlyWithMatchers
(com.fasterxml.jackson.databind.ObjectMapper objectMapper, StringSE... patterns) パターンマッチングのみを使用して受信 マッピング用のインスタンスを作成します。static DefaultKafkaHeaderMapper
forInboundOnlyWithMatchers
(StringSE... patterns) パターンマッチングのみを使用して受信 マッピング用のインスタンスを作成します。void
fromHeaders
(MessageHeaders headers, org.apache.kafka.common.header.Headers target) 指定されたMessageHeaders
から指定されたターゲットヘッダーにマップします。protected com.fasterxml.jackson.databind.ObjectMapper
オブジェクトマッパーを返します。サブクラスによる toString() クラスへの直接アクセスを提供します。サブクラスに設定された信頼できるパッケージへの直接アクセスを提供します。protected boolean
void
setEncodeStrings
(boolean encodeStrings) 文字列値のヘッダーを JSON 文字列 ( "..." ) としてエンコードするには true に設定します。デフォルトでは、構成された文字セットを使用して生の文字列値のみがバイト配列に変換されます。void
指定されたネイティブヘッダーから、最終的なMessageHeaders
のヘッダーのマップにマップします。protected boolean
クラス org.springframework.kafka.support.AbstractKafkaHeaderMapper から継承されたメソッド
addMatchers, addRawMappedHeader, getCharset, headerValueToAddIn, headerValueToAddOut, matches, matches, matchesForInbound, setCharset, setMapAllStringsOut, setRawMappedHeaders
フィールドの詳細
JSON_TYPES
他のヘッダーの java 型のヘッダー名。- 関連事項:
コンストラクターの詳細
DefaultKafkaHeaderMapper
public DefaultKafkaHeaderMapper()送信ヘッダーのデフォルトのオブジェクトマッパーとデフォルトのヘッダーパターンを使用してインスタンスを構築します。すべての受信ヘッダーがマップされます。デフォルトのパターンリストは"!id", "!timestamp" and "*"
です。さらに、KafkaHeaders
のほとんどのヘッダーは、コンシューマー / プロデューサーレコードのデータを表すため、ヘッダーとしてマップされることはありません。DefaultKafkaHeaderMapper
public DefaultKafkaHeaderMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper) 提供されたオブジェクトマッパーと送信ヘッダーのデフォルトヘッダーパターンを使用してインスタンスを構築します。すべての受信ヘッダーがマップされます。パターンは順番に適用され、最初の一致(正または負)で停止します。パターンの前に "!" を付けると、パターンが無効になります。デフォルトのパターンリストは"!id", "!timestamp" and "*"
です。さらに、KafkaHeaders
のほとんどのヘッダーは、コンシューマー / プロデューサーレコードのデータを表すため、ヘッダーとしてマップされることはありません。- パラメーター:
objectMapper
- オブジェクトマッパー。- 関連事項:
DefaultKafkaHeaderMapper
デフォルトのオブジェクトマッパーと送信ヘッダー用に提供されたヘッダーパターンを使用してインスタンスを構築します。すべての受信ヘッダーがマップされます。パターンは順番に適用され、最初の一致(正または負)で停止します。パターンの前に "!" を付けると、パターンが無効になります。パターンはデフォルトのパターンを置き換えます。通常、"id" and "timestamp"
ヘッダーをマップしないでください。注:KafkaHeaders
のヘッダーのほとんどは、コンシューマー / プロデューサーレコードのデータを表すため、ヘッダーとしてマップされます。- パラメーター:
patterns
- パターン。- 関連事項:
DefaultKafkaHeaderMapper
public DefaultKafkaHeaderMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper, StringSE... patterns) 提供されたオブジェクトマッパーと送信ヘッダー用に提供されたヘッダーパターンを使用してインスタンスを構築します。すべての受信ヘッダーがマップされます。パターンは順番に適用され、最初の一致(正または負)で停止します。パターンの前に "!" を付けると、パターンが無効になります。パターンはデフォルトのパターンを置き換えます。通常、"id" and "timestamp"
ヘッダーをマップしないでください。注:KafkaHeaders
のほとんどのヘッダーは、コンシューマー / プロデューサーレコードのデータを表すため、ヘッダーとしてマップされることはありません。- パラメーター:
objectMapper
- オブジェクトマッパー。patterns
- パターン。- 関連事項:
メソッドの詳細
forInboundOnlyWithMatchers
パターンマッチングのみを使用して受信 マッピング用のインスタンスを作成します。- パラメーター:
patterns
- 一致するパターン。- 戻り値:
- ヘッダーマッパー。
- 導入:
- 2.8.8
forInboundOnlyWithMatchers
public static DefaultKafkaHeaderMapper forInboundOnlyWithMatchers(com.fasterxml.jackson.databind.ObjectMapper objectMapper, StringSE... patterns) パターンマッチングのみを使用して受信 マッピング用のインスタンスを作成します。- パラメーター:
objectMapper
- オブジェクトマッパー。patterns
- 一致するパターン。- 戻り値:
- ヘッダーマッパー。
- 導入:
- 2.8.8
getObjectMapper
protected com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()オブジェクトマッパーを返します。- 戻り値:
- マッパー。
getTrustedPackages
サブクラスに設定された信頼できるパッケージへの直接アクセスを提供します。- 戻り値:
- 信頼できるパッケージ。
- 導入:
- 2.2
getToStringClasses
サブクラスによる toString() クラスへの直接アクセスを提供します。- 戻り値:
- toString() クラス。
- 導入:
- 2.2
isEncodeStrings
protected boolean isEncodeStrings()setEncodeStrings
public void setEncodeStrings(boolean encodeStrings) 文字列値のヘッダーを JSON 文字列 ( "..." ) としてエンコードするには true に設定します。デフォルトでは、構成された文字セットを使用して生の文字列値のみがバイト配列に変換されます。送信レコードのコンシューマーが 2.3 より前の Spring for Apache Kafka バージョンを使用している場合は true に設定します。- パラメーター:
encodeStrings
- エンコードする場合は true(デフォルトは false)。- 導入:
- 2.3
addTrustedPackages
JSON からオブジェクトを構築するときに使用される信頼できるパッケージのリストにパッケージを追加します。デフォルトでは、次のパッケージが信頼されます。- java.lang
- java.net
- java.util
- org.springframework.util
"*"
である場合、すべてのパッケージが信頼されます。信頼されていないパッケージのクラスが見つかった場合、ヘッダーは型DefaultKafkaHeaderMapper.NonTrustedHeaderType
の値でアプリケーションに返されます。- パラメーター:
packagesToTrust
- 信頼するパッケージ。
addToStringClasses
送信マッパーがマッピングの前に toString() 操作を実行する必要があるクラス名を追加します。- パラメーター:
classNames
- クラス名。- 導入:
- 2.2
fromHeaders
インターフェースからコピーされた説明:KafkaHeaderMapper
指定されたMessageHeaders
から指定されたターゲットヘッダーにマップします。- パラメーター:
headers
- 抽象化された MessageHeaders。target
- ネイティブターゲットヘッダー。
toHeaders
public void toHeaders(org.apache.kafka.common.header.Headers source, MapSE<StringSE, ObjectSE> headers) インターフェースからコピーされた説明:KafkaHeaderMapper
指定されたネイティブヘッダーから、最終的なMessageHeaders
のヘッダーのマップにマップします。- パラメーター:
source
- ネイティブヘッダー。headers
- ターゲットヘッダー。
trusted