org.apache.kafka.streams.state

Interface QueryableStoreType<T>

Type Parameters:

T - The store type

All Known Implementing Classes:

QueryableStoreTypes.KeyValueStoreType, QueryableStoreTypes.SessionStoreType, QueryableStoreTypes.WindowStoreType

public interface QueryableStoreType<T>

Used to enable querying of custom StateStore types via the KafkaStreams API.

See Also:

QueryableStoreTypes

Method Summary

Modifier and Type	Method and Description
boolean	accepts(StateStore stateStore) Called when searching for StateStores to see if they match the type expected by implementors of this interface.
T	create(org.apache.kafka.streams.state.internals.StateStoreProvider storeProvider, String storeName) Create an instance of T (usually a facade) that developers can use to query the underlying StateStores.

Method Detail

accepts

boolean accepts(StateStore stateStore)

Called when searching for StateStores to see if they match the type expected by implementors of this interface.

Parameters:

stateStore - The stateStore

Returns:

true if it is a match

create

T create(org.apache.kafka.streams.state.internals.StateStoreProvider storeProvider,
         String storeName)

Create an instance of T (usually a facade) that developers can use to query the underlying StateStores.

Parameters:

storeProvider - provides access to all the underlying StateStore instances

storeName - The name of the Store

Returns:

a read-only interface over a StateStore (cf. QueryableStoreTypes.KeyValueStoreType)