クラス 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, Almog Gavra
ネストされたクラスの要約
ネストされたクラスフィールドのサマリー
フィールドクラス org.springframework.beans.factory.config.AbstractFactoryBean から継承されたフィールド
loggerインターフェース org.springframework.beans.factory.FactoryBean から継承されたフィールド
OBJECT_TYPE_ATTRIBUTEインターフェース org.springframework.context.SmartLifecycle から継承されたフィールド
DEFAULT_PHASEコンストラクターの概要
コンストラクターコンストラクター説明構成なしでファクトリを作成するデフォルトのコンストラクターPropertiesSE。StreamsBuilderFactoryBean(KafkaStreamsConfiguration streamsConfig) 提供されたストリーム構成でインスタンスを構築します。StreamsBuilderFactoryBean(KafkaStreamsConfiguration streamsConfig, CleanupConfig cleanupConfig) 提供されたストリーム構成でインスタンスを構築し、構成をクリーンアップします。方法の概要
修飾子と型メソッド説明voidストリームの開始と停止の後に呼び出されるStreamsBuilderFactoryBean.Listenerを追加します。voidprotected org.apache.kafka.streams.StreamsBuilder@Nullable org.apache.kafka.streams.KafkaStreamsこのStreamsBuilderFactoryBeanKafkaStreamsインスタンスによって管理されます。リスナーの現在のリストを取得します。ClassSE<?> intgetPhase()@Nullable PropertiesSE@Nullable org.apache.kafka.streams.errors.StreamsUncaughtExceptionHandlerこのファクトリ Bean に設定されている現在のStreamsUncaughtExceptionHandlerを取得します。org.apache.kafka.streams.TopologyこのStreamsBuilderFactoryBeanの関連するTopologyへのアクセスを提供します。booleanbooleanbooleanリスナーを削除します。voidsetAutoStartup(boolean autoStartup) voidsetBeanName(StringSE name) voidsetCleanupConfig(CleanupConfig cleanupConfig) voidsetClientSupplier(org.apache.kafka.streams.KafkaClientSupplier clientSupplier) voidsetCloseTimeout(int closeTimeout) KafkaStreams.close(Duration)操作のタイムアウトを秒単位で指定します。voidsetInfrastructureCustomizer(KafkaStreamsInfrastructureCustomizer infrastructureCustomizer) ストリームを作成する前に、カスタマイザーを設定してビルダーやトポロジーを構成します。voidsetKafkaStreamsCustomizer(KafkaStreamsCustomizer kafkaStreamsCustomizer) voidsetLeaveGroupOnClose(boolean leaveGroupOnClose) Kafka ストリームを停止するときにコンシューマーがグループを離れるかどうかを指定します。voidsetPhase(int phase) voidsetStateListener(org.apache.kafka.streams.KafkaStreams.StateListener stateListener) voidsetStateRestoreListener(org.apache.kafka.streams.processor.StateRestoreListener stateRestoreListener) voidsetStreamsConfiguration(PropertiesSE streamsConfig) このファクトリでストリーム構成PropertiesSE を設定します。voidsetStreamsUncaughtExceptionHandler(org.apache.kafka.streams.errors.StreamsUncaughtExceptionHandler streamsUncaughtExceptionHandler) StreamsUncaughtExceptionHandlerを設定します。voidstart()voidstop()voidstop(RunnableSE callback) クラス org.springframework.beans.factory.config.AbstractFactoryBean から継承されたメソッド
afterPropertiesSet, destroy, destroyInstance, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingletonクラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSEインターフェース org.springframework.context.SmartLifecycle から継承されたメソッド
isPauseable
フィールドの詳細
DEFAULT_CLOSE_TIMEOUT
コンストラクターの詳細
StreamsBuilderFactoryBean
public StreamsBuilderFactoryBean()構成なしでファクトリを作成するデフォルトのコンストラクターPropertiesSE。setStreamsConfiguration(Properties)を使用してPropertiesSE を適切に設定するのは、ファクトリユーザーの責任です。- 導入:
- 2.1.3.
StreamsBuilderFactoryBean
public StreamsBuilderFactoryBean(KafkaStreamsConfiguration streamsConfig, CleanupConfig cleanupConfig) 提供されたストリーム構成でインスタンスを構築し、構成をクリーンアップします。- パラメーター:
streamsConfig- ストリーム構成。cleanupConfig- クリーンアップ構成。- 導入:
- 2.2
StreamsBuilderFactoryBean
提供されたストリーム構成でインスタンスを構築します。- パラメーター:
streamsConfig- ストリーム構成。- 導入:
- 2.2
メソッドの詳細
setBeanName
- 次で指定:
- インターフェース
BeanNameAwareのsetBeanName
setStreamsConfiguration
このファクトリでストリーム構成PropertiesSE を設定します。- パラメーター:
streamsConfig- ストリーム構成。- 導入:
- 2.2
getStreamsConfiguration
setClientSupplier
public void setClientSupplier(org.apache.kafka.streams.KafkaClientSupplier clientSupplier) setInfrastructureCustomizer
public void setInfrastructureCustomizer(KafkaStreamsInfrastructureCustomizer infrastructureCustomizer) ストリームを作成する前に、カスタマイザーを設定してビルダーやトポロジーを構成します。- パラメーター:
infrastructureCustomizer- カスタマイザー- 導入:
- 2.4.1
setKafkaStreamsCustomizer
- パラメーター:
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
public @Nullable 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- 秒単位のクローズのタイムアウト。- 関連事項:
setLeaveGroupOnClose
public void setLeaveGroupOnClose(boolean leaveGroupOnClose) Kafka ストリームを停止するときにコンシューマーがグループを離れるかどうかを指定します。デフォルトは false です。- パラメーター:
leaveGroupOnClose- ストリームを停止するときにグループを離れる場合は true- 導入:
- 3.2.0
getTopology
public org.apache.kafka.streams.Topology getTopology()このStreamsBuilderFactoryBeanの関連するTopologyへのアクセスを提供します。- 戻り値:
Topologyオブジェクト- 導入:
- 2.4.4
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
getKafkaStreams
public @Nullable org.apache.kafka.streams.KafkaStreams getKafkaStreams()このStreamsBuilderFactoryBeanKafkaStreamsインスタンスによって管理されます。- 戻り値:
- KafkaStreams マネージドインスタンス。この
StreamsBuilderFactoryBeanが開始されていない場合は、NULL になる可能性があります。 - 導入:
- 1.1.4
getListeners
リスナーの現在のリストを取得します。- 戻り値:
- リスナー。
- 導入:
- 2.5.3
addListener
ストリームの開始と停止の後に呼び出されるStreamsBuilderFactoryBean.Listenerを追加します。- パラメーター:
listener- リスナー。- 導入:
- 2.5.3
removeListener
リスナーを削除します。- パラメーター:
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
- 次で指定:
- インターフェース
SmartLifecycleのstop
start
stop
isRunning
afterSingletonsInstantiated
public void afterSingletonsInstantiated()- 次で指定:
- インターフェース
SmartInitializingSingletonのafterSingletonsInstantiated