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

クラス StreamsBuilderFactoryBean

java.lang.ObjectSE
org.springframework.beans.factory.config.AbstractFactoryBean<org.apache.kafka.streams.StreamsBuilder>
org.springframework.kafka.config.StreamsBuilderFactoryBean
実装されたすべてのインターフェース:
Aware、BeanClassLoaderAware、BeanFactoryAware、BeanNameAware、DisposableBean、FactoryBean<org.apache.kafka.streams.StreamsBuilder>、InitializingBean、SmartInitializingSingleton、Lifecycle、Phased、SmartLifecycle
public class StreamsBuilderFactoryBean extends AbstractFactoryBean<org.apache.kafka.streams.StreamsBuilder> implements SmartLifecycle, BeanNameAware, SmartInitializingSingleton
StreamsBuilder インスタンスの AbstractFactoryBean と内部 KafkaStreams インスタンスのライフサイクルコントロール。

KafkaStreams のきめ細かい制御は、KafkaStreamsCustomizer によって実現できます。

導入:
1.1.4
作成者:
Artem Bilan, Ivan Ursul, Soby Chacko, Zach Olauson, Nurettin Yilmaz, Denis Washington, Gary Russell, Julien Wittouck, Sanghyeok An, C é dric Schaller

  • フィールドの詳細

    • DEFAULT_CLOSE_TIMEOUT

      public static final DurationSE DEFAULT_CLOSE_TIMEOUT
      閉じるタイムアウトの 10 seconds のデフォルト DurationSE。
      関連事項:
      • KafkaStreams.close(Duration)

  • コンストラクターの詳細

    • StreamsBuilderFactoryBean

      public StreamsBuilderFactoryBean()
      構成なしでファクトリを作成するデフォルトのコンストラクター PropertiesSE。setStreamsConfiguration(Properties) を使用して PropertiesSE を適切に設定するのは、ファクトリユーザーの責任です。
      導入:
      2.1.3.

    • StreamsBuilderFactoryBean

      public StreamsBuilderFactoryBean(KafkaStreamsConfiguration streamsConfig, CleanupConfig cleanupConfig)
      提供されたストリーム構成でインスタンスを構築し、構成をクリーンアップします。
      パラメーター:
      streamsConfig - ストリーム構成。
      cleanupConfig - クリーンアップ構成。
      導入:
      2.2

    • StreamsBuilderFactoryBean

      public StreamsBuilderFactoryBean(KafkaStreamsConfiguration streamsConfig)
      提供されたストリーム構成でインスタンスを構築します。
      パラメーター:
      streamsConfig - ストリーム構成。
      導入:
      2.2

  • メソッドの詳細

    • setBeanName

      public void setBeanName(StringSE name)
      次で指定:
      インターフェース BeanNameAware の setBeanName 

    • setStreamsConfiguration

      public void setStreamsConfiguration(PropertiesSE streamsConfig)
      このファクトリでストリーム構成 PropertiesSE を設定します。
      パラメーター:
      streamsConfig - ストリーム構成。
      導入:
      2.2

    • getStreamsConfiguration

      @Nullable public PropertiesSE getStreamsConfiguration()

    • setClientSupplier

      public void setClientSupplier(org.apache.kafka.streams.KafkaClientSupplier clientSupplier)

    • setInfrastructureCustomizer

      public void setInfrastructureCustomizer(KafkaStreamsInfrastructureCustomizer infrastructureCustomizer)
      ストリームを作成する前に、カスタマイザーを設定してビルダーやトポロジーを構成します。
      パラメーター:
      infrastructureCustomizer - カスタマイザー
      導入:
      2.4.1

    • setKafkaStreamsCustomizer

      public void setKafkaStreamsCustomizer(KafkaStreamsCustomizer kafkaStreamsCustomizer)
      KafkaStreamsCustomizer を指定して、start() 中に KafkaStreams インスタンスをカスタマイズします。
      パラメーター:
      kafkaStreamsCustomizer - 使用する KafkaStreamsCustomizer。
      導入:
      2.1.5

    • setStateListener

      public void setStateListener(org.apache.kafka.streams.KafkaStreams.StateListener stateListener)

    • setStreamsUncaughtExceptionHandler

      public void setStreamsUncaughtExceptionHandler(org.apache.kafka.streams.errors.StreamsUncaughtExceptionHandler streamsUncaughtExceptionHandler)
      StreamsUncaughtExceptionHandler を設定します。
      パラメーター:
      streamsUncaughtExceptionHandler - ハンドラー。
      導入:
      2.8

    • getStreamsUncaughtExceptionHandler

      @Nullable public org.apache.kafka.streams.errors.StreamsUncaughtExceptionHandler getStreamsUncaughtExceptionHandler()
      このファクトリ Bean に設定されている現在の StreamsUncaughtExceptionHandler を取得します。
      戻り値:
      StreamsUncaughtExceptionHandler
      導入:
      2.8.4

    • setStateRestoreListener

      public void setStateRestoreListener(org.apache.kafka.streams.processor.StateRestoreListener stateRestoreListener)

    • setCloseTimeout

      public void setCloseTimeout(int closeTimeout)
      KafkaStreams.close(Duration) 操作のタイムアウトを秒単位で指定します。デフォルトは DEFAULT_CLOSE_TIMEOUT 秒です。
      パラメーター:
      closeTimeout - 秒単位のクローズのタイムアウト。
      関連事項:
      • KafkaStreams.close(Duration)

    • setLeaveGroupOnClose

      public void setLeaveGroupOnClose(boolean leaveGroupOnClose)
      Kafka ストリームを停止するときにコンシューマーがグループを離れるかどうかを指定します。デフォルトは false です。
      パラメーター:
      leaveGroupOnClose - ストリームを停止するときにグループを離れる場合は true
      導入:
      3.2.0

    • getTopology

      @Nullable public org.apache.kafka.streams.Topology getTopology()
      この StreamsBuilderFactoryBean の関連する Topology へのアクセスを提供します。
      戻り値:
      Topology オブジェクト
      導入:
      2.4.4

    • getObjectType

      public ClassSE<?> getObjectType()
      次で指定:
      インターフェース FactoryBean<org.apache.kafka.streams.StreamsBuilder> の getObjectType 
      次で指定:
      クラス AbstractFactoryBean<org.apache.kafka.streams.StreamsBuilder> の getObjectType 

    • setAutoStartup

      public void setAutoStartup(boolean autoStartup)

    • setPhase

      public void setPhase(int phase)

    • getPhase

      public int getPhase()
      次で指定:
      インターフェース Phased の getPhase 
      次で指定:
      インターフェース SmartLifecycle の getPhase 

    • setCleanupConfig

      public void setCleanupConfig(CleanupConfig cleanupConfig)

    • getKafkaStreams

      @Nullable public org.apache.kafka.streams.KafkaStreams getKafkaStreams()
      この StreamsBuilderFactoryBean KafkaStreams インスタンスによって管理されます。
      戻り値:
      KafkaStreams マネージドインスタンス。この StreamsBuilderFactoryBean が開始されていない場合は、NULL になる可能性があります。
      導入:
      1.1.4

    • getListeners

      public ListSE<StreamsBuilderFactoryBean.Listener> getListeners()
      リスナーの現在のリストを取得します。
      戻り値:
      リスナー。
      導入:
      2.5.3

    • addListener

      public void addListener(StreamsBuilderFactoryBean.Listener listener)
      ストリームの開始と停止の後に呼び出される StreamsBuilderFactoryBean.Listener を追加します。
      パラメーター:
      listener - リスナー。
      導入:
      2.5.3

    • removeListener

      public boolean removeListener(StreamsBuilderFactoryBean.Listener listener)
      リスナーを削除します。
      パラメーター:
      listener - リスナー。
      戻り値:
      削除された場合は true。
      導入:
      2.5.3

    • createInstance

      protected org.apache.kafka.streams.StreamsBuilder createInstance()
      次で指定:
      クラス AbstractFactoryBean<org.apache.kafka.streams.StreamsBuilder> の createInstance 

    • isAutoStartup

      public boolean isAutoStartup()
      次で指定:
      インターフェース SmartLifecycle の isAutoStartup 

    • stop

      public void stop(RunnableSE callback)
      次で指定:
      インターフェース SmartLifecycle の stop 

    • start

      public void start()
      次で指定:
      インターフェース Lifecycle の start 

    • stop

      public void stop()
      次で指定:
      インターフェース Lifecycle の stop 

    • isRunning

      public boolean isRunning()
      次で指定:
      インターフェース Lifecycle の isRunning 

    • afterSingletonsInstantiated

      public void afterSingletonsInstantiated()
      次で指定:
      インターフェース SmartInitializingSingleton の afterSingletonsInstantiated