パッケージ org.springframework.kafka.listener

インターフェース ConsumerSeekAware

すべての既知の実装クラス:
AbstractConsumerSeekAware、AbstractDelegatingMessageListenerAdapter、AbstractFilteringMessageListener、AbstractRetryingMessageListenerAdapter、AggregatingReplyingKafkaTemplate、BatchMessagingMessageListenerAdapter、FilteringBatchMessageListenerAdapter、FilteringMessageListenerAdapter、KafkaBackoffAwareMessageListenerAdapter、MessagingMessageListenerAdapter、RecordMessagingMessageListenerAdapter、ReplyingKafkaTemplate
public interface ConsumerSeekAware
このインターフェースを実装するリスナーには、シーク操作の実行に使用できる ConsumerSeekAware.ConsumerSeekCallback が提供されます。
導入:
1.1
作成者:
Gary Russell, Soby Chacko

  • ネストされたクラスのサマリー

    ネストされたクラス
    修飾子と型
    インターフェース
    説明
    static interface
    ConsumerSeekAware.ConsumerSeekCallback
    特定のオフセットをシークするためにリスナーが呼び出すことができるコールバック。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    default void
    onFirstPoll()
    手動パーティション割り当てを使用する場合、最初のポーリングが完了したときに呼び出されます。auto.offset.reset=latest を使用していて、初期位置が確立されるまで待つ必要がある場合に便利です。
    default void
    onIdleContainer(MapSE<org.apache.kafka.common.TopicPartition,LongSE> assignments, ConsumerSeekAware.ConsumerSeekCallback callback)
    コンテナーがアイドルコンテナーイベントを発行するように構成されている場合、このメソッドはコンテナーアイドルイベントが発行されたときに呼び出され、シーク操作を許可します。
    default void
    onPartitionsAssigned(MapSE<org.apache.kafka.common.TopicPartition,LongSE> assignments, ConsumerSeekAware.ConsumerSeekCallback callback)
    グループ管理を使用する場合。パーティションの割り当てが変更されたときに呼び出されます。
    default void
    onPartitionsRevoked(CollectionSE<org.apache.kafka.common.TopicPartition> partitions)
    グループ管理を使用する場合。パーティションの割り当てが取り消されたときに呼び出されます。
    default void
    registerSeekCallback(ConsumerSeekAware.ConsumerSeekCallback callback)
    任意の時間にシークするときに使用するコールバックを登録します。
    default void
    unregisterSeekCallback()
    リスナーコンシューマーが終了したときに呼び出され、実装がスレッドローカルなどの状態をクリーンアップできるようにします。

  • メソッドの詳細

    • registerSeekCallback

      default void registerSeekCallback(ConsumerSeekAware.ConsumerSeekCallback callback)
      任意のタイミングでシークする際に使用するコールバックを登録します。ConcurrentMessageListenerContainer または複数のコンテナー内の同じリスナーインスタンスで使用する場合、リスナーはコールバックを ThreadLocal またはスレッドによってキー設定されたマップに保存する必要があります。
      パラメーター:
      callback - コールバック。

    • onPartitionsAssigned

      default void onPartitionsAssigned(MapSE<org.apache.kafka.common.TopicPartition,LongSE> assignments, ConsumerSeekAware.ConsumerSeekCallback callback)
      グループ管理を使用する場合。パーティションの割り当てが変更されたときに呼び出されます。
      パラメーター:
      assignments - 新しい割り当てとその現在のオフセット。
      callback - 割り当て後に最初のシークを実行するためのコールバック。

    • onPartitionsRevoked

      default void onPartitionsRevoked(CollectionSE<org.apache.kafka.common.TopicPartition> partitions)
      グループ管理を使用する場合。パーティションの割り当てが取り消されたときに呼び出されます。リスナーは、このスレッドで registerSeekCallback(ConsumerSeekCallback) から保存されたコールバックを破棄する必要があります。
      パラメーター:
      partitions - 取り消されたパーティション。
      導入:
      2.3

    • onIdleContainer

      default void onIdleContainer(MapSE<org.apache.kafka.common.TopicPartition,LongSE> assignments, ConsumerSeekAware.ConsumerSeekCallback callback)
      コンテナーがアイドルコンテナーイベントを発行するように構成されている場合、このメソッドはコンテナーアイドルイベントが発行されたときに呼び出され、シーク操作を許可します。
      パラメーター:
      assignments - 新しい割り当てとその現在のオフセット。
      callback - シークを実行するためのコールバック。

    • onFirstPoll

      default void onFirstPoll()
      手動パーティション割り当てを使用する場合、最初のポーリングが完了したときに呼び出されます。auto.offset.reset=latest を使用していて、初期位置が確立されるまで待つ必要がある場合に便利です。
      導入:
      2.8.8

    • unregisterSeekCallback

      default void unregisterSeekCallback()
      リスナーコンシューマーが終了したときに呼び出され、実装がスレッドローカルなどの状態をクリーンアップできるようにします。
      導入:
      2.4