クラス KafkaProducerMessageHandlerSpec<K,V,S extends KafkaProducerMessageHandlerSpec<K,V,S>>

型パラメーター:
K - 鍵の型。
V - 値の型。
S - KafkaProducerMessageHandlerSpec 拡張型。
実装されたすべてのインターフェース:
DisposableBeanFactoryBean<KafkaProducerMessageHandler<K,V>>InitializingBeanLifecyclePhasedSmartLifecycle
既知の直属サブクラス
KafkaOutboundGatewaySpecKafkaProducerMessageHandlerSpec.KafkaProducerMessageHandlerTemplateSpec

public class KafkaProducerMessageHandlerSpec<K,V,S extends KafkaProducerMessageHandlerSpec<K,V,S>> extends MessageHandlerSpec<S,KafkaProducerMessageHandler<K,V>>
導入:
5.4
作成者:
Artem Bilan, Biju Kunjummen, Gary Russell
  • メソッドの詳細

    • topic

      public S topic(StringSE topic)
      メッセージを送信するように Kafka トピックを構成します。
      パラメーター:
      topic - Kafka トピック名。
      戻り値:
      スペック。
    • topicExpression

      public S topicExpression(StringSE topicExpression)
      評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時に Kafka トピックを決定するように SpEL 式を構成します。
      パラメーター:
      topicExpression - トピック SpEL 式。
      戻り値:
      スペック。
    • topicExpression

      public S topicExpression(Expression topicExpression)
      評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時に Kafka トピックを決定するように Expression を構成します。
      パラメーター:
      topicExpression - トピック式。
      戻り値:
      スペック。
    • topic

      public <P> S topic(FunctionSE<Message<P>,StringSE> topicFunction)
      メッセージの送信先のトピックを決定するために実行時に呼び出される FunctionSE を構成します。通常、Java 8 ラムダ式で使用されます。
       
       .<Foo>topic(m -> m.getPayload().getTopic())
       
       
      型パラメーター:
      P - 予想されるペイロード型。
      パラメーター:
      topicFunction - トピック関数。
      戻り値:
      現在の KafkaProducerMessageHandlerSpec
      関連事項:
    • messageKeyExpression

      public S messageKeyExpression(StringSE messageKeyExpression)
      SpEL 式を構成して、評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時に保存する Kafka メッセージキーを決定します。
      パラメーター:
      messageKeyExpression - メッセージキーの SpEL 式。
      戻り値:
      スペック。
    • messageKey

      public S messageKey(StringSE messageKey)
      Kafka トピックにメッセージを格納するようにメッセージキーを設定します。
      パラメーター:
      messageKey - 使用するメッセージキー。
      戻り値:
      スペック。
    • messageKeyExpression

      public S messageKeyExpression(Expression messageKeyExpression)
      評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時に保存する Kafka メッセージキーを決定するように Expression を構成します。
      パラメーター:
      messageKeyExpression - メッセージキー式。
      戻り値:
      スペック。
    • messageKey

      public <P> S messageKey(FunctionSE<Message<P>,?> messageKeyFunction)
      実行時に呼び出される FunctionSE を構成して、メッセージがトピックに保管されるメッセージキーを決定します。通常、Java 8 ラムダ式で使用されます。
       
       .<Foo>messageKey(m -> m.getPayload().getKey())
       
       
      型パラメーター:
      P - 予想されるペイロード型。
      パラメーター:
      messageKeyFunction - メッセージキー機能。
      戻り値:
      現在の KafkaProducerMessageHandlerSpec
      関連事項:
    • partitionId

      public S partitionId(IntegerSE partitionId)
      Kafka トピックの partitionId を構成します。
      パラメーター:
      partitionId - 使用する partitionId。
      戻り値:
      スペック。
    • partitionIdExpression

      public S partitionIdExpression(StringSE partitionIdExpression)
      評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時にトピック partitionId を決定するように SpEL 式を構成します。
      パラメーター:
      partitionIdExpression - 使用する partitionId 式。
      戻り値:
      スペック。
    • partitionId

      public <P> S partitionId(FunctionSE<Message<P>,IntegerSE> partitionIdFunction)
      実行時に呼び出される FunctionSE を構成して、メッセージがトピックに保管されるパーティション ID を判別します。通常、Java 8 ラムダ式で使用されます。
       
       .partitionId(m -> m.getHeaders().get("partitionId", Integer.class))
       
       
      型パラメーター:
      P - 予想されるペイロード型。
      パラメーター:
      partitionIdFunction - partitionId 関数。
      戻り値:
      スペック。
    • partitionIdExpression

      public S partitionIdExpression(Expression partitionIdExpression)
      評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時にトピック partitionId を決定するように Expression を構成します。
      パラメーター:
      partitionIdExpression - 使用する partitionId 式。
      戻り値:
      スペック。
    • timestampExpression

      public S timestampExpression(StringSE timestampExpression)
      評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時にタイムスタンプを決定するように SpEL 式を構成します。
      パラメーター:
      timestampExpression - 使用するタイムスタンプ式。
      戻り値:
      スペック。
    • timestamp

      public <P> S timestamp(FunctionSE<Message<P>,LongSE> timestampFunction)
      Kafka レコードのタイムスタンプがトピックに格納されることを決定するために実行時に呼び出される FunctionSE を構成します。通常、Java 8 ラムダ式で使用されます。
       
       .timestamp(m -> m.getHeaders().get("mytimestamp_header", Long.class))
       
       
      型パラメーター:
      P - 予想されるペイロード型。
      パラメーター:
      timestampFunction - タイムスタンプ関数。
      戻り値:
      スペック。
    • timestampExpression

      public S timestampExpression(Expression timestampExpression)
      評価コンテキストのルートオブジェクトとしてのリクエストメッセージに対して実行時にタイムスタンプを決定するように Expression を構成します。
      パラメーター:
      timestampExpression - 使用するタイムスタンプ式。
      戻り値:
      スペック。
    • flushExpression

      public S flushExpression(StringSE flushExpression)
      送信後にプロデューサーをフラッシュするかどうかを決定するように SpEL 式を構成します。デフォルトでは、ヘッダー kafka_flush の値が Boolean.TRUESE の場合、プロデューサーはフラッシュされます。
      パラメーター:
      flushExpression - 使用するタイムスタンプ式。
      戻り値:
      スペック。
    • flush

      public <P> S flush(FunctionSE<Message<P>,BooleanSE> flushFunction)
      実行時に呼び出される FunctionSE を構成して、送信後にプロデューサーをフラッシュするかどうかを決定します。デフォルトでは、ヘッダー kafka_flush の値が Boolean.TRUESE の場合、プロデューサーはフラッシュされます。通常、JavaLambda 式で使用されます。
       
       .flush(m -> m.getPayload().shouldFlush())
       
       
      型パラメーター:
      P - 予想されるペイロード型。
      パラメーター:
      flushFunction - フラッシュ機能。
      戻り値:
      スペック。
    • flushExpression

      public S flushExpression(Expression flushExpression)
      送信後にプロデューサーをフラッシュするかどうかを決定するように Expression を構成します。デフォルトでは、ヘッダー kafka_flush の値が Boolean.TRUESE の場合、プロデューサーはフラッシュされます。
      パラメーター:
      flushExpression - 使用するタイムスタンプ式。
      戻り値:
      スペック。
    • sync

      public S sync(boolean sync)
      KafkaProducerMessageHandler が送信操作の結果を待機する必要があるかどうかを示す boolean。デフォルトは false です。sync モードでは、ダウンストリーム送信操作の例外が再スローされます。
      パラメーター:
      sync - 送信モード。デフォルトでは非同期です。
      戻り値:
      スペック。
    • sendTimeout

      public S sendTimeout(long sendTimeout)
      KafkaProducerMessageHandler が操作結果の送信を待機する時間をミリ秒単位で指定します。デフォルトは 10 秒です。
      パラメーター:
      sendTimeout - 送信操作の結果を待機するためのタイムアウト。
      戻り値:
      スペック。
    • headerMapper

      public S headerMapper(org.springframework.kafka.support.KafkaHeaderMapper mapper)
      Spring メッセージングヘッダーを Kafka ヘッダーにマップするには、ヘッダーマッパーを指定します。
      パラメーター:
      mapper - マッパー。
      戻り値:
      スペック。
    • sendSuccessChannel

      public S sendSuccessChannel(MessageChannel sendSuccessChannel)
      成功した送信結果が送信されるチャネルを設定します。
      パラメーター:
      sendSuccessChannel - チャンネル。
      戻り値:
      スペック。
    • sendSuccessChannel

      public S sendSuccessChannel(StringSE sendSuccessChannel)
      成功した送信結果が送信されるチャネルを設定します。
      パラメーター:
      sendSuccessChannel - チャンネル名。
      戻り値:
      スペック。
    • sendFailureChannel

      public S sendFailureChannel(MessageChannel sendFailureChannel)
      失敗した送信結果が送信されるチャネルを設定します。
      パラメーター:
      sendFailureChannel - チャンネル。
      戻り値:
      スペック。
    • sendFailureChannel

      public S sendFailureChannel(StringSE sendFailureChannel)
      失敗した送信結果が送信されるチャネルを設定します。
      パラメーター:
      sendFailureChannel - チャンネル名。
      戻り値:
      スペック。
    • futuresChannel

      public S futuresChannel(MessageChannel futuresChannel)
      先物送信先のチャネルを設定します。
      パラメーター:
      futuresChannel - チャンネル。
      戻り値:
      スペック。
    • futuresChannel

      public S futuresChannel(StringSE futuresChannel)
      先物送信先のチャネルを設定します。
      パラメーター:
      futuresChannel - チャンネル名。
      戻り値:
      スペック。
    • producerRecordCreator

      public S producerRecordCreator(KafkaProducerMessageHandler.ProducerRecordCreator<K,V> creator)
      KafkaProducerMessageHandler.ProducerRecordCreator を設定して ProducerRecord を作成します。useTemplateConverter が true の場合は無視されます。
      パラメーター:
      creator - クリエイター。
      戻り値:
      スペック。
      導入:
      5.5.5
    • useTemplateConverter

      public S useTemplateConverter(boolean use)
      テンプレートのメッセージコンバーターを使用して producerRecordCreator の代わりに ProducerRecord を作成するには、true に設定します。
      パラメーター:
      use - コンバーターを使用する場合は true。
      戻り値:
      スペック。
      導入:
      5.5.5