Package org.apache.kafka.streams.processor

Interface StateStoreContext

  • public interface StateStoreContext
    State store context interface.

    • Method Detail

      • applicationId

        String applicationId()
        Returns the application id.
        Returns:
        the application id

      • taskId

        TaskId taskId()
        Returns the task id.
        Returns:
        the task id

      • keySerde

        Serde<?> keySerde()
        Returns the default key serde.
        Returns:
        the key serializer

      • valueSerde

        Serde<?> valueSerde()
        Returns the default value serde.
        Returns:
        the value serializer

      • stateDir

        File stateDir()
        Returns the state directory for the partition.
        Returns:
        the state directory

      • metrics

        StreamsMetrics metrics()
        Returns Metrics instance.
        Returns:
        StreamsMetrics

      • register

        void register​(StateStore store,
              StateRestoreCallback stateRestoreCallback)
        Registers and possibly restores the specified storage engine.
        Parameters:
        store - the storage engine
        stateRestoreCallback - the restoration callback logic for log-backed state stores upon restart
        Throws:
        IllegalStateException - If store gets registered after initialized is already finished
        StreamsException - if the store's change log does not contain the partition

      • appConfigs

        Map<String,​Object> appConfigs()
        Returns all the application config properties as key/value pairs.

        The config properties are defined in the StreamsConfig object and associated to the StateStoreContext.

        The type of the values is dependent on the type of the property (e.g. the value of DEFAULT_KEY_SERDE_CLASS_CONFIG will be of type Class, even if it was specified as a String to StreamsConfig(Map)).

        Returns:
        all the key/values from the StreamsConfig properties

      • appConfigsWithPrefix

        Map<String,​Object> appConfigsWithPrefix​(String prefix)
        Returns all the application config properties with the given key prefix, as key/value pairs stripping the prefix.

        The config properties are defined in the StreamsConfig object and associated to the StateStoreContext.

        Parameters:
        prefix - the properties prefix
        Returns:
        the key/values matching the given prefix from the StreamsConfig properties.