パッケージ org.springframework.integration.kafka.dsl

クラス KafkaMessageListenerContainerSpec<K,V>

java.lang.ObjectSE
org.springframework.integration.dsl.IntegrationComponentSpec < KafkaMessageListenerContainerSpec <K, V>、org.springframework.kafka.listener.ConcurrentMessageListenerContainer<K, V>>
org.springframework.integration.kafka.dsl.KafkaMessageListenerContainerSpec<K,V>
型パラメーター:
K - 鍵の型。
V - 値の型。
実装されたすべてのインターフェース:
DisposableBean、FactoryBean<org.springframework.kafka.listener.ConcurrentMessageListenerContainer<K,V>>、InitializingBean、Lifecycle、Phased、SmartLifecycle
public class KafkaMessageListenerContainerSpec<K,V> extends IntegrationComponentSpec<KafkaMessageListenerContainerSpec<K,V>,org.springframework.kafka.listener.ConcurrentMessageListenerContainer<K,V>>
オプションを ConcurrentMessageListenerContainer に委譲するための Builder パターンスタイルのヘルパークラス。
導入:
5.4
作成者:
Artem Bilan, Gary Russell

  • メソッドの詳細

    • id

      public KafkaMessageListenerContainerSpec<K,V> id(@Nullable StringSE id)
      クラスからコピーされた説明: IntegrationComponentSpec
      コンポーネント識別子を構成します。このコンポーネントのアプリケーションコンテキストに Bean を登録するための beanName として使用されます。
      オーバーライド:
      クラス IntegrationComponentSpec<KafkaMessageListenerContainerSpec<K,V>,org.springframework.kafka.listener.ConcurrentMessageListenerContainer<K,V>> の id 
      パラメーター:
      id - ID。
      戻り値:
      スペック。

    • concurrency

      public KafkaMessageListenerContainerSpec<K,V> concurrency(int concurrency)
      AbstractMessageListenerContainer の同時実行の最大数を指定します。
      パラメーター:
      concurrency - 同時実行の最大数。
      戻り値:
      スペック。
      関連事項:
      • ConcurrentMessageListenerContainer.setConcurrency(int)

    • errorHandler

      public KafkaMessageListenerContainerSpec<K,V> errorHandler(org.springframework.kafka.listener.CommonErrorHandler errorHandler)
      AbstractMessageListenerContainer に CommonErrorHandler を指定します。
      パラメーター:
      errorHandler - CommonErrorHandler
      戻り値:
      スペック。
      導入:
      6.0
      関連事項:
      • CommonErrorHandler

    • ackMode

      public KafkaMessageListenerContainerSpec<K,V> ackMode(org.springframework.kafka.listener.ContainerProperties.AckMode ackMode)
      自動 ack（構成プロパティ内）が false の場合に使用する ack モードを設定します。
      • RECORD: 各レコードがリスナーに渡された後に確認します。
      • BATCH: コンシューマーから受信したレコードの各バッチがリスナーに渡された後の確認
      • 時間: このミリ秒数の後に確認します。（#setPollTimeout(long) pollTimeout より大きくする必要があります。
      • COUNT: 少なくともこの数のレコードが受信された後、確認してください
      • MANUAL: リスナーは acking に責任があります。AcknowledgingMessageListener を使用してください。
      パラメーター:
      ackMode - ContainerProperties.AckMode; デフォルトの BATCH。
      戻り値:
      スペック。
      関連事項:
      • ContainerProperties.AckMode

    • pollTimeout

      public KafkaMessageListenerContainerSpec<K,V> pollTimeout(long pollTimeout)
      レコードを待機しているコンシューマーでブロックする最大時間を設定します。
      パラメーター:
      pollTimeout - ミリ秒単位のタイムアウト。デフォルトは 1000 です。
      戻り値:
      スペック。
      関連事項:
      • ConsumerProperties.setPollTimeout(long)

    • ackCount

      public KafkaMessageListenerContainerSpec<K,V> ackCount(int count)
      ContainerProperties.AckMode.COUNT または ContainerProperties.AckMode.COUNT_TIME が使用されているときにオフセットがコミットされるまでの未処理のレコード数の数を設定します。
      パラメーター:
      count - カウント
      戻り値:
      スペック。
      関連事項:
      • ContainerProperties.setAckCount(int)

    • ackTime

      public KafkaMessageListenerContainerSpec<K,V> ackTime(long millis)
      ContainerProperties.AckMode.TIME または ContainerProperties.AckMode.COUNT_TIME が使用されているときに、未処理のオフセットがコミットされるまでの時間（ms）を設定します。ゼロより大きくする必要があります。
      パラメーター:
      millis - 時間
      戻り値:
      スペック。
      関連事項:
      • ContainerProperties.setAckTime(long)

    • listenerTaskExecutor

      public KafkaMessageListenerContainerSpec<K,V> listenerTaskExecutor(AsyncTaskExecutor consumerTaskExecutor)
      コンシューマーをポーリングするスレッドのエグゼキューターを設定します。
      パラメーター:
      consumerTaskExecutor - 執行者
      戻り値:
      スペック。
      関連事項:
      • ContainerProperties.setListenerTaskExecutor(AsyncTaskExecutor)

    • shutdownTimeout

      public KafkaMessageListenerContainerSpec<K,V> shutdownTimeout(long shutdownTimeout)
      コンテナーをシャットダウンするためのタイムアウトを設定します。これは、#stop(Runnable) への呼び出しが戻る前にブロックする最大時間です。
      パラメーター:
      shutdownTimeout - シャットダウンタイムアウト。
      戻り値:
      スペック。
      関連事項:
      • ContainerProperties.setShutdownTimeout(long)

    • consumerRebalanceListener

      public KafkaMessageListenerContainerSpec<K,V> consumerRebalanceListener(org.apache.kafka.clients.consumer.ConsumerRebalanceListener consumerRebalanceListener)
      ユーザー定義の ConsumerRebalanceListener 実装を設定します。
      パラメーター:
      consumerRebalanceListener - ConsumerRebalanceListener インスタンス
      戻り値:
      スペック。
      関連事項:
      • ConsumerProperties.setConsumerRebalanceListener(ConsumerRebalanceListener)

    • commitCallback

      public KafkaMessageListenerContainerSpec<K,V> commitCallback(org.apache.kafka.clients.consumer.OffsetCommitCallback commitCallback)
      コミットコールバックを設定します。デフォルトでは、単純なロギングコールバックを使用して、DEBUG レベルでの成功と ERROR レベルでの失敗をログに記録します。
      パラメーター:
      commitCallback - コールバック。
      戻り値:
      スペック。
      関連事項:
      • ConsumerProperties.setCommitCallback(OffsetCommitCallback)

    • syncCommits

      public KafkaMessageListenerContainerSpec<K,V> syncCommits(boolean syncCommits)
      コンテナーがコミットを担当するときに consumer.commitSync() または commitAsync() を呼び出すかどうかを設定します。デフォルトは true。を参照してください。このドキュメントの記載時点では、非同期コミットは完全に信頼できるわけではありません。
      パラメーター:
      syncCommits - commitSync() を使用するのは本当です。
      戻り値:
      スペック。
      関連事項:
      • ConsumerProperties.setSyncCommits(boolean)

    • idleEventInterval

      public KafkaMessageListenerContainerSpec<K,V> idleEventInterval(LongSE idleEventInterval)
      アイドルイベント間隔を設定します。設定すると、ポーリングがレコードを返さず、レコードが返されてからこの間隔が経過した場合にイベントが発行されます。
      パラメーター:
      idleEventInterval - 間隔。
      戻り値:
      スペック。
      関連事項:
      • ContainerProperties.setIdleEventInterval(Long)

    • groupId

      public KafkaMessageListenerContainerSpec<K,V> groupId(StringSE groupId)
      このコンテナーのグループ ID を設定します。コンシューマーファクトリ構成によって提供される group.id プロパティをオーバーライドします。
      パラメーター:
      groupId - グループ ID。
      戻り値:
      スペック。
      関連事項:
      • ConsumerProperties.setGroupId(String)