Package io.streamthoughts.azkarra.api.streams

Class KafkaStreamsContainer

java.lang.Object

io.streamthoughts.azkarra.api.streams.KafkaStreamsContainer

public class KafkaStreamsContainer
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KafkaStreamsContainer.StateChangeWatcher	Watch a KafkaStreams instance for KafkaStreams.State change.

Method Summary

Modifier and Type	Method	Description
void	addStateChangeWatcher(KafkaStreamsContainer.StateChangeWatcher watcher)	Register a watcher to be notified of KafkaStreams.State change event.
String	applicationId()	Gets configured StreamsConfig.APPLICATION_ID_CONFIG for this KafkaStreams instance.
String	applicationServer()	Gets configured StreamsConfig.APPLICATION_SERVER_CONFIG for this KafkaStreams instance.
void	close(boolean cleanUp, Duration timeout)	Closes this KafkaStreams instance and wait up to the timeout for the streams to be closed.
void	close(Duration timeout)	Closes this KafkaStreams instance.
Optional<Throwable>	exception()	Gets the last observed exception thrown the KafkaStreams instance.
Set<StreamsServerInfo>	getAllMetadata()
Collection<StreamsServerInfo>	getAllMetadataForStore(String storeName)
Optional<org.apache.kafka.common.serialization.Serde>	getDefaultKeySerde()	Gets the default Serde configured for key.
org.apache.kafka.streams.KafkaStreams	getKafkaStreams()	Returns the wrapper KafkaStreams instance.
<K,V> LocalStoreAccessor<org.apache.kafka.streams.state.ReadOnlyKeyValueStore<K,V>>	getLocalKeyValueStore(String storeName)
Optional<StreamsServerInfo>	getLocalServerInfo()
<K,V> LocalStoreAccessor<org.apache.kafka.streams.state.ReadOnlySessionStore<K,V>>	getLocalSessionStore(String storeName)
<K,V> LocalStoreAccessor<org.apache.kafka.streams.state.ReadOnlyKeyValueStore<K,org.apache.kafka.streams.state.ValueAndTimestamp<V>>>	getLocalTimestampedKeyValueStore(String storeName)
<K,V> LocalStoreAccessor<org.apache.kafka.streams.state.ReadOnlyWindowStore<K,org.apache.kafka.streams.state.ValueAndTimestamp<V>>>	getLocalTimestampedWindowStore(String storeName)
<K,V> LocalStoreAccessor<org.apache.kafka.streams.state.ReadOnlyWindowStore<K,V>>	getLocalWindowStore(String storeName)
<K> Optional<StreamsServerInfo>	getMetadataForStoreAndKey(String storeName, K key, org.apache.kafka.common.serialization.Serializer<K> keySerializer)
org.apache.kafka.clients.producer.Producer<byte[],byte[]>	getProducer(Map<String,Object> overrides)	Creates a new Producer instance using the same configs that the Kafka Streams instance.
boolean	isNotRunning()	Checks if the KafkaStreams is neither RUNNING nor REBALANCING.
Map<org.apache.kafka.common.MetricName,? extends org.apache.kafka.common.Metric>	metrics()	Gets all the current Metrics for this KafkaStreams instance.
ConsumerGroupOffsets	offsets()
void	restart()
void	setState(State state)
Future<org.apache.kafka.streams.KafkaStreams.State>	start(Executor executor)	Asynchronously start the underlying KafkaStreams instance.
long	startedSince()	Gets the started epoch-time in milliseconds.
TimestampedValue<State>	state()	Gets the current state of the streams.
Conf	streamsConfig()	Gets the configuration for this KafkaStreams instance.
Set<org.apache.kafka.streams.processor.ThreadMetadata>	threadMetadata()	Gets the local thread metadata.
org.apache.kafka.streams.TopologyDescription	topologyDescription()	Gets the TopologyDescription for this KafkaStreams instance.
TopologyMetadata	topologyMetadata()	Gets the TopologyMetadata about the topology runs by this KafkaStreams instance.

Methods inherited from class java.lang.Object

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

Method Detail

start

public Future<org.apache.kafka.streams.KafkaStreams.State> start(Executor executor)

Asynchronously start the underlying KafkaStreams instance.

Parameters:

executor - the Executor instance to be used for starting the streams.

Returns:

the future KafkaStreams.State of the streams.

setState

public void setState(State state)

state

public TimestampedValue<State> state()

Gets the current state of the streams.

Returns:

a TimestampedValue instance;

getDefaultKeySerde

public Optional<org.apache.kafka.common.serialization.Serde> getDefaultKeySerde()

Gets the default Serde configured for key.

Returns:

a optional Serde instance.

threadMetadata

public Set<org.apache.kafka.streams.processor.ThreadMetadata> threadMetadata()

Gets the local thread metadata.

Returns:

a set of ThreadMetadata instance.

startedSince

public long startedSince()

Gets the started epoch-time in milliseconds.

Returns:

a unix epoch-time in milliseconds.

streamsConfig

public Conf streamsConfig()

Gets the configuration for this KafkaStreams instance.

Returns:

a Conf instance.

applicationId

public String applicationId()

Gets configured StreamsConfig.APPLICATION_ID_CONFIG for this KafkaStreams instance.

Returns:

a string application.id.

applicationServer

public String applicationServer()

Gets configured StreamsConfig.APPLICATION_SERVER_CONFIG for this KafkaStreams instance.

Returns:

a string application.server.

exception

public Optional<Throwable> exception()

Gets the last observed exception thrown the KafkaStreams instance.

Returns:

a Throwable instance.

topologyMetadata

public TopologyMetadata topologyMetadata()

Gets the TopologyMetadata about the topology runs by this KafkaStreams instance.

Returns:

a TopologyMetadata instance.

topologyDescription

public org.apache.kafka.streams.TopologyDescription topologyDescription()

Gets the TopologyDescription for this KafkaStreams instance.

Returns:

a new TopologyDescription instance.

metrics

public Map<org.apache.kafka.common.MetricName,? extends org.apache.kafka.common.Metric> metrics()

Gets all the current Metrics for this KafkaStreams instance.

Returns:

a map of Metric.

offsets

public ConsumerGroupOffsets offsets()

getProducer

public org.apache.kafka.clients.producer.Producer<byte[],byte[]> getProducer(Map<String,Object> overrides)

Creates a new Producer instance using the same configs that the Kafka Streams instance.

Parameters:

overrides - the producer configs to overrides.

close

public void close(Duration timeout)

Closes this KafkaStreams instance.

close

public void close(boolean cleanUp,
                  Duration timeout)

Closes this KafkaStreams instance and wait up to the timeout for the streams to be closed. A timeout of 0 means to return immediately (i.e Duration.ZERO

Parameters:

cleanUp - flag to clean up the local streams states.

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

restart

public void restart()

getLocalServerInfo

public Optional<StreamsServerInfo> getLocalServerInfo()

getAllMetadata

public Set<StreamsServerInfo> getAllMetadata()

getAllMetadataForStore

public Collection<StreamsServerInfo> getAllMetadataForStore(String storeName)

getMetadataForStoreAndKey

public <K> Optional<StreamsServerInfo> getMetadataForStoreAndKey(String storeName,
                                                                 K key,
                                                                 org.apache.kafka.common.serialization.Serializer<K> keySerializer)

getLocalKeyValueStore

public <K,V> LocalStoreAccessor<org.apache.kafka.streams.state.ReadOnlyKeyValueStore<K,V>> getLocalKeyValueStore(String storeName)

getLocalTimestampedKeyValueStore

public <K,V> LocalStoreAccessor<org.apache.kafka.streams.state.ReadOnlyKeyValueStore<K,org.apache.kafka.streams.state.ValueAndTimestamp<V>>> getLocalTimestampedKeyValueStore(String storeName)

getLocalWindowStore

public <K,V> LocalStoreAccessor<org.apache.kafka.streams.state.ReadOnlyWindowStore<K,V>> getLocalWindowStore(String storeName)

getLocalTimestampedWindowStore

public <K,V> LocalStoreAccessor<org.apache.kafka.streams.state.ReadOnlyWindowStore<K,org.apache.kafka.streams.state.ValueAndTimestamp<V>>> getLocalTimestampedWindowStore(String storeName)

getLocalSessionStore

public <K,V> LocalStoreAccessor<org.apache.kafka.streams.state.ReadOnlySessionStore<K,V>> getLocalSessionStore(String storeName)

isNotRunning

public boolean isNotRunning()

Checks if the KafkaStreams is neither RUNNING nor REBALANCING.

addStateChangeWatcher

public void addStateChangeWatcher(KafkaStreamsContainer.StateChangeWatcher watcher)

Register a watcher to be notified of KafkaStreams.State change event.

Parameters:

watcher - the KafkaStreamsContainer.StateChangeWatcher to be registered.

getKafkaStreams

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

Returns the wrapper KafkaStreams instance.

Returns:

the KafkaStreams.