クラス AbstractKafkaHeaderMapper
java.lang.ObjectSE
org.springframework.kafka.support.AbstractKafkaHeaderMapper
- 実装されているすべてのインターフェース:
KafkaHeaderMapper
Kafka ヘッダーマッパーのベース。
- 導入:
- 2.1.3
- 作成者:
- Gary Russell, Artem Bilan, Sanghyeok An, Soby Chacko
ネストされたクラスの要約
ネストされたクラス修飾子と型クラス説明protected static interfaceヘッダーのマッチャー。protected static classヘッダーのセットに一致しないマッチャー。protected static class指定されたヘッダーが指定された単純なパターンに一致する場合に一致するパターンベースのヘッダーマッチャー。フィールドのサマリー
フィールドコンストラクターの概要
コンストラクター修飾子コンストラクター説明protectedAbstractKafkaHeaderMapper(boolean outbound, StringSE... patterns) 提供されたパターン (送信) とすべてのヘッダー (受信) に一致するマッパーを構築します。AbstractKafkaHeaderMapper(StringSE... patterns) 提供されたパターン (送信) とすべてのヘッダー (受信) に一致するマッパーを構築します。メソッドのサマリー
修飾子と型メソッド説明protected final voidaddMatchers(AbstractKafkaHeaderMapper.HeaderMatcher... matchersToAdd) サブクラスは、これを呼び出してカスタムAbstractKafkaHeaderMapper.HeaderMatcherを追加できます。voidaddRawMappedHeader(StringSE name, boolean toString) 生のマップされたヘッダーを追加します。protected booleandoesMatchMultiValueHeader(StringSE headerName) 指定されたヘッダー名を複数の値にマップする必要があるかどうかを決定します。protected voidfromUserHeader(StringSE headerName, org.apache.kafka.common.header.Header header, MapSE<StringSE, ObjectSE> headers) DefaultKafkaHeaderMapper内の予約されていないヘッダーを処理します。protected CharsetSEprotected @Nullable ObjectSEheaderValueToAddIn(@Nullable org.apache.kafka.common.header.Header header) 構成されている場合、ヘッダー値を文字列にマップする必要があるかどうかを確認します。protected ObjectSEheaderValueToAddOut(StringSE key, ObjectSE value) 値が文字列であるかどうかを確認し、構成されている場合は byte[] に変換します。protected booleanprotected booleanprotected booleanmatchesForInbound(StringSE header) 受信 マッパーとして構成されている場合、受信 マッピングのヘッダー名を照合します。voidsetCharset(CharsetSE charset) 文字列値のヘッダーを byte[] との間でマッピングするときに使用する文字セットを設定します。voidsetMapAllStringsOut(boolean mapAllStringsOut) すべてのString値の送信 ヘッダーをbyte[]にマップするには、true に設定します。voidsetMultiValueHeaderPatterns(StringSE... patterns) 同じキーにある複数の値ヘッダーを一致させるためのパターンを追加します。voidsetRawMappedHeaders(MapSE<StringSE, BooleanSE> rawMappedHeaders) ヘッダーが変換を実行しないように設定します (送信用のStringからbyte[]を除く)。クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSEインターフェース org.springframework.kafka.support.KafkaHeaderMapper から継承されたメソッド
fromHeaders, toHeaders
フィールドの詳細
logger
コンストラクターの詳細
AbstractKafkaHeaderMapper
提供されたパターン (送信) とすべてのヘッダー (受信) に一致するマッパーを構築します。送信 マッピングの場合、特定の内部フレームワークヘッダーは決してマッピングされません。- パラメーター:
patterns- パターン。
AbstractKafkaHeaderMapper
提供されたパターン (送信) とすべてのヘッダー (受信) に一致するマッパーを構築します。送信 マッピングの場合、特定の内部フレームワークヘッダーは決してマッピングされません。- パラメーター:
outbound- 送信 マッパーの場合は true。patterns- パターン。
メソッドの詳細
addMatchers
サブクラスは、これを呼び出してカスタムAbstractKafkaHeaderMapper.HeaderMatcherを追加できます。- パラメーター:
matchersToAdd- 追加するマッチャー。- 導入:
- 2.3
setMapAllStringsOut
public void setMapAllStringsOut(boolean mapAllStringsOut) すべてのString値の送信ヘッダーをbyte[]にマップするには、true に設定します。受信用にStringにマップするには、rawMappedHeaders マップにエントリが存在している必要があります。- パラメーター:
mapAllStringsOut- すべての文字列をマップする場合は true。- 導入:
- 2.2.5
- 関連事項:
getCharset
setCharset
文字列値のヘッダーを byte[] との間でマッピングするときに使用する文字セットを設定します。デフォルトの UTF-8。- パラメーター:
charset- 文字セット。- 導入:
- 2.2.5
- 関連事項:
setRawMappedHeaders
ヘッダーに対して変換を行わないように設定してください (送信用のStringからbyte[]を除く)。一致する受信ヘッダーは、マップ値内の対応するブール値が true でない限り、byte[]としてマップされます。true の場合は、文字列としてマップされます。デフォルトでマップされるヘッダーは、kafka_listenerInfo、b3、traceparent、X-B3-TraceId、X-B3-SpanId、X-B3-Sampled、X-B3-Flagsです。- パラメーター:
rawMappedHeaders- 変換しないヘッダー名と- 導入:
- 2.2.5
- 関連事項:
addRawMappedHeader
生のマップされたヘッダーを追加します。- パラメーター:
name- ヘッダー名。toString- true の場合、受信で文字列に変換します。- 導入:
- 2.7.1
- 関連事項:
setMultiValueHeaderPatterns
同じキーにある複数の値ヘッダーを一致させるためのパターンを追加します。- パラメーター:
patterns- ヘッダーのパターン。- 導入:
- 4.0
matches
matches
matchesForInbound
受信 マッパーとして構成されている場合、受信 マッピングのヘッダー名を照合します。- パラメーター:
header- ヘッダー名。- 戻り値:
- マップできる場合は true。
- 導入:
- 2.8.8
headerValueToAddOut
doesMatchMultiValueHeader
指定されたヘッダー名を複数の値にマッピングするかどうかを判定します。このメソッドはまず、マッピング結果がすでにキャッシュされているかどうかを確認します。キャッシュされた結果が存在する場合は、すぐに返されます。存在しない場合は、doesMatchInternal(headerName)を呼び出して結果を計算し、キャッシュしてから返します。- パラメーター:
headerName- ヘッダー名。- 戻り値:
- 同じキーに複数の値がある場合は True になります。
- 導入:
- 4.0
fromUserHeader
protected void fromUserHeader(StringSE headerName, org.apache.kafka.common.header.Header header, MapSE<StringSE, ObjectSE> headers) DefaultKafkaHeaderMapper内の予約されていないヘッダーを処理します。- パラメーター:
headerName- ヘッダー名。header- ヘッダーインスタンス。headers- ターゲットヘッダー。- 導入:
- 4.0
headerValueToAddIn
protected @Nullable ObjectSE headerValueToAddIn(@Nullable org.apache.kafka.common.header.Header header) 構成されている場合、ヘッダー値を文字列にマップする必要があるかどうかを確認します。- パラメーター:
header- ヘッダー。- 戻り値:
- 追加する値。