クラス DefaultKafkaHeaderMapper

java.lang.ObjectSE
org.springframework.kafka.support.AbstractKafkaHeaderMapper
org.springframework.kafka.support.DefaultKafkaHeaderMapper
実装されているすべてのインターフェース:
KafkaHeaderMapper
@DeprecatedSE(forRemoval=true, since="4.0") public class DefaultKafkaHeaderMapper extends AbstractKafkaHeaderMapper
非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
4.0 以降、Jackson 3 では JsonKafkaHeaderMapper が優先されます。
Apache Kafka のデフォルトのヘッダーマッパー。KafkaHeaders のほとんどのヘッダーは、送信メッセージにマップされません。例外は、リクエスト / 応答メッセージングの相関ヘッダーと応答ヘッダーです。ヘッダー型は、特別なヘッダー JSON_TYPES に追加されます。
導入:
1.3
作成者:
Gary Russell, Artem Bilan, Soby Chacko, Sanghyoek An

  • ネストされたクラスの要約

    ネストされたクラス
    修飾子と型
    クラス
    説明
    static class
    DefaultKafkaHeaderMapper.NonTrustedHeaderType
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    信頼できない型が原因でデコードできなかったヘッダーを表します。

    クラス org.springframework.kafka.support.AbstractKafkaHeaderMapper から継承されたネストクラス / インターフェース

    AbstractKafkaHeaderMapper.HeaderMatcher, AbstractKafkaHeaderMapper.NeverMatchHeaderMatcher, AbstractKafkaHeaderMapper.SimplePatternBasedHeaderMatcher

  • フィールドのサマリー

    フィールド
    修飾子と型
    フィールド
    説明
    static final StringSE
    JSON_TYPES
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    他のヘッダーの java 型のヘッダー名。

    クラス org.springframework.kafka.support.AbstractKafkaHeaderMapper から継承されたフィールド

    logger

  • コンストラクターの概要

    コンストラクター
    コンストラクター
    説明
    DefaultKafkaHeaderMapper()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    送信ヘッダーのデフォルトのオブジェクトマッパーとデフォルトのヘッダーパターンを使用してインスタンスを構築します。すべての受信ヘッダーがマップされます。
    DefaultKafkaHeaderMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    提供されたオブジェクトマッパーと送信ヘッダーのデフォルトヘッダーパターンを使用してインスタンスを構築します。すべての受信ヘッダーがマップされます。
    DefaultKafkaHeaderMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper, StringSE... patterns)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    提供されたオブジェクトマッパーと送信ヘッダー用に提供されたヘッダーパターンを使用してインスタンスを構築します。すべての受信ヘッダーがマップされます。
    DefaultKafkaHeaderMapper(StringSE... patterns)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    デフォルトのオブジェクトマッパーと送信ヘッダー用に提供されたヘッダーパターンを使用してインスタンスを構築します。すべての受信ヘッダーがマップされます。

  • 方法の概要

    修飾子と型
    メソッド
    説明
    void
    addToStringClasses(StringSE... classNames)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    送信マッパーがマッピングの前に toString() 操作を実行する必要があるクラス名を追加します。
    void
    addTrustedPackages(StringSE... packagesToTrust)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    JSON からオブジェクトを構築するときに使用される信頼できるパッケージのリストにパッケージを追加します。
    static DefaultKafkaHeaderMapper
    forInboundOnlyWithMatchers(com.fasterxml.jackson.databind.ObjectMapper objectMapper, StringSE... patterns)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    パターンマッチングのみを使用して受信 マッピング用のインスタンスを作成します。
    static DefaultKafkaHeaderMapper
    forInboundOnlyWithMatchers(StringSE... patterns)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    パターンマッチングのみを使用して受信 マッピング用のインスタンスを作成します。
    void
    fromHeaders(MessageHeaders headers, org.apache.kafka.common.header.Headers target)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    指定された MessageHeaders から指定されたターゲットヘッダーにマップします。
    protected com.fasterxml.jackson.databind.ObjectMapper
    getObjectMapper()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    オブジェクトマッパーを返します。
    protected SetSE<StringSE>
    getToStringClasses()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    サブクラスによる toString() クラスへの直接アクセスを提供します。
    protected SetSE<StringSE>
    getTrustedPackages()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    サブクラスに設定された信頼できるパッケージへの直接アクセスを提供します。
    protected boolean
    isEncodeStrings()
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    void
    setEncodeStrings(boolean encodeStrings)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    文字列値のヘッダーを JSON 文字列 ( "..." ) としてエンコードするには true に設定します。デフォルトでは、構成された文字セットを使用して生の文字列値のみがバイト配列に変換されます。
    void
    toHeaders(org.apache.kafka.common.header.Headers source, MapSE<StringSE,ObjectSE> headers)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
    指定されたネイティブヘッダーから、最終的な MessageHeaders のヘッダーのマップにマップします。
    protected boolean
    trusted(StringSE requestedType)
    非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

    クラス org.springframework.kafka.support.AbstractKafkaHeaderMapper から継承されたメソッド

    addMatchers, addRawMappedHeader, doesMatchMultiValueHeader, fromUserHeader, getCharset, headerValueToAddIn, headerValueToAddOut, matches, matches, matchesForInbound, setCharset, setMapAllStringsOut, setMultiValueHeaderPatterns, setRawMappedHeaders

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE

  • フィールドの詳細

    • JSON_TYPES

      public static final StringSE JSON_TYPES
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      他のヘッダーの java 型のヘッダー名。
      関連事項:

  • コンストラクターの詳細

    • DefaultKafkaHeaderMapper

      public DefaultKafkaHeaderMapper()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      送信ヘッダーのデフォルトのオブジェクトマッパーとデフォルトのヘッダーパターンを使用してインスタンスを構築します。すべての受信ヘッダーがマップされます。デフォルトのパターンリストは "!id", "!timestamp" and "*" です。さらに、KafkaHeaders のほとんどのヘッダーは、コンシューマー / プロデューサーレコードのデータを表すため、ヘッダーとしてマップされることはありません。
      関連事項:

    • DefaultKafkaHeaderMapper

      public DefaultKafkaHeaderMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      提供されたオブジェクトマッパーと送信ヘッダーのデフォルトヘッダーパターンを使用してインスタンスを構築します。すべての受信ヘッダーがマップされます。パターンは順番に適用され、最初の一致（正または負）で停止します。パターンの前に "!" を付けると、パターンが無効になります。デフォルトのパターンリストは "!id", "!timestamp" and "*" です。さらに、KafkaHeaders のほとんどのヘッダーは、コンシューマー / プロデューサーレコードのデータを表すため、ヘッダーとしてマップされることはありません。
      パラメーター:
      objectMapper - オブジェクトマッパー。
      関連事項:

    • DefaultKafkaHeaderMapper

      public DefaultKafkaHeaderMapper(StringSE... patterns)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      デフォルトのオブジェクトマッパーと送信ヘッダー用に提供されたヘッダーパターンを使用してインスタンスを構築します。すべての受信ヘッダーがマップされます。パターンは順番に適用され、最初の一致（正または負）で停止します。パターンの前に "!" を付けると、パターンが無効になります。パターンはデフォルトのパターンを置き換えます。通常、"id" and "timestamp" ヘッダーをマップしないでください。注: KafkaHeaders のヘッダーのほとんどは、コンシューマー / プロデューサーレコードのデータを表すため、ヘッダーとしてマップされます。
      パラメーター:
      patterns - パターン。
      関連事項:

    • DefaultKafkaHeaderMapper

      public DefaultKafkaHeaderMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper, StringSE... patterns)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      提供されたオブジェクトマッパーと送信ヘッダー用に提供されたヘッダーパターンを使用してインスタンスを構築します。すべての受信ヘッダーがマップされます。パターンは順番に適用され、最初の一致（正または負）で停止します。パターンの前に "!" を付けると、パターンが無効になります。パターンはデフォルトのパターンを置き換えます。通常、"id" and "timestamp" ヘッダーをマップしないでください。注: KafkaHeaders のほとんどのヘッダーは、コンシューマー / プロデューサーレコードのデータを表すため、ヘッダーとしてマップされることはありません。
      パラメーター:
      objectMapper - オブジェクトマッパー。
      patterns - パターン。
      関連事項:

  • メソッドの詳細

    • forInboundOnlyWithMatchers

      public static DefaultKafkaHeaderMapper forInboundOnlyWithMatchers(StringSE... patterns)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      パターンマッチングのみを使用して受信 マッピング用のインスタンスを作成します。
      パラメーター:
      patterns - 一致するパターン。
      戻り値:
      ヘッダーマッパー。
      導入:
      2.8.8

    • forInboundOnlyWithMatchers

      public static DefaultKafkaHeaderMapper forInboundOnlyWithMatchers(com.fasterxml.jackson.databind.ObjectMapper objectMapper, StringSE... patterns)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      パターンマッチングのみを使用して受信 マッピング用のインスタンスを作成します。
      パラメーター:
      objectMapper - オブジェクトマッパー。
      patterns - 一致するパターン。
      戻り値:
      ヘッダーマッパー。
      導入:
      2.8.8

    • getObjectMapper

      protected com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      オブジェクトマッパーを返します。
      戻り値:
      マッパー。

    • getTrustedPackages

      protected SetSE<StringSE> getTrustedPackages()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      サブクラスに設定された信頼できるパッケージへの直接アクセスを提供します。
      戻り値:
      信頼できるパッケージ。
      導入:
      2.2

    • getToStringClasses

      protected SetSE<StringSE> getToStringClasses()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      サブクラスによる toString() クラスへの直接アクセスを提供します。
      戻り値:
      toString() クラス。
      導入:
      2.2

    • isEncodeStrings

      protected boolean isEncodeStrings()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

    • setEncodeStrings

      public void setEncodeStrings(boolean encodeStrings)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      文字列値のヘッダーを JSON 文字列 ( "..." ) としてエンコードするには true に設定します。デフォルトでは、構成された文字セットを使用して生の文字列値のみがバイト配列に変換されます。送信レコードのコンシューマーが 2.3 より前の Spring for Apache Kafka バージョンを使用している場合は true に設定します。
      パラメーター:
      encodeStrings - エンコードする場合は true（デフォルトは false）。
      導入:
      2.3

    • addTrustedPackages

      public void addTrustedPackages(StringSE... packagesToTrust)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      JSON からオブジェクトを構築するときに使用される信頼できるパッケージのリストにパッケージを追加します。デフォルトでは、次のパッケージが信頼されます。
      • java.lang
      • java.net
      • java.util
      • org.springframework.util
      提供されたパッケージのいずれかが "*" である場合、すべてのパッケージが信頼されます。信頼されていないパッケージのクラスが見つかった場合、ヘッダーは型 DefaultKafkaHeaderMapper.NonTrustedHeaderType の値でアプリケーションに返されます。
      パラメーター:
      packagesToTrust - 信頼するパッケージ。

    • addToStringClasses

      public void addToStringClasses(StringSE... classNames)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      送信マッパーがマッピングの前に toString() 操作を実行する必要があるクラス名を追加します。
      パラメーター:
      classNames - クラス名。
      導入:
      2.2

    • fromHeaders

      public void fromHeaders(MessageHeaders headers, org.apache.kafka.common.header.Headers target)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      インターフェースからコピーされた説明: KafkaHeaderMapper
      指定された MessageHeaders から指定されたターゲットヘッダーにマップします。
      パラメーター:
      headers - 抽象化された MessageHeaders。
      target - ネイティブターゲットヘッダー。

    • toHeaders

      public void toHeaders(org.apache.kafka.common.header.Headers source, MapSE<StringSE,ObjectSE> headers)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      インターフェースからコピーされた説明: KafkaHeaderMapper
      指定されたネイティブヘッダーから、最終的な MessageHeaders のヘッダーのマップにマップします。
      パラメーター:
      source - ネイティブヘッダー。
      headers - ターゲットヘッダー。

    • trusted

      protected boolean trusted(StringSE requestedType)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。