Package io.streamthoughts.azkarra.api

Interface StreamsExecutionEnvironment<T extends StreamsExecutionEnvironment<T>>

All Superinterfaces:

HasName

All Known Implementing Classes:

LocalStreamsExecutionEnvironment

public interface StreamsExecutionEnvironment<T extends StreamsExecutionEnvironment<T>>
extends HasName

A StreamsExecutionEnvironment manages the execution and the lifecycle of one or many KafkaStreams instances that run either locally or remotely.

See Also:

KafkaStreamsContainer

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	StreamsExecutionEnvironment.View	A Environment is used to describe the current state of a StreamsExecutionEnvironment instance.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ENVIRONMENT_DEFAULT_NAME

Method Summary

Modifier and Type	Method	Description
default T	addConfiguration(Conf configuration)	Adds a new configuration to this environment.
T	addConfiguration(Supplier<Conf> configuration)	Adds a new configuration to this environment.
T	addFallbackConfiguration(Conf settings)	Adds settings to this environment that will be used in fallback if not present in the defined environment configuration.
default StreamsExecutionEnvironment.View	describe()	Gets a serializable view of this StreamsExecutionEnvironment instance.
Optional<KafkaStreamsApplication>	getApplicationById(ApplicationId id)	Gets the KafkaStreamsApplication for the specified application.id
Supplier<ApplicationIdBuilder>	getApplicationIdBuilder()	Gets the ApplicationIdBuilder.
Set<ApplicationId>	getApplicationIds()	Returns all {ApplicationId for active Kafka Streams applications.
Conf	getConfiguration()	Gets this environment configuration.
default KafkaStreamsContainer	getContainerById(ContainerId id)	Gets a KafkaStreamsContainer for the specified id.
Set<ContainerId>	getContainerIds()	Returns all ContainerId for active Kafka Streams applications.
Collection<KafkaStreamsContainer>	getContainers()	Returns all containers for active Kafka Streams applications.
boolean	isDefault()	Check whether this StreamsExecutionEnvironment is marked as default.
T	isDefault(boolean isDefault)	Sets whether this execution environment should be the default.
String	name()	Gets the name of this StreamsExecutionEnvironment.
StreamsTopologyExecution	newTopologyExecution(StreamsTopologyMeta meta, Executed executed)	Creates a new StreamsTopologyExecution to be applied on this StreamsExecutionEnvironment.
T	setApplicationIdBuilder(Supplier<ApplicationIdBuilder> supplier)	Sets the ApplicationIdBuilder that should be used for building streams application.id.
void	start()	Starts this StreamsExecutionEnvironment instance.
State	state()	Gets the state of 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 all the streams instances for the specified application id.
void	stop(ApplicationId id, boolean cleanUp, Duration timeout)	Stops all the streams instance for the specified application id.
default void	stop(ContainerId id, boolean cleanUp)	Stops the streams container for the specified application.id.
void	stop(ContainerId id, boolean cleanUp, Duration timeout)	Stops the streams container for the specified application.id.
default void	terminate(ApplicationId id)	Terminates all streams container for the specified application.id and remove the associated topology from this environment.
void	terminate(ApplicationId id, Duration timeout)	Terminates all streams container for the specified application.id and remove the associated topology from this environment.
default void	terminate(ContainerId id)	Terminates all streams container for the specified application.id and remove the associated topology from this environment.
void	terminate(ContainerId id, Duration timeout)	Terminates the KafkaStreams instance for the specified container.id and remove the associated topology from this environment.
String	type()	Gets the type of this StreamsExecutionEnvironment.

Field Detail

ENVIRONMENT_DEFAULT_NAME

static final String ENVIRONMENT_DEFAULT_NAME

See Also:

Constant Field Values

Method Detail

type

String type()

Gets the type of this StreamsExecutionEnvironment.

Returns:

the string type.

name

String name()

Gets the name of this StreamsExecutionEnvironment.

Specified by:

name in interface HasName

Returns:

the string name.

state

State state()

Gets the state of this StreamsExecutionEnvironment.

Returns:

the State.

isDefault

boolean isDefault()

Check whether this StreamsExecutionEnvironment is marked as default.

Returns:

true if this StreamsExecutionEnvironment is marked as default.

isDefault

T isDefault(boolean isDefault)

Sets whether this execution environment should be the default.

Parameters:

isDefault - true to set this environment as default.

Returns:

this StreamsExecutionEnvironment instance.

newTopologyExecution

StreamsTopologyExecution newTopologyExecution(StreamsTopologyMeta meta,
                                              Executed executed)

Creates a new StreamsTopologyExecution to be applied on this StreamsExecutionEnvironment.

Parameters:

meta - the StreamsTopologyMeta to executed.

executed - the execution options.

Returns:

the new StreamsTopologyExecution instance.

getContainers

Collection<KafkaStreamsContainer> getContainers()

Returns all containers for active Kafka Streams applications.

Returns:

a collection of KafkaStreamsContainer applications.

getContainerById

default KafkaStreamsContainer getContainerById(ContainerId id)

Gets a KafkaStreamsContainer for the specified id.

Parameters:

id - the ContainerId.

Returns:

the KafkaStreamsContainer.

getContainerIds

Set<ContainerId> getContainerIds()

Returns all ContainerId for active Kafka Streams applications.

Returns:

the set of ContainerId.

getApplicationIds

Set<ApplicationId> getApplicationIds()

Returns all {ApplicationId for active Kafka Streams applications.

Returns:

the set of ApplicationId.

getApplicationById

Optional<KafkaStreamsApplication> getApplicationById(ApplicationId id)

Gets the KafkaStreamsApplication for the specified application.id

Parameters:

id - the application.id.

Returns:

the KafkaStreamsApplication instance.

addConfiguration

default T addConfiguration(Conf configuration)

Adds a new configuration to this environment. This method can be invoked multiple time. The supplied configuration will override all prior configurations.

Returns:

this StreamsExecutionEnvironment instance.

See Also:

addConfiguration(Supplier)

addConfiguration

T addConfiguration(Supplier<Conf> configuration)

Adds a new configuration to this environment. This method can be invoked multiple time. The supplied configuration will override all prior configurations.

Returns:

this StreamsExecutionEnvironment instance.

getConfiguration

Conf getConfiguration()

Gets this environment configuration.

Returns:

the Conf instance.

setApplicationIdBuilder

T 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.

getApplicationIdBuilder

Supplier<ApplicationIdBuilder> getApplicationIdBuilder()

Gets the ApplicationIdBuilder.

Returns:

this ApplicationIdBuilder instance or null.

addFallbackConfiguration

T addFallbackConfiguration(Conf settings)

Adds settings to this environment that will be used in fallback if not present in the defined environment configuration.

Parameters:

settings - the Conf instance.

Returns:

this StreamsExecutionEnvironment instance.

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 all the streams instances 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 all 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:

.

stop

default void stop(ContainerId id,
                  boolean cleanUp)

Stops the streams container 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(ContainerId id,
          boolean cleanUp,
          Duration timeout)

Stops the streams container 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:

.

terminate

default void terminate(ContainerId id)

Terminates all streams container for the specified application.id and remove the associated topology from this environment.

A clean up of the local state directory is performed when the instance is terminated.

Parameters:

id - the ContainerId of the streams instance.

Throws:

IllegalStateException - if the environment is not started.

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

terminate

void terminate(ContainerId id,
               Duration timeout)

Terminates the KafkaStreams instance for the specified container.id and remove the associated topology from this environment.

A clean up of the local state directory is performed when the instance is terminated.

Parameters:

id - the ContainerId 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.

terminate

default void terminate(ApplicationId id)

Terminates all streams container for the specified application.id and remove the associated topology from this environment.

A clean up of the local state directory of each container is performed when an application is terminated.

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.

terminate

void terminate(ApplicationId id,
               Duration timeout)

Terminates all streams container for the specified application.id and remove the associated topology from this environment.

A clean up of the local state directory of each container is performed when an application is terminated.

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.

describe

default StreamsExecutionEnvironment.View describe()

Gets a serializable view of this StreamsExecutionEnvironment instance.

Returns:

the StreamsExecutionEnvironment.View backed by this.