Package com.linkedin.venice.fastclient.meta

Class AbstractStoreMetadata

java.lang.Object

com.linkedin.venice.fastclient.meta.AbstractStoreMetadata

All Implemented Interfaces:

StoreMetadata, SchemaReader, Closeable, AutoCloseable

Direct Known Subclasses:

RequestBasedMetadata

public abstract class AbstractStoreMetadata
extends Object
implements StoreMetadata

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractClientRoutingStrategy	routingStrategy
protected final String	storeName

Constructor Summary

Constructors

Constructor	Description
AbstractStoreMetadata(ClientConfig clientConfig)

Method Summary

Modifier and Type	Method	Description
protected Runnable	buildStoreConfigChangeCallback(StoreConfigSnapshot previous, StoreConfigSnapshot current)	Return a Runnable that will notify the registered store-config-change listeners of the supplied (previous, current) transition.
protected Runnable	buildVersionSwitchCallback(int previousVersion, int newVersion)	Return a Runnable that will notify the registered version-switch listeners of the supplied (previousVersion, newVersion) transition.
void	close()
protected void	fireStoreConfigChange(StoreConfigSnapshot previous, StoreConfigSnapshot current)	Notify the registered store-config-change listeners of a transition, but only if previous and current differ — so callers may invoke this on every refresh without diffing first.
protected void	fireVersionSwitch(int previousVersion, int newVersion)	Notify the registered version-switch listeners of a transition.
int	getBatchGetLimit()
VeniceCompressor	getCompressor(CompressionStrategy compressionStrategy, int version, CompressorFactory compressorFactory, Map<Integer,ByteBuffer> versionZstdDictionaryMap)
InstanceHealthMonitor	getInstanceHealthMonitor()
int	getPartitionId(int version, byte[] key)
String	getReplica(long requestId, int groupId, int version, int partitionId, Set<String> excludedInstances)	This function is expected to return fully qualified URI, such as: "https://fake.host:8888".
String	getStoreName()
void	registerStoreConfigChangeListener(StoreConfigChangeListener listener)	Register a callback that fires when the metadata refresh loop observes a change to the store-level config snapshot (e.g.
void	registerVersionSwitchListener(StoreVersionSwitchListener listener)	Register a callback that fires when the metadata refresh loop observes a change to the store's current serving version.
<K> void	routeRequest(RequestContext requestContext, RecordSerializer<K> keySerializer)
void	setRoutingStrategy(AbstractClientRoutingStrategy routingStrategy)	For testing only.
void	setRoutingStrategy(ClientRoutingStrategyType strategyType)
ChainedCompletableFuture<Integer,Integer>	trackHealthBasedOnRequestToInstance(String instance, int version, int partitionId, CompletableFuture<TransportClientResponse> transportFuture)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linkedin.venice.schema.SchemaReader

getKeySchema, getLatestUpdateSchema, getLatestValueSchema, getLatestValueSchemaId, getLatestValueSchemaId, getUpdateSchema, getValueSchema, getValueSchemaId

Methods inherited from interface com.linkedin.venice.fastclient.meta.StoreMetadata

getClusterName, getCompressionStrategy, getCompressor, getCurrentStoreVersion, getPartitionId, getReplicas, isReady, start

Field Details

routingStrategy

protected volatile AbstractClientRoutingStrategy routingStrategy

storeName

protected final String storeName

Constructor Details

AbstractStoreMetadata

public AbstractStoreMetadata(ClientConfig clientConfig)

Method Details

setRoutingStrategy

public void setRoutingStrategy(ClientRoutingStrategyType strategyType)

setRoutingStrategy

public void setRoutingStrategy(AbstractClientRoutingStrategy routingStrategy)

For testing only.

getStoreName

public String getStoreName()

Specified by:

getStoreName in interface StoreMetadata

getPartitionId

public int getPartitionId(int version,
 byte[] key)

Specified by:

getPartitionId in interface StoreMetadata

getReplica

public String getReplica(long requestId,
 int groupId,
 int version,
 int partitionId,
 Set<String> excludedInstances)

Description copied from interface: StoreMetadata

This function is expected to return fully qualified URI, such as: "https://fake.host:8888".

Specified by:

getReplica in interface StoreMetadata

trackHealthBasedOnRequestToInstance

public ChainedCompletableFuture<Integer,Integer> trackHealthBasedOnRequestToInstance(String instance,
 int version,
 int partitionId,
 CompletableFuture<TransportClientResponse> transportFuture)

Specified by:

trackHealthBasedOnRequestToInstance in interface StoreMetadata

getInstanceHealthMonitor

public InstanceHealthMonitor getInstanceHealthMonitor()

Specified by:

getInstanceHealthMonitor in interface StoreMetadata

getBatchGetLimit

public int getBatchGetLimit()

Specified by:

getBatchGetLimit in interface StoreMetadata

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

getCompressor

public VeniceCompressor getCompressor(CompressionStrategy compressionStrategy,
 int version,
 CompressorFactory compressorFactory,
 Map<Integer,ByteBuffer> versionZstdDictionaryMap)

routeRequest

public <K> void routeRequest(RequestContext requestContext,
 RecordSerializer<K> keySerializer)

Specified by:

routeRequest in interface StoreMetadata

registerVersionSwitchListener

public void registerVersionSwitchListener(StoreVersionSwitchListener listener)

Description copied from interface: StoreMetadata

Register a callback that fires when the metadata refresh loop observes a change to the store's current serving version. The callback is invoked after the new version has been committed to the local cache. See StoreVersionSwitchListener for threading and exception semantics.

Registration timing. Listeners must be registered before StoreMetadata.start() to observe the initial transition committed by the first refresh. Listeners registered after start() returns observe only subsequent transitions.

listener must not be null. Default implementations of StoreMetadata (e.g. test fakes) treat the registration itself as a no-op but still enforce the non-null contract so behavior is consistent with the canonical AbstractStoreMetadata implementation.

Specified by:

registerVersionSwitchListener in interface StoreMetadata

buildVersionSwitchCallback

protected Runnable buildVersionSwitchCallback(int previousVersion,
 int newVersion)

Return a Runnable that will notify the registered version-switch listeners of the supplied (previousVersion, newVersion) transition.

Build the Runnable inside the synchronized region that observed the transition, and run it after the region has been exited so that listeners may safely call back into this metadata.

fireVersionSwitch

protected void fireVersionSwitch(int previousVersion,
 int newVersion)

Notify the registered version-switch listeners of a transition. Each listener is invoked in registration order; exceptions are caught and logged so that one failing listener cannot prevent others from running.

registerStoreConfigChangeListener

public void registerStoreConfigChangeListener(StoreConfigChangeListener listener)

Description copied from interface: StoreMetadata

Register a callback that fires when the metadata refresh loop observes a change to the store-level config snapshot (e.g. operator-driven ExternalStorageReadMode flip). The callback is invoked after the new snapshot has been committed to the local cache. See StoreConfigChangeListener for threading and exception semantics.

Registration timing. Same as StoreMetadata.registerVersionSwitchListener(com.linkedin.venice.client.store.listeners.StoreVersionSwitchListener) — register before StoreMetadata.start() to observe the initial snapshot; post-start registration observes only subsequent changes.

listener must not be null. Default implementations of StoreMetadata (e.g. test fakes) treat the registration itself as a no-op but still enforce the non-null contract so behavior is consistent with the canonical AbstractStoreMetadata implementation.

Specified by:

registerStoreConfigChangeListener in interface StoreMetadata

buildStoreConfigChangeCallback

protected Runnable buildStoreConfigChangeCallback(StoreConfigSnapshot previous,
 StoreConfigSnapshot current)

Return a Runnable that will notify the registered store-config-change listeners of the supplied (previous, current) transition.

fireStoreConfigChange

protected void fireStoreConfigChange(StoreConfigSnapshot previous,
 StoreConfigSnapshot current)

Notify the registered store-config-change listeners of a transition, but only if previous and current differ — so callers may invoke this on every refresh without diffing first. Each listener is invoked in registration order; exceptions are caught and logged so that one failing listener cannot prevent others from running.

Parameters:

previous - prior snapshot, or null if no prior snapshot existed

current - new snapshot; must not be null

Throws:

IllegalArgumentException - if current is null