インターフェース ConsumerFactory<K,V>

型パラメーター:
K - 鍵の型。
V - 値の型。
すべての既知の実装クラス:
DefaultKafkaConsumerFactoryMockConsumerFactory

public interface ConsumerFactory<K,V>
Consumer インスタンスを生成する戦略。
作成者:
Gary Russell, Artem Bilan
  • ネストされたクラスの要約

    ネストされたクラス
    修飾子と型
    インターフェース
    説明
    static interface
    コンシューマーが追加または削除されるたびに呼び出されます。
  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    default void
    addListener(int index, ConsumerFactory.Listener<K,V> listener)
    特定のインデックスにリスナーを追加します。
    default void
    リスナーを追加します。
    default void
    ポストプロセッサーを追加します。
    default org.apache.kafka.clients.consumer.Consumer<K,V>
    プロパティで構成されているグループ ID とクライアント ID を使用してコンシューマーを作成します。
    default org.apache.kafka.clients.consumer.Consumer<K,V>
    createConsumer(@Nullable StringSE clientIdSuffix)
    コンシューマーを作成し、存在する場合は client.id プロパティにサフィックスを追加します。
    default org.apache.kafka.clients.consumer.Consumer<K,V>
    createConsumer(@Nullable StringSE groupId, @Nullable StringSE clientIdSuffix)
    明示的なグループ ID でコンシューマーを作成します。さらに、両方が存在する場合、クライアント ID サフィックスが client.id プロパティに追加されます。
    default org.apache.kafka.clients.consumer.Consumer<K,V>
    createConsumer(@Nullable StringSE groupId, @Nullable StringSE clientIdPrefix, @Nullable StringSE clientIdSuffix)
    明示的なグループ ID でコンシューマーを作成します。さらに、クライアント ID サフィックスが clientIdPrefix に追加され、存在する場合は client.id プロパティをオーバーライドします。
    org.apache.kafka.clients.consumer.Consumer<K,V>
    createConsumer(@Nullable StringSE groupId, @Nullable StringSE clientIdPrefix, @Nullable StringSE clientIdSuffix, @Nullable PropertiesSE properties)
    明示的なグループ ID でコンシューマーを作成します。さらに、クライアント ID サフィックスが clientIdPrefix に追加され、存在する場合は client.id プロパティをオーバーライドします。
    このファクトリの構成マップへの変更不可能な参照を返します。
    default @Nullable org.apache.kafka.common.serialization.Deserializer<K>
    構成されたキーデシリアライザーを返します (プロパティでクラス名の代わりにオブジェクトとして提供されている場合)。
    リスナーの現在のリストを取得します。
    ポストプロセッサーの現在のリストを取得します。
    default @Nullable org.apache.kafka.common.serialization.Deserializer<V>
    構成された値のデシリアライザーを返します (プロパティでクラス名の代わりにオブジェクトとして提供されている場合)。
    boolean
    このファクトリによって作成されたコンシューマーが自動コミットを使用する場合は true を返します。
    default void
    指定されたキーを構成マップから削除します。
    default boolean
    リスナーを削除します。
    default boolean
    ポストプロセッサーを取り外します。
    default void
    コンシューマー構成マップを更新します。資格情報のローテーションなどの状況で役立ちます。
  • メソッドの詳細

    • createConsumer

      default org.apache.kafka.clients.consumer.Consumer<K,V> createConsumer()
      プロパティで構成されているグループ ID とクライアント ID を使用してコンシューマーを作成します。
      戻り値:
      コンシューマー。
    • createConsumer

      default org.apache.kafka.clients.consumer.Consumer<K,V> createConsumer(@Nullable StringSE clientIdSuffix)
      コンシューマーを作成し、存在する場合は client.id プロパティにサフィックスを追加します。
      パラメーター:
      clientIdSuffix - 接尾辞。
      戻り値:
      コンシューマー。
      導入:
      1.3
    • createConsumer

      default org.apache.kafka.clients.consumer.Consumer<K,V> createConsumer(@Nullable StringSE groupId, @Nullable StringSE clientIdSuffix)
      明示的なグループ ID でコンシューマーを作成します。さらに、両方が存在する場合、クライアント ID サフィックスが client.id プロパティに追加されます。
      パラメーター:
      groupId - グループ ID。
      clientIdSuffix - 接尾辞。
      戻り値:
      コンシューマー。
      導入:
      1.3
    • createConsumer

      default org.apache.kafka.clients.consumer.Consumer<K,V> createConsumer(@Nullable StringSE groupId, @Nullable StringSE clientIdPrefix, @Nullable StringSE clientIdSuffix)
      明示的なグループ ID でコンシューマーを作成します。さらに、クライアント ID サフィックスが clientIdPrefix に追加され、存在する場合は client.id プロパティをオーバーライドします。
      パラメーター:
      groupId - グループ ID。
      clientIdPrefix - プレフィックス。
      clientIdSuffix - 接尾辞。
      戻り値:
      コンシューマー。
      導入:
      2.1.1
    • createConsumer

      org.apache.kafka.clients.consumer.Consumer<K,V> createConsumer(@Nullable StringSE groupId, @Nullable StringSE clientIdPrefix, @Nullable StringSE clientIdSuffix, @Nullable PropertiesSE properties)
      明示的なグループ ID でコンシューマーを作成します。さらに、クライアント ID サフィックスが clientIdPrefix に追加され、存在する場合は client.id プロパティをオーバーライドします。さらに、ファクトリ実装がサポートしている場合は、コンシューマープロパティをオーバーライドできます。
      パラメーター:
      groupId - グループ ID。
      clientIdPrefix - プレフィックス。
      clientIdSuffix - 接尾辞。
      properties - オーバーライドするプロパティ。
      戻り値:
      コンシューマー。
      導入:
      2.2.4
    • isAutoCommit

      boolean isAutoCommit()
      このファクトリによって作成されたコンシューマーが自動コミットを使用する場合は true を返します。
      戻り値:
      自動コミットの場合は true。
    • getConfigurationProperties

      default MapSE<StringSE,ObjectSE> getConfigurationProperties()
      このファクトリの構成マップへの変更不可能な参照を返します。類似のファクトリを作るためのクローン作成に便利です。
      戻り値:
      構成。
      導入:
      2.0
    • getKeyDeserializer

      default @Nullable org.apache.kafka.common.serialization.Deserializer<K> getKeyDeserializer()
      構成されたキーデシリアライザーを返します (プロパティでクラス名の代わりにオブジェクトとして提供されている場合)。
      戻り値:
      デシリアライザー。
      導入:
      2.0
    • getValueDeserializer

      default @Nullable org.apache.kafka.common.serialization.Deserializer<V> getValueDeserializer()
      構成された値のデシリアライザーを返します (プロパティでクラス名の代わりにオブジェクトとして提供されている場合)。
      戻り値:
      デシリアライザー。
      導入:
      2.0
    • removeListener

      default boolean removeListener(ConsumerFactory.Listener<K,V> listener)
      リスナーを削除します。
      パラメーター:
      listener - リスナー。
      戻り値:
      削除された場合は true。
      導入:
      2.5.3
    • addListener

      default void addListener(int index, ConsumerFactory.Listener<K,V> listener)
      特定のインデックスにリスナーを追加します。
      パラメーター:
      index - インデックス (リストの位置)。
      listener - リスナー。
      導入:
      2.5.3
    • addListener

      default void addListener(ConsumerFactory.Listener<K,V> listener)
      リスナーを追加します。
      パラメーター:
      listener - リスナー。
      導入:
      2.5.3
    • getListeners

      default ListSE<ConsumerFactory.Listener<K,V>> getListeners()
      リスナーの現在のリストを取得します。
      戻り値:
      リスナー。
      導入:
      2.5.3
    • addPostProcessor

      default void addPostProcessor(ConsumerPostProcessor<K,V> postProcessor)
      ポストプロセッサーを追加します。
      パラメーター:
      postProcessor - ポストプロセッサー。
      導入:
      2.5.3
    • removePostProcessor

      default boolean removePostProcessor(ConsumerPostProcessor<K,V> postProcessor)
      ポストプロセッサーを取り外します。
      パラメーター:
      postProcessor - ポストプロセッサー。
      戻り値:
      削除された場合は true。
      導入:
      2.5.3
    • getPostProcessors

      default ListSE<ConsumerPostProcessor<K,V>> getPostProcessors()
      ポストプロセッサーの現在のリストを取得します。
      戻り値:
      ポストプロセッサー。
      導入:
      2.5.3
    • updateConfigs

      default void updateConfigs(MapSE<StringSE,ObjectSE> updates)
      コンシューマー構成マップを更新します。資格情報のローテーションなどの状況で役立ちます。
      パラメーター:
      updates - 更新する構成プロパティ。
      導入:
      2.7
    • removeConfig

      default void removeConfig(StringSE configKey)
      指定されたキーを構成マップから削除します。
      パラメーター:
      configKey - 削除するキー。
      導入:
      2.7