org.apache.samza.storage

Interface StorageEngineFactory<K,V>

public interface StorageEngineFactory<K,V>

An object provided by the storage engine implementation to create instances of the given storage engine type.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StorageEngineFactory.StoreMode Enum to describe different modes a StorageEngine can be created in.

Method Summary

Modifier and Type	Method and Description
StorageEngine	getStorageEngine(java.lang.String storeName, java.io.File storeDir, Serde<K> keySerde, Serde<V> msgSerde, MessageCollector collector, MetricsRegistry registry, SystemStreamPartition changeLogSystemStreamPartition, JobContext jobContext, ContainerContext containerContext, StorageEngineFactory.StoreMode storeMode) Create an instance of the given storage engine.

Method Detail

getStorageEngine

StorageEngine getStorageEngine(java.lang.String storeName,
                               java.io.File storeDir,
                               Serde<K> keySerde,
                               Serde<V> msgSerde,
                               MessageCollector collector,
                               MetricsRegistry registry,
                               SystemStreamPartition changeLogSystemStreamPartition,
                               JobContext jobContext,
                               ContainerContext containerContext,
                               StorageEngineFactory.StoreMode storeMode)

Create an instance of the given storage engine.

Parameters:

storeName - The name of the storage engine.

storeDir - The directory of the storage engine.

keySerde - The serializer to use for serializing keys when reading or writing to the store.

msgSerde - The serializer to use for serializing messages when reading or writing to the store.

collector - MessageCollector the storage engine uses to persist changes.

registry - MetricsRegistry to which to publish storage-engine specific metrics.

changeLogSystemStreamPartition - Samza stream partition from which to receive the changelog.

jobContext - Information about the job in which the task is executing

containerContext - Information about the container in which the task is executing.

storeMode - The mode in which the instance should be created in.

Returns:

The storage engine instance.