org.springframework.kafka.config

Class StreamsBuilderFactoryBean

java.lang.Object

org.springframework.beans.factory.config.AbstractFactoryBean<org.apache.kafka.streams.StreamsBuilder>

org.springframework.kafka.config.StreamsBuilderFactoryBean

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<org.apache.kafka.streams.StreamsBuilder>, org.springframework.beans.factory.InitializingBean, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle

public class StreamsBuilderFactoryBean
extends org.springframework.beans.factory.config.AbstractFactoryBean<org.apache.kafka.streams.StreamsBuilder>
implements org.springframework.context.SmartLifecycle

An AbstractFactoryBean for the StreamsBuilder instance and lifecycle control for the internal KafkaStreams instance.

A fine grained control on KafkaStreams can be achieved by KafkaStreamsCustomizers.

Since:

1.1.4

Author:

Artem Bilan, Ivan Ursul, Soby Chacko, Zach Olauson, Nurettin Yilmaz, Denis Washington, Gary Russell

Field Summary

Fields

Modifier and Type	Field and Description
static java.time.Duration	DEFAULT_CLOSE_TIMEOUT The default Duration of 10 seconds for close timeout.

Fields inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

logger

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
StreamsBuilderFactoryBean() Default constructor that creates the factory without configuration Properties.
StreamsBuilderFactoryBean(KafkaStreamsConfiguration streamsConfig) Construct an instance with the supplied streams configuration.
StreamsBuilderFactoryBean(KafkaStreamsConfiguration streamsConfig, CleanupConfig cleanupConfig) Construct an instance with the supplied streams configuration and clean up configuration.
StreamsBuilderFactoryBean(java.util.Map<java.lang.String,java.lang.Object> streamsConfig) Deprecated. in favor of StreamsBuilderFactoryBean(KafkaStreamsConfiguration).
StreamsBuilderFactoryBean(java.util.Map<java.lang.String,java.lang.Object> streamsConfig, CleanupConfig cleanupConfig) Deprecated. in favor of StreamsBuilderFactoryBean(KafkaStreamsConfiguration, CleanupConfig).
StreamsBuilderFactoryBean(org.apache.kafka.streams.StreamsConfig streamsConfig) Deprecated. in favor of StreamsBuilderFactoryBean(KafkaStreamsConfiguration)
StreamsBuilderFactoryBean(org.apache.kafka.streams.StreamsConfig streamsConfig, CleanupConfig cleanupConfig) Deprecated. in favor of StreamsBuilderFactoryBean(KafkaStreamsConfiguration, CleanupConfig)

Method Summary

Modifier and Type	Method and Description
protected org.apache.kafka.streams.StreamsBuilder	createInstance()
org.apache.kafka.streams.KafkaStreams	getKafkaStreams() Get a managed by this StreamsBuilderFactoryBean KafkaStreams instance.
java.lang.Class<?>	getObjectType()
int	getPhase()
org.apache.kafka.streams.StreamsConfig	getStreamsConfig() Deprecated. in favor of getStreamsConfiguration().
java.util.Properties	getStreamsConfiguration()
boolean	isAutoStartup()
boolean	isRunning()
void	setAutoStartup(boolean autoStartup)
void	setClientSupplier(org.apache.kafka.streams.KafkaClientSupplier clientSupplier)
void	setCloseTimeout(int closeTimeout) Specify the timeout in seconds for the KafkaStreams.close(Duration) operation.
void	setKafkaStreamsCustomizer(KafkaStreamsCustomizer kafkaStreamsCustomizer) Specify a KafkaStreamsCustomizer to customize a KafkaStreams instance during start().
void	setPhase(int phase)
void	setStateListener(org.apache.kafka.streams.KafkaStreams.StateListener stateListener)
void	setStateRestoreListener(org.apache.kafka.streams.processor.StateRestoreListener stateRestoreListener)
void	setStreamsConfig(org.apache.kafka.streams.StreamsConfig streamsConfig) Deprecated. in favor of setStreamsConfiguration(Properties).
void	setStreamsConfiguration(java.util.Properties streamsConfig) Set StreamsConfig on this factory.
void	setUncaughtExceptionHandler(java.lang.Thread.UncaughtExceptionHandler exceptionHandler)
void	start()
void	stop()
void	stop(java.lang.Runnable callback)

Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

afterPropertiesSet, destroy, destroyInstance, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_CLOSE_TIMEOUT

public static final java.time.Duration DEFAULT_CLOSE_TIMEOUT

The default Duration of 10 seconds for close timeout.

See Also:

KafkaStreams.close(Duration)

Constructor Detail

StreamsBuilderFactoryBean

public StreamsBuilderFactoryBean()

Default constructor that creates the factory without configuration Properties. It is the factory user's responsibility to properly set Properties using setStreamsConfiguration(Properties).

Since:

2.1.3.

StreamsBuilderFactoryBean

@Deprecated
public StreamsBuilderFactoryBean(org.apache.kafka.streams.StreamsConfig streamsConfig)

Deprecated. in favor of StreamsBuilderFactoryBean(KafkaStreamsConfiguration)

Construct an instance with the supplied streams configuration.

Parameters:

streamsConfig - the streams configuration.

StreamsBuilderFactoryBean

@Deprecated
public StreamsBuilderFactoryBean(org.apache.kafka.streams.StreamsConfig streamsConfig,
                                             CleanupConfig cleanupConfig)

Deprecated. in favor of StreamsBuilderFactoryBean(KafkaStreamsConfiguration, CleanupConfig)

Construct an instance with the supplied streams configuration and clean up configuration.

Parameters:

streamsConfig - the streams configuration.

cleanupConfig - the cleanup configuration.

Since:

2.1.2.

StreamsBuilderFactoryBean

public StreamsBuilderFactoryBean(KafkaStreamsConfiguration streamsConfig,
                                 CleanupConfig cleanupConfig)

Construct an instance with the supplied streams configuration and clean up configuration.

Parameters:

streamsConfig - the streams configuration.

cleanupConfig - the cleanup configuration.

Since:

2.2

StreamsBuilderFactoryBean

@Deprecated
public StreamsBuilderFactoryBean(java.util.Map<java.lang.String,java.lang.Object> streamsConfig)

Deprecated. in favor of StreamsBuilderFactoryBean(KafkaStreamsConfiguration).

Construct an instance with the supplied streams configuration.

Parameters:

streamsConfig - the streams configuration.

StreamsBuilderFactoryBean

public StreamsBuilderFactoryBean(KafkaStreamsConfiguration streamsConfig)

Construct an instance with the supplied streams configuration.

Parameters:

streamsConfig - the streams configuration.

Since:

2.2

StreamsBuilderFactoryBean

@Deprecated
public StreamsBuilderFactoryBean(java.util.Map<java.lang.String,java.lang.Object> streamsConfig,
                                             CleanupConfig cleanupConfig)

Deprecated. in favor of StreamsBuilderFactoryBean(KafkaStreamsConfiguration, CleanupConfig).

Construct an instance with the supplied streams configuration and clean up configuration.

Parameters:

streamsConfig - the streams configuration.

cleanupConfig - the cleanup configuration.

Since:

2.1.2.

Method Detail

setStreamsConfig

@Deprecated
public void setStreamsConfig(org.apache.kafka.streams.StreamsConfig streamsConfig)

Deprecated. in favor of setStreamsConfiguration(Properties).

Set StreamsConfig on this factory.

Parameters:

streamsConfig - the streams configuration.

Since:

2.1.3

getStreamsConfig

@Deprecated
public org.apache.kafka.streams.StreamsConfig getStreamsConfig()

Deprecated. in favor of getStreamsConfiguration().

Get the streams config.

Returns:

the config.

setStreamsConfiguration

public void setStreamsConfiguration(java.util.Properties streamsConfig)

Set StreamsConfig on this factory.

Parameters:

streamsConfig - the streams configuration.

Since:

2.2

getStreamsConfiguration

@Nullable
public java.util.Properties getStreamsConfiguration()

setClientSupplier

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

setKafkaStreamsCustomizer

public void setKafkaStreamsCustomizer(KafkaStreamsCustomizer kafkaStreamsCustomizer)

Specify a KafkaStreamsCustomizer to customize a KafkaStreams instance during start().

Parameters:

kafkaStreamsCustomizer - the KafkaStreamsCustomizer to use.

Since:

2.1.5

setStateListener

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

setUncaughtExceptionHandler

public void setUncaughtExceptionHandler(java.lang.Thread.UncaughtExceptionHandler exceptionHandler)

setStateRestoreListener

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

setCloseTimeout

public void setCloseTimeout(int closeTimeout)

Specify the timeout in seconds for the KafkaStreams.close(Duration) operation. Defaults to DEFAULT_CLOSE_TIMEOUT seconds.

Parameters:

closeTimeout - the timeout for close in seconds.

See Also:

KafkaStreams.close(Duration)

getObjectType

public java.lang.Class<?> getObjectType()

Specified by:

getObjectType in interface org.springframework.beans.factory.FactoryBean<org.apache.kafka.streams.StreamsBuilder>

Specified by:

getObjectType in class org.springframework.beans.factory.config.AbstractFactoryBean<org.apache.kafka.streams.StreamsBuilder>

setAutoStartup

public void setAutoStartup(boolean autoStartup)

setPhase

public void setPhase(int phase)

getPhase

public int getPhase()

Specified by:

getPhase in interface org.springframework.context.Phased

Specified by:

getPhase in interface org.springframework.context.SmartLifecycle

getKafkaStreams

public org.apache.kafka.streams.KafkaStreams getKafkaStreams()

Get a managed by this StreamsBuilderFactoryBean KafkaStreams instance.

Returns:

KafkaStreams managed instance; may be null if this StreamsBuilderFactoryBean hasn't been started.

Since:

1.1.4

createInstance

protected org.apache.kafka.streams.StreamsBuilder createInstance()

Specified by:

createInstance in class org.springframework.beans.factory.config.AbstractFactoryBean<org.apache.kafka.streams.StreamsBuilder>

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface org.springframework.context.SmartLifecycle

stop

public void stop(java.lang.Runnable callback)

Specified by:

stop in interface org.springframework.context.SmartLifecycle

start

public void start()

Specified by:

start in interface org.springframework.context.Lifecycle

stop

public void stop()

Specified by:

stop in interface org.springframework.context.Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface org.springframework.context.Lifecycle