Package io.streamthoughts.azkarra.api

Interface StreamsExecutionEnvironment

public interface StreamsExecutionEnvironment

A StreamsExecutionEnvironment manages the lifecycle of Topology instances.

Method Summary

Modifier and Type	Method	Description
StreamsExecutionEnvironment	addFallbackConfiguration(Conf settings)	Adds streamsConfig that will be used in fallback if not present in defined environment streamsConfig.
StreamsExecutionEnvironment	addGlobalStateListener(org.apache.kafka.streams.processor.StateRestoreListener listener)	Adds a StateRestoreListener instance that will set to all KafkaStreams instance created in this StreamsExecutionEnvironment.
StreamsExecutionEnvironment	addStateListener(org.apache.kafka.streams.KafkaStreams.StateListener listener)	Adds a KafkaStreams.StateListener instance that will set to all KafkaStreams instance created in this StreamsExecutionEnvironment.
StreamsExecutionEnvironment	addStreamsLifecycleInterceptor(Supplier<StreamsLifecycleInterceptor> interceptor)	Adds a streams interceptor hat will set to all KafkaStreams instance created in this StreamsExecutionEnvironment.
ApplicationId	addTopology(Supplier<TopologyProvider> provider)	Add a new TopologyProvider instance to this StreamsExecutionEnvironment to be started.
ApplicationId	addTopology(Supplier<TopologyProvider> provider, Executed executed)	Add a new TopologyProvider instance to this StreamsExecutionEnvironment to be started.
Collection<KafkaStreamsContainer>	applications()	Returns all KafkaStreams started applications.
Conf	getConfiguration()	Gets this environment configuration.
Supplier<StreamThreadExceptionHandler>	getStreamThreadExceptionHandler()	Gets the StreamThreadExceptionHandler.
String	name()	Gets the name of this StreamsExecutionEnvironment.
default void	remove(ApplicationId id)	Stops the streams instance for the specified application id and remove the associated topology from this environment.
void	remove(ApplicationId id, Duration timeout)	Stops the streams instance for the specified application id and remove the associated topology from this environment.
StreamsExecutionEnvironment	setApplicationIdBuilder(Supplier<ApplicationIdBuilder> supplier)	Sets the ApplicationIdBuilder that should be used for building streams application.id.
StreamsExecutionEnvironment	setConfiguration(Conf configuration)	Sets this environment configuration.
StreamsExecutionEnvironment	setKafkaStreamsFactory(Supplier<KafkaStreamsFactory> kafkaStreamsFactory)	Sets the KafkaStreamsFactory that will be used to provide the KafkaStreams to configure and start.
StreamsExecutionEnvironment	setRocksDBConfig(RocksDBConfig settings)	Sets the RocksDBConfig streamsConfig used by topology persistent stores.
StreamsExecutionEnvironment	setStreamThreadExceptionHandler(Supplier<StreamThreadExceptionHandler> handler)	Sets the StreamThreadExceptionHandler invoked when a StreamThread abruptly terminates due to an uncaught exception.
StreamsExecutionEnvironment	setWaitForTopicsToBeCreated(boolean waitForTopicToBeCreated)	Sets if the streams instances should wait for topics source to be created before starting.
void	start()	Starts this StreamsExecutionEnvironment instance.
State	state()	Gets the state f this StreamsExecutionEnvironment.
default void	stop()	Stops this StreamsExecutionEnvironment instance and all running KafkaStreams instance.
void	stop(boolean cleanUp)	Stops this StreamsExecutionEnvironment instance and all running KafkaStreams instance.
default void	stop(ApplicationId id, boolean cleanUp)	Stops the streams instance for the specified application id.
void	stop(ApplicationId id, boolean cleanUp, Duration timeout)	Stops the streams instance for the specified application id.

Method Detail

name

String name()

Gets the name of this StreamsExecutionEnvironment.

Returns:

the string name.

state

State state()

Gets the state f this StreamsExecutionEnvironment.

Returns:

the State.

addStateListener

StreamsExecutionEnvironment addStateListener(org.apache.kafka.streams.KafkaStreams.StateListener listener)

Adds a KafkaStreams.StateListener instance that will set to all KafkaStreams instance created in this StreamsExecutionEnvironment.

Parameters:

listener - the KafkaStreams.StateListener instance.

Returns:

this StreamsExecutionEnvironment instance.

Throws:

IllegalStateException - if this StreamsExecutionEnvironment instance is started.

addGlobalStateListener

StreamsExecutionEnvironment addGlobalStateListener(org.apache.kafka.streams.processor.StateRestoreListener listener)

Adds a StateRestoreListener instance that will set to all KafkaStreams instance created in this StreamsExecutionEnvironment.

Parameters:

listener - the StateRestoreListener instance.

Returns:

this StreamsExecutionEnvironment instance.

Throws:

IllegalStateException - if this StreamsExecutionEnvironment instance is started.

See Also:

.

addStreamsLifecycleInterceptor

StreamsExecutionEnvironment addStreamsLifecycleInterceptor(Supplier<StreamsLifecycleInterceptor> interceptor)

Adds a streams interceptor hat will set to all KafkaStreams instance created in this StreamsExecutionEnvironment.

Parameters:

interceptor - the {@link {@link StreamsLifecycleInterceptor}}.

Returns:

this StreamsExecutionEnvironment instance.

setStreamThreadExceptionHandler

StreamsExecutionEnvironment setStreamThreadExceptionHandler(Supplier<StreamThreadExceptionHandler> handler)

Sets the StreamThreadExceptionHandler invoked when a StreamThread abruptly terminates due to an uncaught exception.

Parameters:

handler - the StreamThreadExceptionHandler.

Returns:

this StreamsExecutionEnvironment instance.

See Also:

KafkaStreams.setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler)

getStreamThreadExceptionHandler

Supplier<StreamThreadExceptionHandler> getStreamThreadExceptionHandler()

Gets the StreamThreadExceptionHandler.

Returns:

the Supplier, otherwise null if no handler is set.

applications

Collection<KafkaStreamsContainer> applications()

Returns all KafkaStreams started applications.

Returns:

a collection of KafkaStreamsContainer applications.

setConfiguration

StreamsExecutionEnvironment setConfiguration(Conf configuration)

Sets this environment configuration.

Returns:

this StreamsExecutionEnvironment instance.

getConfiguration

Conf getConfiguration()

Gets this environment configuration.

Returns:

the Conf instance.

setRocksDBConfig

StreamsExecutionEnvironment setRocksDBConfig(RocksDBConfig settings)

Sets the RocksDBConfig streamsConfig used by topology persistent stores.

Parameters:

settings - the RocksDBConfig instance.

Returns:

this StreamsExecutionEnvironment instance.

setApplicationIdBuilder

StreamsExecutionEnvironment setApplicationIdBuilder(Supplier<ApplicationIdBuilder> supplier)

Sets the ApplicationIdBuilder that should be used for building streams application.id.

Parameters:

supplier - the ApplicationIdBuilder instance supplier.

Returns:

this StreamsExecutionEnvironment instance.

setWaitForTopicsToBeCreated

StreamsExecutionEnvironment setWaitForTopicsToBeCreated(boolean waitForTopicToBeCreated)

Sets if the streams instances should wait for topics source to be created before starting. If some source topics are missing at startup, a streams instance fails.

Parameters:

waitForTopicToBeCreated - should wait for topics to be created.

Returns:

this StreamsExecutionEnvironment instance.

addFallbackConfiguration

StreamsExecutionEnvironment addFallbackConfiguration(Conf settings)

Adds streamsConfig that will be used in fallback if not present in defined environment streamsConfig.

Parameters:

settings - the Conf instance.

Returns:

this StreamsExecutionEnvironment instance.

setKafkaStreamsFactory

StreamsExecutionEnvironment setKafkaStreamsFactory(Supplier<KafkaStreamsFactory> kafkaStreamsFactory)

Sets the KafkaStreamsFactory that will be used to provide the KafkaStreams to configure and start.

Parameters:

kafkaStreamsFactory - the KafkaStreamsFactory instance.

Returns:

this StreamsExecutionEnvironment instance.

addTopology

ApplicationId addTopology(Supplier<TopologyProvider> provider)

Add a new TopologyProvider instance to this StreamsExecutionEnvironment to be started.

Parameters:

provider - the TopologyProvider supplier.

Returns:

this ApplicationId instance if the environment is already started, otherwise null.

addTopology

ApplicationId addTopology(Supplier<TopologyProvider> provider,
                          Executed executed)

Add a new TopologyProvider instance to this StreamsExecutionEnvironment to be started.

Parameters:

provider - the TopologyProvider supplier.

executed - the Executed instance.

Returns:

this ApplicationId instance if the environment is already started, otherwise null.

start

void start()

Starts this StreamsExecutionEnvironment instance.

stop

default void stop()

Stops this StreamsExecutionEnvironment instance and all running KafkaStreams instance.

stop

void stop(boolean cleanUp)

Stops this StreamsExecutionEnvironment instance and all running KafkaStreams instance.

Parameters:

cleanUp - if local states of each KafkaStreams instance must be cleanup.

Throws:

IllegalStateException - if the environment is not started.

See Also:

.

stop

default void stop(ApplicationId id,
                  boolean cleanUp)

Stops the streams instance for the specified application id.

Parameters:

id - the ApplicationId of the streams instance.

cleanUp - if local states of each KafkaStreams instance must be cleanup.

Throws:

IllegalStateException - if the environment is not started.

IllegalArgumentException - if no streams instance exist for the given id.

See Also:

.

stop

void stop(ApplicationId id,
          boolean cleanUp,
          Duration timeout)

Stops the streams instance for the specified application id.

Parameters:

id - the ApplicationId of the streams instance.

cleanUp - if local states of each KafkaStreams instance must be cleanup.

timeout - the duration to wait for the streams to shutdown.

Throws:

IllegalStateException - if the environment is not started.

IllegalArgumentException - if no streams instance exist for the given id.

See Also:

.

remove

default void remove(ApplicationId id)

Stops the streams instance for the specified application id and remove the associated topology from this environment.

Parameters:

id - the ApplicationId of the streams instance.

Throws:

IllegalStateException - if the environment is not started.

IllegalArgumentException - if no streams instance exist for the given id.

See Also:

.

remove

void remove(ApplicationId id,
            Duration timeout)

Stops the streams instance for the specified application id and remove the associated topology from this environment.

Parameters:

id - the ApplicationId of the streams instance.

timeout - the duration to wait for the streams to shutdown.

Throws:

IllegalStateException - if the environment is not started.

IllegalArgumentException - if no streams instance exist for the given id.

See Also:

.