インターフェース MessageListenerContainer

メソッドの詳細

• setupMessageListener

  void setupMessageListener(ObjectSE messageListener)

  使用するメッセージリスナーを設定します。そのメッセージリスナ型がサポートされていない場合、IllegalArgumentExceptionSE をスローします。

  パラメーター:

  messageListener - object を MessageListener にラップします。

• metrics

  MapSE<StringSE,MapSE<org.apache.kafka.common.MetricName,? extends org.apache.kafka.common.Metric>> metrics()

  client-id によってグループ化された、このコンテナーのコンシューマーによって保持されるメトリクスを返します。

  戻り値:

  client-id によってグループ化されたコンシューマーメトリクス

  導入:

  1.3

  関連事項:

  • Consumer.metrics()

• getContainerProperties

  default ContainerProperties getContainerProperties()

  このコンテナーのコンテナープロパティを返します。

  戻り値:

  プロパティ。

  導入:

  2.1.3

• getAssignedPartitions

  @Nullable default CollectionSE<org.apache.kafka.common.TopicPartition> getAssignedPartitions()

  このコンテナーに割り当てられたトピック / パーティションを返します。

  戻り値:

  トピック / パーティション。

  導入:

  2.1.3

• getAssignmentsByClientId

  @Nullable default MapSE<StringSE,CollectionSE<org.apache.kafka.common.TopicPartition>> getAssignmentsByClientId()

  client.id によって、このコンテナーに割り当てられたトピック / パーティションを返します。

  戻り値:

  トピック / パーティション。

  導入:

  2.5

• enforceRebalance

  default void enforceRebalance()

  強制的なリバランスをトリガーするようにコンシューマーに警告します。実際の強制は、次の poll() 操作が呼び出されたときに行われます。

  導入:

  3.1.2

  関連事項:

  • KafkaConsumer.enforceRebalance()

• pause

  default void pause()

  次の poll() の前に、このコンテナーを一時停止します。これはスレッドセーフな操作であり、実際の一時停止はコンシューマースレッドによって処理されます。

  導入:

  2.1.3

  関連事項:

  • KafkaConsumer.pause(Collection)

• resume

  default void resume()

  次の poll() の後で、一時停止している場合は、このコンテナーを再開します。これはスレッドセーフな操作であり、実際の再開はコンシューマースレッドによって処理されます。

  導入:

  2.1.3

  関連事項:

  • KafkaConsumer.resume(Collection)

• pausePartition

  default void pausePartition(org.apache.kafka.common.TopicPartition topicPartition)

  次の poll() の前にこのパーティションを一時停止します。これはスレッドセーフな操作であり、実際の一時停止はコンシューマースレッドによって処理されます。

  パラメーター:

  topicPartition - 一時停止する topicPartition。

  導入:

  2.7

• resumePartition

  default void resumePartition(org.apache.kafka.common.TopicPartition topicPartition)

  次の poll() の後で、一時停止している場合は、このパーティションを再開します。これはスレッドセーフな操作であり、実際の一時停止はコンシューマースレッドによって処理されます。

  パラメーター:

  topicPartition - 再開する topicPartition。

  導入:

  2.7

• isPartitionPauseRequested

  default boolean isPartitionPauseRequested(org.apache.kafka.common.TopicPartition topicPartition)

  このトピックのパーティションの一時停止がリクエストされているかどうか。

  パラメーター:

  topicPartition - チェックするトピックパーティション

  戻り値:

  この TopicPartition の一時停止がリクエストされた場合は true

  導入:

  2.7

• isPartitionPaused

  default boolean isPartitionPaused(org.apache.kafka.common.TopicPartition topicPartition)

  このトピックのパーティションが現在一時停止されているかどうか。

  パラメーター:

  topicPartition - チェックするトピックパーティション

  戻り値:

  このパーティションが一時停止されている場合は true。

  導入:

  2.7

• isPauseRequested

  default boolean isPauseRequested()

  pause() が呼び出された場合は true を返します。コンテナーは実際にはまだ一時停止していない可能性があります。

  戻り値:

  一時停止がリクエストされた場合は true。

  導入:

  2.1.5

• isContainerPaused

  default boolean isContainerPaused()

  pause() が呼び出された場合は true を返します。そして、このコンテナー内のすべてのコンシューマーは実際に一時停止しています。

  戻り値:

  コンテナーが一時停止している場合は true。

  導入:

  2.1.5

• setAutoStartup

  default void setAutoStartup(boolean autoStartup)

  autoStartup を設定します。

  パラメーター:

  autoStartup - 設定する autoStartup。

  導入:

  2.2

  関連事項:

  • SmartLifecycle

• getGroupId

  @Nullable default StringSE getGroupId()

  コンテナーに明示的に設定されているか、コンシューマーファクトリのコンシューマープロパティを介して設定されているかにかかわらず、このコンテナーの group.id プロパティを返します。

  戻り値:

  グループ ID。

  導入:

  2.2.5

• getListenerId

  default StringSE getListenerId()

  @KafkaListener の 'id' 属性 または spring-managed コンテナーの Bean 名。

  戻り値:

  ID または Bean 名。

  導入:

  2.2.5

• getMainListenerId

  @Nullable default StringSE getMainListenerId()

  メイン @KafkaListener コンテナーの 'id' 属性 (このコンテナーが再試行トピック用の場合)。それ以外の場合は null。

  戻り値:

  ID。

  導入:

  3.0

• getListenerInfo

  @Nullable default byte[] getListenerInfo()

  すべてのレコードの KafkaHeaders.LISTENER_INFO ヘッダーに追加される任意の静的情報を取得します。

  戻り値:

  情報。

  導入:

  2.8.6

• isChildRunning

  default boolean isChildRunning()

  このコンテナーに子コンテナーがある場合、少なくとも 1 つの子が実行されていれば true を返します。子コンテナーがない場合は、Lifecycle.isRunning() を返します。

  戻り値:

  子供が走っている場合は true。

  導入:

  2.7.3

• isInExpectedState

  default boolean isInExpectedState()

  コンテナーが実行中の場合、開始されたことがない場合、停止された場合は true を返します。

  戻り値:

  状態が期待どおりの場合は true。

  導入:

  2.8

  関連事項:

  • stopAbnormally(Runnable)

• stopAbnormally

  default void stopAbnormally(RunnableSE callback)

  isInExpectedState() が false を返すように、いくつかの例外の後でコンテナーを停止します。

  パラメーター:

  callback - コールバック。

  導入:

  2.8

  関連事項:

  • isInExpectedState()

• getContainerFor

  default MessageListenerContainer getContainerFor(StringSE topic, int partition)

  このコンテナーに子コンテナーがある場合は、トピック / パーティションが割り当てられている子コンテナーを返します。子コンテナーがない場合はこれを返します。

  パラメーター:

  topic - トピック。

  partition - パーティション。

  戻り値:

  コンテナー。

• childStopped

  default void childStopped(MessageListenerContainer child, ConsumerStoppedEvent.Reason reason)

  子コンテナーが停止したことを親コンテナーに通知します。

  パラメーター:

  child - コンテナー。

  reason - 理由。

  導入:

  2.9.7

• destroy

  default void destroy()

  次で指定:

  インターフェース DisposableBean の destroy